Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchemaFieldDescription

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

Returns a new instance of GoogleChromePolicyVersionsV1PolicySchemaFieldDescription.



936
937
938
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 936

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

Instance Attribute Details

#default_value ⇒ Object

Output only. Client default if the policy is unset. Corresponds to the JSON property defaultValue

Returns:

  • (Object) 


877
878
879
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 877

def default_value
  @default_value
end

#description ⇒ String

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

Returns:

  • (String) 


883
884
885
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 883

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) 


888
889
890
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 888

def field
  @field
end

#field_constraints ⇒ Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1FieldConstraints

Information about any range constraints. Corresponds to the JSON property fieldConstraints

Returns:



893
894
895
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 893

def field_constraints
  @field_constraints
end

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

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:



900
901
902
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 900

def field_dependencies
  @field_dependencies
end

#field_description ⇒ String

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

Returns:

  • (String) 


905
906
907
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 905

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) 


910
911
912
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 910

def input_constraint
  @input_constraint
end

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

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:



916
917
918
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 916

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) 


921
922
923
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 921

def name
  @name
end

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

Output only. Provides the description of the fields nested in this field, if the field is a message type that defines multiple fields. Fields are suggested to be displayed by the ordering in this list, not by field number. Corresponds to the JSON property nestedFieldDescriptions

Returns:



928
929
930
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 928

def nested_field_descriptions
  @nested_field_descriptions
end

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

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:



934
935
936
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 934

def required_items
  @required_items
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 941

def update!(**args)
  @default_value = args[:default_value] if args.key?(:default_value)
  @description = args[:description] if args.key?(:description)
  @field = args[:field] if args.key?(:field)
  @field_constraints = args[:field_constraints] if args.key?(:field_constraints)
  @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