com.google.api.services.storage

Class Storage.Objects.GetIamPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.storage.StorageRequest<Policy>

com.google.api.services.storage.Storage.Objects.GetIamPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.GetIamPolicy
extends StorageRequest<Policy>

Nested Class Summary

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

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetIamPolicy(String bucket, String object__) Returns an IAM policy for the specified object.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getBucket() Name of the bucket in which the object resides.
Long	getGeneration() If present, selects a specific revision of this object (as opposed to the latest version, the default).
String	getObject() Name of the object.
String	getProvisionalUserProject() The project to be billed for this request if the target bucket is requester-pays bucket.
String	getUserProject() The project to be billed for this request.
Storage.Objects.GetIamPolicy	set(String parameterName, Object value)
Storage.Objects.GetIamPolicy	setAlt(String alt) Data format for the response.
Storage.Objects.GetIamPolicy	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.GetIamPolicy	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.GetIamPolicy	setGeneration(Long generation) If present, selects a specific revision of this object (as opposed to the latest version, the default).
Storage.Objects.GetIamPolicy	setKey(String key) API key.
Storage.Objects.GetIamPolicy	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.GetIamPolicy	setObject(String object__) Name of the object.
Storage.Objects.GetIamPolicy	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.GetIamPolicy	setProvisionalUserProject(String provisionalUserProject) The project to be billed for this request if the target bucket is requester-pays bucket.
Storage.Objects.GetIamPolicy	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.GetIamPolicy	setUserIp(String userIp) Deprecated.
Storage.Objects.GetIamPolicy	setUserProject(String userProject) The project to be billed for this request.

Methods inherited from class com.google.api.services.storage.StorageRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

GetIamPolicy

protected GetIamPolicy(String bucket,
                       String object__)

Returns an IAM policy for the specified object. Create a request for the method "objects.getIamPolicy". This request holds the parameters needed by the the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Storage.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

bucket - Name of the bucket in which the object resides.

object__ - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Policy>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Policy>

Throws:

IOException

setAlt

public Storage.Objects.GetIamPolicy setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Policy>

setFields

public Storage.Objects.GetIamPolicy setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Policy>

setKey

public Storage.Objects.GetIamPolicy setKey(String key)

Description copied from class: StorageRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class StorageRequest<Policy>

setOauthToken

public Storage.Objects.GetIamPolicy setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Policy>

setPrettyPrint

public Storage.Objects.GetIamPolicy setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Policy>

setQuotaUser

public Storage.Objects.GetIamPolicy setQuotaUser(String quotaUser)

Description copied from class: StorageRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class StorageRequest<Policy>

setUserIp

public Storage.Objects.GetIamPolicy setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Policy>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.GetIamPolicy setBucket(String bucket)

Name of the bucket in which the object resides.

getObject

public String getObject()

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

setObject

public Storage.Objects.GetIamPolicy setObject(String object__)

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

getGeneration

public Long getGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

setGeneration

public Storage.Objects.GetIamPolicy setGeneration(Long generation)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

getProvisionalUserProject

public String getProvisionalUserProject()

The project to be billed for this request if the target bucket is requester-pays bucket.

setProvisionalUserProject

public Storage.Objects.GetIamPolicy setProvisionalUserProject(String provisionalUserProject)

The project to be billed for this request if the target bucket is requester-pays bucket.

getUserProject

public String getUserProject()

The project to be billed for this request. Required for Requester Pays buckets.

setUserProject

public Storage.Objects.GetIamPolicy setUserProject(String userProject)

The project to be billed for this request. Required for Requester Pays buckets.

set

public Storage.Objects.GetIamPolicy set(String parameterName,
                                        Object value)

Overrides:

set in class StorageRequest<Policy>