public final class Policy extends GeneratedMessageV3 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PolicyImplements
PolicyOrBuilderStatic Fields
BINDINGS_FIELD_NUMBER
public static final int BINDINGS_FIELD_NUMBER| Type | Description |
| int |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER| Type | Description |
| int |
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static Policy getDefaultInstance()| Type | Description |
| Policy |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static Policy.Builder newBuilder()| Type | Description |
| Policy.Builder |
newBuilder(Policy prototype)
public static Policy.Builder newBuilder(Policy prototype)| Name | Description |
| prototype | Policy |
| Type | Description |
| Policy.Builder |
parseDelimitedFrom(InputStream input)
public static Policy parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Policy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static Policy parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Policy parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Policy parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static Policy parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static Policy parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Policy |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<Policy> parser()| Type | Description |
| Parser<Policy> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
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 |
| Type | Description |
| Binding |
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;
| Type | Description |
| int |
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;
| Type | Description |
| List<Binding> |
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 |
| Type | Description |
| BindingOrBuilder |
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()| Type | Description |
| Policy |
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;
| Type | Description |
| ByteString | The etag. |
getParserForType()
public Parser<Policy> getParserForType()| Type | Description |
| Parser<Policy> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
getVersion()
public int 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. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public Policy.Builder newBuilderForType()| Type | Description |
| Policy.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Policy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| Policy.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public Policy.Builder toBuilder()| Type | Description |
| Policy.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |