Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchema

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

Resource representing a policy schema.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleChromePolicyVersionsV1PolicySchema

Returns a new instance of GoogleChromePolicyVersionsV1PolicySchema.



801
802
803
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 801

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

Instance Attribute Details

#access_restrictions ⇒ Array<String>

Output only. Specific access restrictions related to this policy. Corresponds to the JSON property accessRestrictions

Returns:

  • (Array<String>) 


736
737
738
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 736

def access_restrictions
  @access_restrictions
end

#additional_target_key_names ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1AdditionalTargetKeyName>

Output only. Additional key names that will be used to identify the target of the policy value. When specifying a policyTargetKey, each of the additional keys specified here will have to be included in the additionalTargetKeys map. Corresponds to the JSON property additionalTargetKeyNames

Returns:



743
744
745
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 743

def additional_target_key_names
  @additional_target_key_names
end

#category_title ⇒ String

Title of the category in which a setting belongs. Corresponds to the JSON property categoryTitle

Returns:

  • (String) 


748
749
750
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 748

def category_title
  @category_title
end

#definition ⇒ Google::Apis::ChromepolicyV1::Proto2FileDescriptorProto

Describes a complete .proto file. Corresponds to the JSON property definition

Returns:



753
754
755
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 753

def definition
  @definition
end

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

Output only. Detailed description of each field that is part of the schema. Fields are suggested to be displayed by the ordering in this list, not by field number. Corresponds to the JSON property fieldDescriptions

Returns:



760
761
762
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 760

def field_descriptions
  @field_descriptions
end

#name ⇒ String

Format: name=customers/customer/policySchemas/schema_namespace Corresponds to the JSON property name

Returns:

  • (String) 


765
766
767
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 765

def name
  @name
end

#notices ⇒ Array<Google::Apis::ChromepolicyV1::GoogleChromePolicyVersionsV1PolicySchemaNoticeDescription>

Output only. Special notice messages related to setting certain values in certain fields in the schema. Corresponds to the JSON property notices

Returns:



771
772
773
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 771

def notices
  @notices
end

#policy_api_lifecycle ⇒ Google::Apis::ChromepolicyV1::ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle

Output only. Current lifecycle information. Corresponds to the JSON property policyApiLifecycle

Returns:



776
777
778
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 776

def policy_api_lifecycle
  @policy_api_lifecycle
end

#policy_description ⇒ String

Output only. Description about the policy schema for user consumption. Corresponds to the JSON property policyDescription

Returns:

  • (String) 


781
782
783
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 781

def policy_description
  @policy_description
end

#schema_name ⇒ String

Output only. The fully qualified name of the policy schema. This value is used to fill the field policy_schema in PolicyValue when calling BatchInheritOrgUnitPolicies BatchModifyOrgUnitPolicies BatchModifyGroupPolicies or BatchDeleteGroupPolicies. Corresponds to the JSON property schemaName

Returns:

  • (String) 


789
790
791
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 789

def schema_name
  @schema_name
end

#support_uri ⇒ String

Output only. URI to related support article for this schema. Corresponds to the JSON property supportUri

Returns:

  • (String) 


794
795
796
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 794

def support_uri
  @support_uri
end

#valid_target_resources ⇒ Array<String>

Output only. Information about applicable target resources for the policy. Corresponds to the JSON property validTargetResources

Returns:

  • (Array<String>) 


799
800
801
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 799

def valid_target_resources
  @valid_target_resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 806

def update!(**args)
  @access_restrictions = args[:access_restrictions] if args.key?(:access_restrictions)
  @additional_target_key_names = args[:additional_target_key_names] if args.key?(:additional_target_key_names)
  @category_title = args[:category_title] if args.key?(:category_title)
  @definition = args[:definition] if args.key?(:definition)
  @field_descriptions = args[:field_descriptions] if args.key?(:field_descriptions)
  @name = args[:name] if args.key?(:name)
  @notices = args[:notices] if args.key?(:notices)
  @policy_api_lifecycle = args[:policy_api_lifecycle] if args.key?(:policy_api_lifecycle)
  @policy_description = args[:policy_description] if args.key?(:policy_description)
  @schema_name = args[:schema_name] if args.key?(:schema_name)
  @support_uri = args[:support_uri] if args.key?(:support_uri)
  @valid_target_resources = args[:valid_target_resources] if args.key?(:valid_target_resources)
end