com.google.api.services.storage

Class Storage.Folders.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<Folder>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Folders

public class Storage.Folders.Get
extends StorageRequest<Folder>

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, String folder) Returns metadata for the specified folder.

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 the bucket in which the folder resides.
String	getFolder() Name of a folder.
Long	getIfMetagenerationMatch() Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
Long	getIfMetagenerationNotMatch() Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
Storage.Folders.Get	set(String parameterName, Object value)
Storage.Folders.Get	setAlt(String alt) Data format for the response.
Storage.Folders.Get	setBucket(String bucket) Name of the bucket in which the folder resides.
Storage.Folders.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Folders.Get	setFolder(String folder) Name of a folder.
Storage.Folders.Get	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
Storage.Folders.Get	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
Storage.Folders.Get	setKey(String key) API key.
Storage.Folders.Get	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Folders.Get	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Folders.Get	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Folders.Get	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Folders.Get	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

Get

protected Get(String bucket,
              String folder)

Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled. Create a request for the method "folders.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 the bucket in which the folder resides.

folder - Name of a folder.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Storage.Folders.Get setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Folder>

setFields

public Storage.Folders.Get setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Folder>

setKey

public Storage.Folders.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<Folder>

setOauthToken

public Storage.Folders.Get setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Folder>

setPrettyPrint

public Storage.Folders.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Folder>

setQuotaUser

public Storage.Folders.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<Folder>

setUploadType

public Storage.Folders.Get setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<Folder>

setUserIp

public Storage.Folders.Get setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Folder>

getBucket

public String getBucket()

Name of the bucket in which the folder resides.

setBucket

public Storage.Folders.Get setBucket(String bucket)

Name of the bucket in which the folder resides.

getFolder

public String getFolder()

Name of a folder.

setFolder

public Storage.Folders.Get setFolder(String folder)

Name of a folder.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

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

setIfMetagenerationMatch

public Storage.Folders.Get setIfMetagenerationMatch(Long ifMetagenerationMatch)

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

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

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

setIfMetagenerationNotMatch

public Storage.Folders.Get setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

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

set

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

Overrides:

set in class StorageRequest<Folder>