com.google.api.services.storage.model

Class Policy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Policy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Policy
extends com.google.api.client.json.GenericJson

A bucket/object/managedFolder IAM policy.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Storage JSON API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Policy.Bindings Model definition for PolicyBindings.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Policy()

Method Summary

Modifier and Type	Method and Description
Policy	clone()
byte[]	decodeEtag() HTTP 1.1 Entity tag for the policy.
Policy	encodeEtag(byte[] etag) HTTP 1.1 Entity tag for the policy.
List<Policy.Bindings>	getBindings() An association between a role, which comes with a set of permissions, and members who may assume that role.
String	getEtag() HTTP 1.1 Entity tag for the policy.
String	getKind() The kind of item this is.
String	getResourceId() The ID of the resource to which this policy belongs.
Integer	getVersion() The IAM policy format version.
Policy	set(String fieldName, Object value)
Policy	setBindings(List<Policy.Bindings> bindings) An association between a role, which comes with a set of permissions, and members who may assume that role.
Policy	setEtag(String etag) HTTP 1.1 Entity tag for the policy.
Policy	setKind(String kind) The kind of item this is.
Policy	setResourceId(String resourceId) The ID of the resource to which this policy belongs.
Policy	setVersion(Integer version) The IAM policy format version.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Policy

public Policy()

Method Detail

getBindings

public List<Policy.Bindings> getBindings()

An association between a role, which comes with a set of permissions, and members who may assume that role.

Returns:

value or null for none

setBindings

public Policy setBindings(List<Policy.Bindings> bindings)

An association between a role, which comes with a set of permissions, and members who may assume that role.

Parameters:

bindings - bindings or null for none

getEtag

public String getEtag()

HTTP 1.1 Entity tag for the policy.

Returns:

value or null for none

See Also:

decodeEtag()

decodeEtag

public byte[] decodeEtag()

HTTP 1.1 Entity tag for the policy.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public Policy setEtag(String etag)

HTTP 1.1 Entity tag for the policy.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public Policy encodeEtag(byte[] etag)

HTTP 1.1 Entity tag for the policy.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getKind

public String getKind()

The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.

Returns:

value or null for none

setKind

public Policy setKind(String kind)

The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.

Parameters:

kind - kind or null for none

getResourceId

public String getResourceId()

The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.

Returns:

value or null for none

setResourceId

public Policy setResourceId(String resourceId)

The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, projects/_/buckets/bucket/objects/object for objects, and projects/_/buckets/bucket/managedFolders/managedFolder. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.

Parameters:

resourceId - resourceId or null for none

getVersion

public Integer getVersion()

The IAM policy format version.

Returns:

value or null for none

setVersion

public Policy setVersion(Integer version)

The IAM policy format version.

Parameters:

version - version or null for none

set

public Policy set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Policy clone()

Overrides:

clone in class com.google.api.client.json.GenericJson