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

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

Enclosing class:: Storage.Objects

public class Storage.Objects.Get
extends StorageRequest<StorageObject>
extends StorageRequest<StorageObject>

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.Get(String bucket, String storageObject)` Retrieves objects or their associated metadata.

Method Summary
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeMedia()`
`void`	`executeMediaAndDownloadTo(OutputStream outputStream)`
`InputStream`	`executeMediaAsInputStream()`
`HttpResponse`	`executeUsingHead()`
`String`	`getBucket()` Name of the bucket in which the object resides.
`BigInteger`	`getGeneration()` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`BigInteger`	`getIfGenerationMatch()` Makes the operation conditional on whether the object's generation matches the given value.
`BigInteger`	`getIfGenerationNotMatch()` Makes the operation conditional on whether the object's generation does not match the given value.
`BigInteger`	`getIfMetagenerationMatch()` Makes the operation conditional on whether the object's current metageneration matches the given value.
`BigInteger`	`getIfMetagenerationNotMatch()` Makes the operation conditional on whether the object's current metageneration does not match the given value.
`String`	`getObject()` Name of the object.
`String`	`getProjection()` Set of properties to return.
`Storage.Objects.Get`	`set(String parameterName, Object value)`
`Storage.Objects.Get`	`setAlt(String alt)` Data format for the response.
`Storage.Objects.Get`	`setBucket(String bucket)` Name of the bucket in which the object resides.
`Storage.Objects.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.Get`	`setGeneration(BigInteger generation)` If present, selects a specific revision of this object (as opposed to the latest version, the default).
`Storage.Objects.Get`	`setIfGenerationMatch(BigInteger ifGenerationMatch)` Makes the operation conditional on whether the object's generation matches the given value.
`Storage.Objects.Get`	`setIfGenerationNotMatch(BigInteger ifGenerationNotMatch)` Makes the operation conditional on whether the object's generation does not match the given value.
`Storage.Objects.Get`	`setIfMetagenerationMatch(BigInteger ifMetagenerationMatch)` Makes the operation conditional on whether the object's current metageneration matches the given value.
`Storage.Objects.Get`	`setIfMetagenerationNotMatch(BigInteger ifMetagenerationNotMatch)` Makes the operation conditional on whether the object's current metageneration does not match the given value.
`Storage.Objects.Get`	`setKey(String key)` API key.
`Storage.Objects.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Objects.Get`	`setObject(String storageObject)` Name of the object.
`Storage.Objects.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Objects.Get`	`setProjection(String projection)` Set of properties to return.
`Storage.Objects.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Storage.Objects.Get`	`setUserIp(String userIp)` IP address of the site where the request originates.

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, 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, 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.Get

protected Storage.Objects.Get(String bucket,
                              String storageObject)

Retrieves objects or their associated metadata. Create a request for the method "objects.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 object resides.; storageObject - Name of the object.
Since:: 1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:: executeMediaAndDownloadTo in class AbstractGoogleClientRequest<StorageObject>

Throws:: IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:: executeMediaAsInputStream in class AbstractGoogleClientRequest<StorageObject>

Throws:: IOException

executeMedia

public HttpResponse executeMedia()
                          throws IOException

Overrides:: executeMedia in class AbstractGoogleClientRequest<StorageObject>

Throws:: IOException

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:: executeUsingHead in class AbstractGoogleClientRequest<StorageObject>

Throws:: IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:: buildHttpRequestUsingHead in class AbstractGoogleClientRequest<StorageObject>

Throws:: IOException