Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchemaNoticeDescription

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) ⇒ GoogleChromePolicyVersionsV1PolicySchemaNoticeDescription

Returns a new instance of GoogleChromePolicyVersionsV1PolicySchemaNoticeDescription.



1110
1111
1112
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1110

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) 


1090
1091
1092
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1090

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) 


1096
1097
1098
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1096

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) 


1101
1102
1103
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1101

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) 


1108
1109
1110
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1108

def notice_value
  @notice_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1115
1116
1117
1118
1119
1120
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 1115

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