com.google.api.services.storage

Class Storage.Objects.TestIamPermissions

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<TestIamPermissionsResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.TestIamPermissions
extends StorageRequest<TestIamPermissionsResponse>

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	TestIamPermissions(String bucket, String object__, List<String> permissions) Tests a set of permissions on the given object to see which, if any, are held by the caller.

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.
List<String>	getPermissions() Permissions to test.
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.TestIamPermissions	set(String parameterName, Object value)
Storage.Objects.TestIamPermissions	setAlt(String alt) Data format for the response.
Storage.Objects.TestIamPermissions	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.TestIamPermissions	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.TestIamPermissions	setGeneration(Long generation) If present, selects a specific revision of this object (as opposed to the latest version, the default).
Storage.Objects.TestIamPermissions	setKey(String key) API key.
Storage.Objects.TestIamPermissions	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.TestIamPermissions	setObject(String object__) Name of the object.
Storage.Objects.TestIamPermissions	setPermissions(List<String> permissions) Permissions to test.
Storage.Objects.TestIamPermissions	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.TestIamPermissions	setProvisionalUserProject(String provisionalUserProject) The project to be billed for this request if the target bucket is requester-pays bucket.
Storage.Objects.TestIamPermissions	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.TestIamPermissions	setUserIp(String userIp) Deprecated.
Storage.Objects.TestIamPermissions	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

TestIamPermissions

protected TestIamPermissions(String bucket,
                             String object__,
                             List<String> permissions)

Tests a set of permissions on the given object to see which, if any, are held by the caller. Create a request for the method "objects.testIamPermissions". 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.

TestIamPermissions#initialize(com.google.api.client.googleapis.services.A bstractGoogleClientRequest) 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.

permissions - Permissions to test.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<TestIamPermissionsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<TestIamPermissionsResponse>

Throws:

IOException

setAlt

public Storage.Objects.TestIamPermissions setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<TestIamPermissionsResponse>

setFields

public Storage.Objects.TestIamPermissions setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<TestIamPermissionsResponse>

setKey

public Storage.Objects.TestIamPermissions 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<TestIamPermissionsResponse>

setOauthToken

public Storage.Objects.TestIamPermissions setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<TestIamPermissionsResponse>

setPrettyPrint

public Storage.Objects.TestIamPermissions setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<TestIamPermissionsResponse>

setQuotaUser

public Storage.Objects.TestIamPermissions 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<TestIamPermissionsResponse>

setUserIp

public Storage.Objects.TestIamPermissions setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<TestIamPermissionsResponse>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.TestIamPermissions 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.TestIamPermissions 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.

getPermissions

public List<String> getPermissions()

Permissions to test.

setPermissions

public Storage.Objects.TestIamPermissions setPermissions(List<String> permissions)

Permissions to test.

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.TestIamPermissions 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.TestIamPermissions 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.TestIamPermissions setUserProject(String userProject)

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

set

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

Overrides:

set in class StorageRequest<TestIamPermissionsResponse>