public static final class Policy.Builder extends GeneratedMessageV3.Builder<Policy.Builder> implements PolicyOrBuilder
Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources.
A Policy is a collection of bindings. A binding binds one or more
members to a single role. Members can be user accounts, service accounts,
Google groups, and domains (such as G Suite). A role is a named list of
permissions (defined by IAM or configured by users). A binding can
optionally specify a condition, which is a logic expression that further
constrains the role binding based on attributes about the request and/or
target resource.
JSON Example
{
"bindings": [
{
"role": "roles/resourcemanager.organizationAdmin",
"members": [
"user:mike@example.com",
"group:admins@example.com",
"domain:google.com",
"serviceAccount:my-project-id@appspot.gserviceaccount.com"
]
},
{
"role": "roles/resourcemanager.organizationViewer",
"members": ["user:eve@example.com"],
"condition": {
"title": "expirable access",
"description": "Does not grant access after Sep 2020",
"expression": "request.time <
timestamp('2020-10-01T00:00:00.000Z')",
}
}
]
}
YAML Example
bindings:
- members:
- user:mike@example.com
- group:admins@example.com
- domain:google.com
- serviceAccount:my-project-id@appspot.gserviceaccount.com
role: roles/resourcemanager.organizationAdmin
- members:
- user:eve@example.com
role: roles/resourcemanager.organizationViewer
condition:
title: expirable access
description: Does not grant access after Sep 2020
expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the
IAM developer's guide.
Protobuf type google.iam.v1.Policy
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addAllBindings(Iterable<? extends Binding> values)
public Policy.Builder addAllBindings(Iterable<? extends Binding> values)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| values |
Iterable<? extends com.google.iam.v1.Binding>
|
Returns
addBindings(Binding value)
public Policy.Builder addBindings(Binding value)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
addBindings(Binding.Builder builderForValue)
public Policy.Builder addBindings(Binding.Builder builderForValue)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
addBindings(int index, Binding value)
public Policy.Builder addBindings(int index, Binding value)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
addBindings(int index, Binding.Builder builderForValue)
public Policy.Builder addBindings(int index, Binding.Builder builderForValue)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
addBindingsBuilder()
public Binding.Builder addBindingsBuilder()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
addBindingsBuilder(int index)
public Binding.Builder addBindingsBuilder(int index)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| index |
int
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Policy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Policy buildPartial()
Returns
clear()
public Policy.Builder clear()
Returns
Overrides
clearBindings()
public Policy.Builder clearBindings()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
clearEtag()
public Policy.Builder clearEtag()
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. Due to blind-set semantics of an etag-less policy,
'setIamPolicy' will not fail even if the incoming policy version does not
meet the requirements for modifying the stored policy.
bytes etag = 3;
clearField(Descriptors.FieldDescriptor field)
public Policy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Policy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearVersion()
public Policy.Builder clearVersion()
Specifies the format of the policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Operations affecting conditional bindings must specify version 3. This can
be either setting a conditional policy, modifying a conditional binding,
or removing a binding (conditional or unconditional) from the stored
conditional policy.
Operations on non-conditional policies may specify any valid value or
leave the field unset.
If no etag is provided in the call to setIamPolicy, version compliance
checks against the stored policy is skipped.
int32 version = 1;
clone()
public Policy.Builder clone()
Returns
Overrides
getBindings(int index)
public Binding getBindings(int index)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| index |
int
|
Returns
getBindingsBuilder(int index)
public Binding.Builder getBindingsBuilder(int index)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| index |
int
|
Returns
getBindingsBuilderList()
public List<Binding.Builder> getBindingsBuilderList()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
getBindingsCount()
public int getBindingsCount()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
getBindingsList()
public List<Binding> getBindingsList()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
getBindingsOrBuilder(int index)
public BindingOrBuilder getBindingsOrBuilder(int index)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| index |
int
|
Returns
getBindingsOrBuilderList()
public List<? extends BindingOrBuilder> getBindingsOrBuilderList()
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Type |
Description |
| List<? extends com.google.iam.v1.BindingOrBuilder> |
|
getDefaultInstanceForType()
public Policy getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getEtag()
public ByteString getEtag()
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. Due to blind-set semantics of an etag-less policy,
'setIamPolicy' will not fail even if the incoming policy version does not
meet the requirements for modifying the stored policy.
bytes etag = 3;
getVersion()
Specifies the format of the policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Operations affecting conditional bindings must specify version 3. This can
be either setting a conditional policy, modifying a conditional binding,
or removing a binding (conditional or unconditional) from the stored
conditional policy.
Operations on non-conditional policies may specify any valid value or
leave the field unset.
If no etag is provided in the call to setIamPolicy, version compliance
checks against the stored policy is skipped.
int32 version = 1;
| Type |
Description |
| int |
The version.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Policy other)
public Policy.Builder mergeFrom(Policy other)
Parameter
Returns
public Policy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Policy.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Policy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
removeBindings(int index)
public Policy.Builder removeBindings(int index)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
| Name |
Description |
| index |
int
|
Returns
setBindings(int index, Binding value)
public Policy.Builder setBindings(int index, Binding value)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
setBindings(int index, Binding.Builder builderForValue)
public Policy.Builder setBindings(int index, Binding.Builder builderForValue)
Associates a list of members to a role. Optionally may specify a
condition that determines when binding is in effect.
bindings with no members will result in an error.
repeated .google.iam.v1.Binding bindings = 4;
setEtag(ByteString value)
public Policy.Builder setEtag(ByteString value)
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. Due to blind-set semantics of an etag-less policy,
'setIamPolicy' will not fail even if the incoming policy version does not
meet the requirements for modifying the stored policy.
bytes etag = 3;
setField(Descriptors.FieldDescriptor field, Object value)
public Policy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Policy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Policy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setVersion(int value)
public Policy.Builder setVersion(int value)
Specifies the format of the policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Operations affecting conditional bindings must specify version 3. This can
be either setting a conditional policy, modifying a conditional binding,
or removing a binding (conditional or unconditional) from the stored
conditional policy.
Operations on non-conditional policies may specify any valid value or
leave the field unset.
If no etag is provided in the call to setIamPolicy, version compliance
checks against the stored policy is skipped.
int32 version = 1;
| Name |
Description |
| value |
int
The version to set.
|
Returns
