Cloud Storage API v1beta2 (revision 2)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.api.services.storage
Class Storage.Objects.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<Objects>
                      com.google.api.services.storage.Storage.Objects.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Storage.Objects

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

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
`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>`

Constructor Summary
`protected`	`Storage.Objects.List(String bucket)` Retrieves a list of objects matching the criteria.

Method Summary
`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.
`Long`	`getMaxResults()` Maximum number of items plus prefixes to return.
`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.
`Boolean`	`getVersions()` If true, lists all versions of a file 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`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.List`	`setKey(String key)` API key.
`Storage.Objects.List`	`setMaxResults(Long maxResults)` Maximum number of items plus prefixes to return.
`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)` Available to use for quota purposes for server-side applications.
`Storage.Objects.List`	`setUserIp(String userIp)` IP address of the site where the request originates.
`Storage.Objects.List`	`setVersions(Boolean versions)` If true, lists all versions of a file as distinct results.

Methods inherited from class com.google.api.services.storage.StorageRequest
`getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, 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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
`clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys`

Methods inherited from class java.util.AbstractMap
`clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

Storage.Objects.List

protected Storage.Objects.List(String bucket)

Retrieves a list of objects matching the criteria. Create a request for the method "objects.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 objects.
Since:: 1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:: executeUsingHead in class AbstractGoogleClientRequest<Objects>

Throws:: IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:: buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Objects>

Throws:: IOException