com.google.cloud

Class IamPolicy<R>

java.lang.Object

com.google.cloud.IamPolicy<R>

Type Parameters:

R - the data type of roles (should be serializable)

All Implemented Interfaces:

Serializable

public abstract class IamPolicy<R>
extends Object
implements Serializable

Base class for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a map 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, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IamPolicy.Builder<R,B extends IamPolicy.Builder<R,B>> Builder for an IAM Policy.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IamPolicy(IamPolicy.Builder<R,? extends IamPolicy.Builder<R,?>> builder)

Method Summary

Methods

Modifier and Type	Method and Description
Map<R,Set<Identity>>	bindings() The map of bindings that comprises the policy.
boolean	equals(Object obj)
String	etag() The policy's etag.
int	hashCode()
abstract IamPolicy.Builder<R,? extends IamPolicy.Builder<R,?>>	toBuilder() Returns a builder containing the properties of this IAM Policy.
Integer	version() Sets the version of the policy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IamPolicy

protected IamPolicy(IamPolicy.Builder<R,? extends IamPolicy.Builder<R,?>> builder)

Method Detail

toBuilder

public abstract IamPolicy.Builder<R,? extends IamPolicy.Builder<R,?>> toBuilder()

Returns a builder containing the properties of this IAM Policy.

bindings

public Map<R,Set<Identity>> bindings()

The map of bindings that comprises the policy.

etag

public String etag()

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.

version

public Integer version()

Sets 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.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object