com.google.cloud

Class IamPolicy.Builder<R,B extends IamPolicy.Builder<R,B>>

java.lang.Object

com.google.cloud.IamPolicy.Builder<R,B>

Type Parameters:

R - the data type of roles

B - the subclass extending this abstract builder

Enclosing class:

IamPolicy<R>

public abstract static class IamPolicy.Builder<R,B extends IamPolicy.Builder<R,B>>
extends Object

Builder for an IAM Policy.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IamPolicy.Builder() Constructor for IAM Policy builder.

Method Summary

Methods

Modifier and Type	Method and Description
B	addIdentity(R role, Identity first, Identity... others) Adds one or more identities to the policy under the role specified.
B	bindings(Map<R,Set<Identity>> bindings) Replaces the builder's map of bindings with the given map of bindings.
abstract IamPolicy<R>	build()
protected B	etag(String etag) Sets the policy's etag.
B	removeIdentity(R role, Identity first, Identity... others) Removes one or more identities from an existing binding.
B	removeRole(R role) Removes the role (and all identities associated with that role) from the policy.
protected B	version(Integer version) Sets the version of the policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

IamPolicy.Builder

protected IamPolicy.Builder()

Constructor for IAM Policy builder.

Method Detail

bindings

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

Replaces the builder's map of bindings with the given map of bindings.

Throws:

NullPointerException - if the given map is null or contains any null keys or values

IllegalArgumentException - if any identities in the given map are null

removeRole

public final B removeRole(R role)

Removes the role (and all identities associated with that role) from the policy.

addIdentity

public final B addIdentity(R role,
            Identity first,
            Identity... others)

Adds one or more identities to the policy under the role specified.

Throws:

NullPointerException - if the role or any of the identities is null.

removeIdentity

public final B removeIdentity(R role,
               Identity first,
               Identity... others)

Removes one or more identities from an existing binding. Does nothing if the binding associated with the provided role doesn't exist.

etag

protected final B etag(String etag)

Sets 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

protected final B version(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.

build

public abstract IamPolicy<R> build()