com.google.api.services.storage

Class Storage.Folders.List

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Folders

public class Storage.Folders.List
extends StorageRequest<Folders>

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	List(String bucket) Retrieves a list of folders matching the criteria.

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 to look for folders.
String	getDelimiter() Returns results in a directory-like mode.
String	getEndOffset() Filter results to folders whose names are lexicographically before endOffset.
Integer	getPageSize() Maximum number of items to return in a single page of responses.
String	getPageToken() A previously-returned page token representing part of the larger set of results to view.
String	getPrefix() Filter results to folders whose paths begin with this prefix.
String	getStartOffset() Filter results to folders whose names are lexicographically equal to or after startOffset.
Storage.Folders.List	set(String parameterName, Object value)
Storage.Folders.List	setAlt(String alt) Data format for the response.
Storage.Folders.List	setBucket(String bucket) Name of the bucket in which to look for folders.
Storage.Folders.List	setDelimiter(String delimiter) Returns results in a directory-like mode.
Storage.Folders.List	setEndOffset(String endOffset) Filter results to folders whose names are lexicographically before endOffset.
Storage.Folders.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Folders.List	setKey(String key) API key.
Storage.Folders.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Folders.List	setPageSize(Integer pageSize) Maximum number of items to return in a single page of responses.
Storage.Folders.List	setPageToken(String pageToken) A previously-returned page token representing part of the larger set of results to view.
Storage.Folders.List	setPrefix(String prefix) Filter results to folders whose paths begin with this prefix.
Storage.Folders.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Folders.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Folders.List	setStartOffset(String startOffset) Filter results to folders whose names are lexicographically equal to or after startOffset.
Storage.Folders.List	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Folders.List	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

List

protected List(String bucket)

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled. Create a request for the method "folders.list". 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 to look for folders.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

setAlt

public Storage.Folders.List setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<Folders>

setFields

public Storage.Folders.List setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<Folders>

setKey

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

setOauthToken

public Storage.Folders.List setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<Folders>

setPrettyPrint

public Storage.Folders.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<Folders>

setQuotaUser

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

setUploadType

public Storage.Folders.List setUploadType(String uploadType)

Description copied from class: StorageRequest

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

Overrides:

setUploadType in class StorageRequest<Folders>

setUserIp

public Storage.Folders.List setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<Folders>

getBucket

public String getBucket()

Name of the bucket in which to look for folders.

setBucket

public Storage.Folders.List setBucket(String bucket)

Name of the bucket in which to look for folders.

getDelimiter

public String getDelimiter()

Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.

setDelimiter

public Storage.Folders.List setDelimiter(String delimiter)

Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.

getEndOffset

public String getEndOffset()

Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

setEndOffset

public Storage.Folders.List setEndOffset(String endOffset)

Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

getPageSize

public Integer getPageSize()

Maximum number of items to return in a single page of responses. [minimum: 0]

setPageSize

public Storage.Folders.List setPageSize(Integer pageSize)

Maximum number of items to return in a single page of responses.

getPageToken

public String getPageToken()

A previously-returned page token representing part of the larger set of results to view.

setPageToken

public Storage.Folders.List setPageToken(String pageToken)

A previously-returned page token representing part of the larger set of results to view.

getPrefix

public String getPrefix()

Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.

setPrefix

public Storage.Folders.List setPrefix(String prefix)

Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.

getStartOffset

public String getStartOffset()

Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

setStartOffset

public Storage.Folders.List setStartOffset(String startOffset)

Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

set

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

Overrides:

set in class StorageRequest<Folders>