Class: Google::Apis::ChromepolicyV1::GoogleChromePolicyV1PolicySchema

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. Next ID: 14

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleChromePolicyV1PolicySchema

Returns a new instance of GoogleChromePolicyV1PolicySchema.



466
467
468
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 466

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


398
399
400
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 398

def access_restrictions
  @access_restrictions
end

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

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:



405
406
407
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 405

def additional_target_key_names
  @additional_target_key_names
end

#category_title ⇒ String

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

Returns:

  • (String) 


410
411
412
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 410

def category_title
  @category_title
end

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

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

Returns:



415
416
417
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 415

def definition
  @definition
end

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

Output only. Detailed description of each field that is part of the schema. Corresponds to the JSON property fieldDescriptions

Returns:



420
421
422
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 420

def field_descriptions
  @field_descriptions
end

#name ⇒ String

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

Returns:

  • (String) 


425
426
427
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 425

def name
  @name
end

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

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

Returns:



431
432
433
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 431

def notices
  @notices
end

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

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

Returns:



436
437
438
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 436

def policy_api_lifecycle
  @policy_api_lifecycle
end

#policy_api_lifeycle ⇒ Google::Apis::ChromepolicyV1::ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle

Deprecated field because of typo. Corresponds to the JSON property policyApiLifeycle

Returns:



441
442
443
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 441

def policy_api_lifeycle
  @policy_api_lifeycle
end

#policy_description ⇒ String

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

Returns:

  • (String) 


446
447
448
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 446

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) 


454
455
456
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 454

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) 


459
460
461
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 459

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


464
465
466
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 464

def valid_target_resources
  @valid_target_resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/google/apis/chromepolicy_v1/classes.rb', line 471

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_api_lifeycle = args[:policy_api_lifeycle] if args.key?(:policy_api_lifeycle)
  @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