com.google.api.services.storage

Class Storage.Buckets.Get

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Buckets

public class Storage.Buckets.Get
extends StorageRequest<Bucket>

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	Get(String bucket) Returns metadata 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.
Long	getGeneration() If present, specifies the generation of the bucket.
Long	getIfMetagenerationMatch() Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
Long	getIfMetagenerationNotMatch() Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
String	getProjection() Set of properties to return.
Boolean	getSoftDeleted() If true, return the soft-deleted version of this bucket.
String	getUserProject() The project to be billed for this request.
Storage.Buckets.Get	set(String parameterName, Object value)
Storage.Buckets.Get	setAlt(String alt) Data format for the response.
Storage.Buckets.Get	setBucket(String bucket) Name of a bucket.
Storage.Buckets.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Buckets.Get	setGeneration(Long generation) If present, specifies the generation of the bucket.
Storage.Buckets.Get	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
Storage.Buckets.Get	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
Storage.Buckets.Get	setKey(String key) API key.
Storage.Buckets.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Buckets.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Buckets.Get	setProjection(String projection) Set of properties to return.
Storage.Buckets.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Buckets.Get	setSoftDeleted(Boolean softDeleted) If true, return the soft-deleted version of this bucket.
Storage.Buckets.Get	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Buckets.Get	setUserIp(String userIp) Deprecated.
Storage.Buckets.Get	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, 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

Get

protected Get(String bucket)

Returns metadata for the specified bucket. Create a request for the method "buckets.get". 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 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<Bucket>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Storage.Buckets.Get setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Bucket>

setFields

public Storage.Buckets.Get setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Bucket>

setKey

public Storage.Buckets.Get 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<Bucket>

setOauthToken

public Storage.Buckets.Get setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Bucket>

setPrettyPrint

public Storage.Buckets.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Bucket>

setQuotaUser

public Storage.Buckets.Get 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<Bucket>

setUploadType

public Storage.Buckets.Get setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<Bucket>

setUserIp

public Storage.Buckets.Get setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Bucket>

getBucket

public String getBucket()

Name of a bucket.

setBucket

public Storage.Buckets.Get setBucket(String bucket)

Name of a bucket.

getGeneration

public Long getGeneration()

If present, specifies the generation of the bucket. This is required if softDeleted is true.

setGeneration

public Storage.Buckets.Get setGeneration(Long generation)

If present, specifies the generation of the bucket. This is required if softDeleted is true.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.

setIfMetagenerationMatch

public Storage.Buckets.Get setIfMetagenerationMatch(Long ifMetagenerationMatch)

Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.

setIfMetagenerationNotMatch

public Storage.Buckets.Get setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.

getProjection

public String getProjection()

Set of properties to return. Defaults to noAcl.

setProjection

public Storage.Buckets.Get setProjection(String projection)

Set of properties to return. Defaults to noAcl.

getSoftDeleted

public Boolean getSoftDeleted()

If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).

setSoftDeleted

public Storage.Buckets.Get setSoftDeleted(Boolean softDeleted)

If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).

getUserProject

public String getUserProject()

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

setUserProject

public Storage.Buckets.Get setUserProject(String userProject)

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

set

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

Overrides:

set in class StorageRequest<Bucket>