Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaNoticeDescription

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chromepolicy_v1/classes.rb,
lib/google/apis/chromepolicy_v1/representations.rb,
lib/google/apis/chromepolicy_v1/representations.rb

Overview

Provides special notice messages related to a particular value in a field that is part of a PolicySchema.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleChromePolicyV1PolicySchemaNoticeDescription

Returns a new instance of GoogleChromePolicyV1PolicySchemaNoticeDescription.



446
447
448
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 446

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acknowledgement_required ⇒ Boolean Also known as: acknowledgement_required?

Output only. Whether the user needs to acknowledge the notice message before the value can be set. Corresponds to the JSON property acknowledgementRequired

Returns:

  • (Boolean) 


426
427
428
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 426

def acknowledgement_required
  @acknowledgement_required
end

#field ⇒ String

Output only. The field name associated with the notice. Corresponds to the JSON property field

Returns:

  • (String) 


432
433
434
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 432

def field
  @field
end

#notice_message ⇒ String

Output only. The notice message associate with the value of the field. Corresponds to the JSON property noticeMessage

Returns:

  • (String) 


437
438
439
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 437

def notice_message
  @notice_message
end

#notice_value ⇒ String

Output only. The value of the field that has a notice. When setting the field to this value, the user may be required to acknowledge the notice message in order for the value to be set. Corresponds to the JSON property noticeValue

Returns:

  • (String) 


444
445
446
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 444

def notice_value
  @notice_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



451
452
453
454
455
456
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 451

def update!(**args)
  @acknowledgement_required = args[:acknowledgement_required] if args.key?(:acknowledgement_required)
  @field = args[:field] if args.key?(:field)
  @notice_message = args[:notice_message] if args.key?(:notice_message)
  @notice_value = args[:notice_value] if args.key?(:notice_value)
end