Class: Google::Apis::CloudresourcemanagerV1::OrgPolicy

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudresourcemanager_v1/classes.rb,
generated/google/apis/cloudresourcemanager_v1/representations.rb,
generated/google/apis/cloudresourcemanager_v1/representations.rb

Overview

Defines a Cloud Organization Policy which is used to specify Constraints for configurations of Cloud Platform resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ OrgPolicy

Returns a new instance of OrgPolicy



1114
1115
1116
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1114

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

Instance Attribute Details

#boolean_policy ⇒ Google::Apis::CloudresourcemanagerV1::BooleanPolicy

Used in policy_type to specify how boolean_policy will behave at this resource. Corresponds to the JSON property booleanPolicy

Returns:



1105
1106
1107
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1105

def boolean_policy
  @boolean_policy
end

#constraint ⇒ String

The name of the Constraint the Policy is configuring, for example, constraints/serviceuser.services. Immutable after creation. Corresponds to the JSON property constraint

Returns:

  • (String) 


1112
1113
1114
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1112

def constraint
  @constraint
end

#etag ⇒ String

An opaque tag indicating the current version of the Policy, used for concurrency control. When the Policy is returned from either a GetPolicy or a ListOrgPolicy request, this etag indicates the version of the current Policy to use when executing a read-modify-write loop. When the Policy is returned from a GetEffectivePolicy request, the etag will be unset. When the Policy is used in a SetOrgPolicy method, use the etag value that was returned from a GetOrgPolicy request as part of a read-modify-write loop for concurrency control. Not setting the etagin a SetOrgPolicy request will result in an unconditional write of the Policy. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1099
1100
1101
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1099

def etag
  @etag
end

#list_policy ⇒ Google::Apis::CloudresourcemanagerV1::ListPolicy

Used in policy_type to specify how list_policy behaves at this resource. A ListPolicy can define specific values that are allowed or denied by setting either the allowed_values or denied_values fields. It can also be used to allow or deny all values, by setting the all_values field. If all_values is ALL_VALUES_UNSPECIFIED, exactly one of allowed_values or denied_values must be set (attempting to set both or neither will result in a failed request). If all_values is set to either ALLOW or DENY, allowed_values and denied_values must be unset. Corresponds to the JSON property listPolicy

Returns:



1082
1083
1084
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1082

def list_policy
  @list_policy
end

#restore_default ⇒ Google::Apis::CloudresourcemanagerV1::RestoreDefault

Ignores policies set above this resource and restores the constraint_default enforcement behavior of the specific Constraint at this resource. Suppose that constraint_default is set to ALLOW for the Constraint constraints/serviceuser.services. Suppose that organization foo.com sets a Policy at their Organization resource node that restricts the allowed service activations to deny all service activations. They could then set a Policy with the policy_type restore_default on several experimental projects, restoring the constraint_default enforcement of the Constraint for only those projects, allowing those projects to have all services activated. Corresponds to the JSON property restoreDefault

Returns:



1069
1070
1071
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1069

def restore_default
  @restore_default
end

#update_time ⇒ String

The time stamp the Policy was previously updated. This is set by the server, not specified by the caller, and represents the last time a call to SetOrgPolicy was made for that Policy. Any value set by the client will be ignored. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1049
1050
1051
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1049

def update_time
  @update_time
end

#version ⇒ Fixnum

Version of the Policy. Default version is 0; Corresponds to the JSON property version

Returns:

  • (Fixnum) 


1054
1055
1056
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1054

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'generated/google/apis/cloudresourcemanager_v1/classes.rb', line 1119

def update!(**args)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version = args[:version] if args.key?(:version)
  @restore_default = args[:restore_default] if args.key?(:restore_default)
  @list_policy = args[:list_policy] if args.key?(:list_policy)
  @etag = args[:etag] if args.key?(:etag)
  @boolean_policy = args[:boolean_policy] if args.key?(:boolean_policy)
  @constraint = args[:constraint] if args.key?(:constraint)
end