Class Policy (2.31.0)

public final class Policy implements Serializable

Class for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of identities to a role, where the identities can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. See Also: Policy

Inheritance

Object > Policy

Implements

Serializable

Static Methods

newBuilder()

public static Policy.Builder newBuilder()

Returns a builder for Policy objects.

Returns
TypeDescription
Policy.Builder

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBindings()

public Map<Role,Set<Identity>> getBindings()

Returns the map of bindings that comprises the policy.

Returns
TypeDescription
Map<Role,Set<Identity>>

getBindingsList()

public ImmutableList<Binding> getBindingsList()

Returns the list of bindings that comprises the policy for version 3.

Returns
TypeDescription
com.google.common.collect.ImmutableList<Binding>

getEtag()

public String getEtag()

Returns the policy's etag.

Etags are 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.

Returns
TypeDescription
String

getVersion()

public int getVersion()

Returns the version of the policy. The default version is 0, meaning only the "owner", "editor", and "viewer" roles are permitted. If the version is 1, you may also use other roles.

Returns
TypeDescription
int

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

toBuilder()

public Policy.Builder toBuilder()

Returns a builder containing the properties of this IAM Policy.

Returns
TypeDescription
Policy.Builder

toString()

public String toString()
Returns
TypeDescription
String
Overrides