Class: Google::Apis::PubsubV1::Policy

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

Overview

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. JSON Example "bindings": [ "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] , "role": "roles/viewer", "members": ["user:sean@example.com"] ] YAML Example bindings:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Policy

Returns a new instance of Policy



531
532
533
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 531

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

Instance Attribute Details

#bindings ⇒ Array<Google::Apis::PubsubV1::Binding>

Associates a list of members to a role. bindings with no members will result in an error. Corresponds to the JSON property bindings

Returns:



505
506
507
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 505

def bindings
  @bindings
end

#etag ⇒ String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


519
520
521
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 519

def etag
  @etag
end

#version ⇒ Fixnum

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


529
530
531
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 529

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



536
537
538
539
540
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 536

def update!(**args)
  @bindings = args[:bindings] if args.key?(:bindings)
  @etag = args[:etag] if args.key?(:etag)
  @version = args[:version] if args.key?(:version)
end