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.



570
571
572
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 570

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

Instance Attribute Details

#description ⇒ String

Deprecated. Use name and field_description instead. The description for the field. Corresponds to the JSON property description

Returns:

  • (String) 


523
524
525
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 523

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) 


528
529
530
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 528

def field
  @field
end

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

Output only. Provides a list of fields and values. At least one of the fields must have the corresponding value in order for this field to be allowed to be set. Corresponds to the JSON property fieldDependencies

Returns:



535
536
537
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 535

def field_dependencies
  @field_dependencies
end

#field_description ⇒ String

Output only. The description of the field. Corresponds to the JSON property fieldDescription

Returns:

  • (String) 


540
541
542
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 540

def field_description
  @field_description
end

#input_constraint ⇒ String

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

Returns:

  • (String) 


545
546
547
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 545

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:



551
552
553
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 551

def known_value_descriptions
  @known_value_descriptions
end

#name ⇒ String

Output only. The name of the field. Corresponds to the JSON property name

Returns:

  • (String) 


556
557
558
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 556

def name
  @name
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:



562
563
564
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 562

def nested_field_descriptions
  @nested_field_descriptions
end

#required_items ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchemaRequiredItems>

Output only. Provides a list of fields that are required to be set if this field has a certain value. Corresponds to the JSON property requiredItems

Returns:



568
569
570
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 568

def required_items
  @required_items
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 575

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)
  @field_description = args[:field_description] if args.key?(:field_description)
  @input_constraint = args[:input_constraint] if args.key?(:input_constraint)
  @known_value_descriptions = args[:known_value_descriptions] if args.key?(:known_value_descriptions)
  @name = args[:name] if args.key?(:name)
  @nested_field_descriptions = args[:nested_field_descriptions] if args.key?(:nested_field_descriptions)
  @required_items = args[:required_items] if args.key?(:required_items)
end