Cloud Storage API v1beta2 (revision 2)



com.google.api.services.storage
Class Storage.Objects.WatchAll

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.storage.StorageRequest<Channel>
                      extended by com.google.api.services.storage.Storage.Objects.WatchAll
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
Storage.Objects

public class Storage.Objects.WatchAll
extends StorageRequest<Channel>


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.WatchAll(String bucket, Channel content)
          Watch for changes on all objects in a bucket.
 
Method Summary
 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.WatchAll set(String parameterName, Object value)
           
 Storage.Objects.WatchAll setAlt(String alt)
          Data format for the response.
 Storage.Objects.WatchAll setBucket(String bucket)
          Name of the bucket in which to look for objects.
 Storage.Objects.WatchAll setDelimiter(String delimiter)
          Returns results in a directory-like mode.
 Storage.Objects.WatchAll setFields(String fields)
          Selector specifying which fields to include in a partial response.
 Storage.Objects.WatchAll setKey(String key)
          API key.
 Storage.Objects.WatchAll setMaxResults(Long maxResults)
          Maximum number of items plus prefixes to return.
 Storage.Objects.WatchAll setOauthToken(String oauthToken)
          OAuth 2.0 token for the current user.
 Storage.Objects.WatchAll setPageToken(String pageToken)
          A previously-returned page token representing part of the larger set of results to view.
 Storage.Objects.WatchAll setPrefix(String prefix)
          Filter results to objects whose names begin with this prefix.
 Storage.Objects.WatchAll setPrettyPrint(Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Storage.Objects.WatchAll setProjection(String projection)
          Set of properties to return.
 Storage.Objects.WatchAll setQuotaUser(String quotaUser)
          Available to use for quota purposes for server-side applications.
 Storage.Objects.WatchAll setUserIp(String userIp)
          IP address of the site where the request originates.
 Storage.Objects.WatchAll 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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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.WatchAll

protected Storage.Objects.WatchAll(String bucket,
                                   Channel content)
Watch for changes on all objects in a bucket. Create a request for the method "objects.watchAll". 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.
content - the Channel
Since:
1.13
Method Detail

setAlt

public Storage.Objects.WatchAll setAlt(String alt)
Description copied from class: StorageRequest
Data format for the response.

Overrides:
setAlt in class StorageRequest<Channel>

setFields

public Storage.Objects.WatchAll setFields(String fields)
Description copied from class: StorageRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class StorageRequest<Channel>

setKey

public Storage.Objects.WatchAll 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<Channel>

setOauthToken

public Storage.Objects.WatchAll setOauthToken(String oauthToken)
Description copied from class: StorageRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class StorageRequest<Channel>

setPrettyPrint

public Storage.Objects.WatchAll setPrettyPrint(Boolean prettyPrint)
Description copied from class: StorageRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class StorageRequest<Channel>

setQuotaUser

public Storage.Objects.WatchAll setQuotaUser(String quotaUser)
Description copied from class: StorageRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:
setQuotaUser in class StorageRequest<Channel>

setUserIp

public Storage.Objects.WatchAll setUserIp(String userIp)
Description copied from class: StorageRequest
IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:
setUserIp in class StorageRequest<Channel>

getBucket

public String getBucket()
Name of the bucket in which to look for objects.


setBucket

public Storage.Objects.WatchAll setBucket(String bucket)
Name of the bucket in which to look for objects.


getProjection

public String getProjection()
Set of properties to return. Defaults to noAcl.


setProjection

public Storage.Objects.WatchAll setProjection(String projection)
Set of properties to return. Defaults to noAcl.


getVersions

public Boolean getVersions()
If true, lists all versions of a file as distinct results.


setVersions

public Storage.Objects.WatchAll setVersions(Boolean versions)
If true, lists all versions of a file as distinct results.


getPrefix

public String getPrefix()
Filter results to objects whose names begin with this prefix.


setPrefix

public Storage.Objects.WatchAll setPrefix(String prefix)
Filter results to objects whose names begin with this prefix.


getMaxResults

public Long getMaxResults()
Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. [minimum: 0]


setMaxResults

public Storage.Objects.WatchAll setMaxResults(Long maxResults)
Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.


getPageToken

public String getPageToken()
A previously-returned page token representing part of the larger set of results to view.


setPageToken

public Storage.Objects.WatchAll setPageToken(String pageToken)
A previously-returned page token representing part of the larger set of results to view.


getDelimiter

public String getDelimiter()
Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.


setDelimiter

public Storage.Objects.WatchAll setDelimiter(String delimiter)
Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.


set

public Storage.Objects.WatchAll set(String parameterName,
                                    Object value)
Overrides:
set in class StorageRequest<Channel>