Class: Google::Apis::CloudiotV1beta1::Policy
- Inherits:
-
Object
- Object
- Google::Apis::CloudiotV1beta1::Policy
- Defined in:
- generated/google/apis/cloudiot_v1beta1/classes.rb,
generated/google/apis/cloudiot_v1beta1/representations.rb,
generated/google/apis/cloudiot_v1beta1/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.
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"]
]
For a description of IAM and its features, see the
IAM developer's guide.
Instance Attribute Summary collapse
-
#audit_configs ⇒ Array<Google::Apis::CloudiotV1beta1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
-
#bindings ⇒ Array<Google::Apis::CloudiotV1beta1::Binding>
Associates a list of
members
to arole
. -
#etag ⇒ String
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. -
#iam_owned ⇒ Boolean
(also: #iam_owned?)
Corresponds to the JSON property
iamOwned
. -
#version ⇒ Fixnum
Version of the
Policy
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Policy
constructor
A new instance of Policy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Policy
Returns a new instance of Policy
856 857 858 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 856 def initialize(**args) update!(**args) end |
Instance Attribute Details
#audit_configs ⇒ Array<Google::Apis::CloudiotV1beta1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
Corresponds to the JSON property auditConfigs
823 824 825 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 823 def audit_configs @audit_configs end |
#bindings ⇒ Array<Google::Apis::CloudiotV1beta1::Binding>
Associates a list of members
to a role
.
bindings
with no members will result in an error.
Corresponds to the JSON property bindings
829 830 831 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 829 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 blindly.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
843 844 845 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 843 def etag @etag end |
#iam_owned ⇒ Boolean Also known as: iam_owned?
Corresponds to the JSON property iamOwned
848 849 850 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 848 def iam_owned @iam_owned end |
#version ⇒ Fixnum
Version of the Policy
. The default version is 0.
Corresponds to the JSON property version
854 855 856 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 854 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
861 862 863 864 865 866 867 |
# File 'generated/google/apis/cloudiot_v1beta1/classes.rb', line 861 def update!(**args) @audit_configs = args[:audit_configs] if args.key?(:audit_configs) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @version = args[:version] if args.key?(:version) end |