public class Storage.Objects.List extends StorageRequest<Objects>
GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
USER_AGENT_SUFFIX
Modifier | Constructor and Description |
---|---|
protected |
List(String bucket)
Retrieves a list of objects matching the criteria.
|
Modifier and Type | Method and Description |
---|---|
HttpRequest |
buildHttpRequestUsingHead() |
HttpResponse |
executeUsingHead() |
String |
getBucket()
Name of the bucket in which to look for objects.
|
String |
getDelimiter()
Returns results in a directory-like mode.
|
String |
getEndOffset()
Filter results to objects whose names are lexicographically before endOffset.
|
Boolean |
getIncludeTrailingDelimiter()
If true, objects that end in exactly one instance of delimiter will have their metadata included in
items in addition to prefixes.
|
Long |
getMaxResults()
Maximum number of items plus prefixes 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 objects whose names begin with this prefix.
|
String |
getProjection()
Set of properties to return.
|
String |
getStartOffset()
Filter results to objects whose names are lexicographically equal to or after startOffset.
|
String |
getUserProject()
The project to be billed for this request.
|
Boolean |
getVersions()
If true, lists all versions of an object as distinct results.
|
Storage.Objects.List |
set(String parameterName,
Object value) |
Storage.Objects.List |
setAlt(String alt)
Data format for the response.
|
Storage.Objects.List |
setBucket(String bucket)
Name of the bucket in which to look for objects.
|
Storage.Objects.List |
setDelimiter(String delimiter)
Returns results in a directory-like mode.
|
Storage.Objects.List |
setEndOffset(String endOffset)
Filter results to objects whose names are lexicographically before endOffset.
|
Storage.Objects.List |
setFields(String fields)
Selector specifying which fields to include in a partial response.
|
Storage.Objects.List |
setIncludeTrailingDelimiter(Boolean includeTrailingDelimiter)
If true, objects that end in exactly one instance of delimiter will have their metadata
included in items in addition to prefixes.
|
Storage.Objects.List |
setKey(String key)
API key.
|
Storage.Objects.List |
setMaxResults(Long maxResults)
Maximum number of items plus prefixes to return in a single page of responses.
|
Storage.Objects.List |
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
|
Storage.Objects.List |
setPageToken(String pageToken)
A previously-returned page token representing part of the larger set of results to view.
|
Storage.Objects.List |
setPrefix(String prefix)
Filter results to objects whose names begin with this prefix.
|
Storage.Objects.List |
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Storage.Objects.List |
setProjection(String projection)
Set of properties to return.
|
Storage.Objects.List |
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
|
Storage.Objects.List |
setStartOffset(String startOffset)
Filter results to objects whose names are lexicographically equal to or after startOffset.
|
Storage.Objects.List |
setUploadType(String uploadType)
Upload protocol for media (e.g.
|
Storage.Objects.List |
setUserIp(String userIp)
Deprecated.
|
Storage.Objects.List |
setUserProject(String userProject)
The project to be billed for this request.
|
Storage.Objects.List |
setVersions(Boolean versions)
If true, lists all versions of an object as distinct results.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadType, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
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
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
protected List(String bucket)
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.
bucket
- Name of the bucket in which to look for objects.public HttpResponse executeUsingHead() throws IOException
executeUsingHead
in class AbstractGoogleClientRequest<Objects>
IOException
public HttpRequest buildHttpRequestUsingHead() throws IOException
buildHttpRequestUsingHead
in class AbstractGoogleClientRequest<Objects>
IOException
public Storage.Objects.List setAlt(String alt)
StorageRequest
setAlt
in class StorageRequest<Objects>
public Storage.Objects.List setFields(String fields)
StorageRequest
setFields
in class StorageRequest<Objects>
public Storage.Objects.List setKey(String key)
StorageRequest
setKey
in class StorageRequest<Objects>
public Storage.Objects.List setOauthToken(String oauthToken)
StorageRequest
setOauthToken
in class StorageRequest<Objects>
public Storage.Objects.List setPrettyPrint(Boolean prettyPrint)
StorageRequest
setPrettyPrint
in class StorageRequest<Objects>
public Storage.Objects.List setQuotaUser(String quotaUser)
StorageRequest
setQuotaUser
in class StorageRequest<Objects>
public Storage.Objects.List setUploadType(String uploadType)
StorageRequest
setUploadType
in class StorageRequest<Objects>
public Storage.Objects.List setUserIp(String userIp)
StorageRequest
setUserIp
in class StorageRequest<Objects>
public String getBucket()
public Storage.Objects.List setBucket(String bucket)
public String getDelimiter()
public Storage.Objects.List setDelimiter(String delimiter)
public String getEndOffset()
public Storage.Objects.List setEndOffset(String endOffset)
public Boolean getIncludeTrailingDelimiter()
public Storage.Objects.List setIncludeTrailingDelimiter(Boolean includeTrailingDelimiter)
public Long getMaxResults()
public Storage.Objects.List setMaxResults(Long maxResults)
public String getPageToken()
public Storage.Objects.List setPageToken(String pageToken)
public String getPrefix()
public Storage.Objects.List setPrefix(String prefix)
public String getProjection()
public Storage.Objects.List setProjection(String projection)
public String getStartOffset()
public Storage.Objects.List setStartOffset(String startOffset)
public String getUserProject()
public Storage.Objects.List setUserProject(String userProject)
public Boolean getVersions()
public Storage.Objects.List setVersions(Boolean versions)
public Storage.Objects.List set(String parameterName, Object value)
set
in class StorageRequest<Objects>
Copyright © 2011–2022 Google. All rights reserved.