Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaFieldDescription

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 detailed information for a particular field that is part of a PolicySchema.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleChromePolicyV1PolicySchemaFieldDescription

Returns a new instance of GoogleChromePolicyV1PolicySchemaFieldDescription.



331
332
333
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 331

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

Instance Attribute Details

#description ⇒ String

Output only. The description for the field. Corresponds to the JSON property description

Returns:

  • (String) 


301
302
303
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 301

def description
  @description
end

#field ⇒ String

Output only. The name of the field for associated with this description. Corresponds to the JSON property field

Returns:

  • (String) 


306
307
308
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 306

def field
  @field
end

#field_dependencies ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaFieldDependencies>

Output only. Provides a list of fields and the values they must have for this field to be allowed to be set. Corresponds to the JSON property fieldDependencies

Returns:



312
313
314
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 312

def field_dependencies
  @field_dependencies
end

#input_constraint ⇒ String

Output only. Any input constraints associated on the values for the field. Corresponds to the JSON property inputConstraint

Returns:

  • (String) 


317
318
319
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 317

def input_constraint
  @input_constraint
end

#known_value_descriptions ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaFieldKnownValueDescription>

Output only. If the field has a set of known values, this field will provide a description for these values. Corresponds to the JSON property knownValueDescriptions

Returns:



323
324
325
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 323

def known_value_descriptions
  @known_value_descriptions
end

#nested_field_descriptions ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaFieldDescription>

Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. Corresponds to the JSON property nestedFieldDescriptions

Returns:



329
330
331
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 329

def nested_field_descriptions
  @nested_field_descriptions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



336
337
338
339
340
341
342
343
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 336

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @field = args[:field] if args.key?(:field)
  @field_dependencies = args[:field_dependencies] if args.key?(:field_dependencies)
  @input_constraint = args[:input_constraint] if args.key?(:input_constraint)
  @known_value_descriptions = args[:known_value_descriptions] if args.key?(:known_value_descriptions)
  @nested_field_descriptions = args[:nested_field_descriptions] if args.key?(:nested_field_descriptions)
end