com.google.api.services.storage

Class Storage.Buckets.GetStorageLayout

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

com.google.api.services.storage.Storage.Buckets.GetStorageLayout

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Buckets

public class Storage.Buckets.GetStorageLayout
extends StorageRequest<BucketStorageLayout>

Nested Class Summary

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>

Field Summary

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetStorageLayout(String bucket) Returns the storage layout configuration for the specified bucket.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getBucket() Name of a bucket.
String	getPrefix() An optional prefix used for permission check.
Storage.Buckets.GetStorageLayout	set(String parameterName, Object value)
Storage.Buckets.GetStorageLayout	setAlt(String alt) Data format for the response.
Storage.Buckets.GetStorageLayout	setBucket(String bucket) Name of a bucket.
Storage.Buckets.GetStorageLayout	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Buckets.GetStorageLayout	setKey(String key) API key.
Storage.Buckets.GetStorageLayout	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Buckets.GetStorageLayout	setPrefix(String prefix) An optional prefix used for permission check.
Storage.Buckets.GetStorageLayout	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Buckets.GetStorageLayout	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Buckets.GetStorageLayout	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Buckets.GetStorageLayout	setUserIp(String userIp) Deprecated.

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

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadType, 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

GetStorageLayout

protected GetStorageLayout(String bucket)

Returns the storage layout configuration for the specified bucket. Note that this operation requires storage.objects.list permission. Create a request for the method "buckets.getStorageLayout". 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.

GetStorageLayout#initialize(com.google.api.client.googleapis.services.AbstractGoogle ClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

bucket - Name of a bucket.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<BucketStorageLayout>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<BucketStorageLayout>

Throws:

IOException

setAlt

public Storage.Buckets.GetStorageLayout setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<BucketStorageLayout>

setFields

public Storage.Buckets.GetStorageLayout setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<BucketStorageLayout>

setKey

public Storage.Buckets.GetStorageLayout 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<BucketStorageLayout>

setOauthToken

public Storage.Buckets.GetStorageLayout setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<BucketStorageLayout>

setPrettyPrint

public Storage.Buckets.GetStorageLayout setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<BucketStorageLayout>

setQuotaUser

public Storage.Buckets.GetStorageLayout 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<BucketStorageLayout>

setUploadType

public Storage.Buckets.GetStorageLayout setUploadType(String uploadType)

Description copied from class: StorageRequest

Upload protocol for media (e.g. "media", "multipart", "resumable").

Overrides:

setUploadType in class StorageRequest<BucketStorageLayout>

setUserIp

public Storage.Buckets.GetStorageLayout setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<BucketStorageLayout>

getBucket

public String getBucket()

Name of a bucket.

setBucket

public Storage.Buckets.GetStorageLayout setBucket(String bucket)

Name of a bucket.

getPrefix

public String getPrefix()

An optional prefix used for permission check. It is useful when the caller only has storage.objects.list permission under a specific prefix.

setPrefix

public Storage.Buckets.GetStorageLayout setPrefix(String prefix)

An optional prefix used for permission check. It is useful when the caller only has storage.objects.list permission under a specific prefix.

set

public Storage.Buckets.GetStorageLayout set(String parameterName,
                                            Object value)

Overrides:

set in class StorageRequest<BucketStorageLayout>