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>

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

Constructors

Modifier	Constructor and Description
protected	Storage.Objects.Get(String bucket, String storageObject) Retrieves objects or their associated metadata.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream) Upgrade warning: in prior version 1.8 this method was called download.
InputStream	executeMediaAsInputStream()
HttpResponse	executeUsingHead()
String	getBucket() Name of the bucket in which the object resides.
com.google.common.primitives.UnsignedLong	getGeneration() If present, selects a specific revision of this object (as opposed to the latest version, the default).
com.google.common.primitives.UnsignedLong	getIfGenerationMatch() Makes the operation conditional on whether the object's generation matches the given value.
com.google.common.primitives.UnsignedLong	getIfGenerationNotMatch() Makes the operation conditional on whether the object's generation does not match the given value.
com.google.common.primitives.UnsignedLong	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
com.google.common.primitives.UnsignedLong	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	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(com.google.common.primitives.UnsignedLong generation) If present, selects a specific revision of this object (as opposed to the latest version, the default).
Storage.Objects.Get	setIfGenerationMatch(com.google.common.primitives.UnsignedLong ifGenerationMatch) Makes the operation conditional on whether the object's generation matches the given value.
Storage.Objects.Get	setIfGenerationNotMatch(com.google.common.primitives.UnsignedLong ifGenerationNotMatch) Makes the operation conditional on whether the object's generation does not match the given value.
Storage.Objects.Get	setIfMetagenerationMatch(com.google.common.primitives.UnsignedLong ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Get	setIfMetagenerationNotMatch(com.google.common.primitives.UnsignedLong 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, 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, set, 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(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

Upgrade warning: in prior version 1.8 this method was called download.

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

setAlt

public Storage.Objects.Get setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

public Storage.Objects.Get setFields(String fields)

Description copied from class: StorageRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StorageRequest<StorageObject>

setKey

public Storage.Objects.Get 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<StorageObject>

setOauthToken

public Storage.Objects.Get setOauthToken(String oauthToken)

Description copied from class: StorageRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StorageRequest<StorageObject>

setPrettyPrint

public Storage.Objects.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: StorageRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StorageRequest<StorageObject>

setQuotaUser

public Storage.Objects.Get 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<StorageObject>

setUserIp

public Storage.Objects.Get 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<StorageObject>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.Get setBucket(String bucket)

Name of the bucket in which the object resides.

getObject

public String getObject()

Name of the object.

setObject

public Storage.Objects.Get setObject(String storageObject)

Name of the object.

getIfGenerationNotMatch

public com.google.common.primitives.UnsignedLong getIfGenerationNotMatch()

Makes the operation conditional on whether the object's generation does not match the given value.

setIfGenerationNotMatch

public Storage.Objects.Get setIfGenerationNotMatch(com.google.common.primitives.UnsignedLong ifGenerationNotMatch)

Makes the operation conditional on whether the object's generation does not match the given value.

getGeneration

public com.google.common.primitives.UnsignedLong getGeneration()

If present, selects a specific revision of this object (as opposed to the latest version, the default).

setGeneration

public Storage.Objects.Get setGeneration(com.google.common.primitives.UnsignedLong generation)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

getIfMetagenerationMatch

public com.google.common.primitives.UnsignedLong getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

setIfMetagenerationMatch

public Storage.Objects.Get setIfMetagenerationMatch(com.google.common.primitives.UnsignedLong ifMetagenerationMatch)

Makes the operation conditional on whether the object's current metageneration matches the given value.

getIfGenerationMatch

public com.google.common.primitives.UnsignedLong getIfGenerationMatch()

Makes the operation conditional on whether the object's generation matches the given value.

setIfGenerationMatch

public Storage.Objects.Get setIfGenerationMatch(com.google.common.primitives.UnsignedLong ifGenerationMatch)

Makes the operation conditional on whether the object's generation matches the given value.

getIfMetagenerationNotMatch

public com.google.common.primitives.UnsignedLong getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

setIfMetagenerationNotMatch

public Storage.Objects.Get setIfMetagenerationNotMatch(com.google.common.primitives.UnsignedLong ifMetagenerationNotMatch)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

getProjection

public String getProjection()

Set of properties to return. Defaults to noAcl.

setProjection

public Storage.Objects.Get setProjection(String projection)

Set of properties to return. Defaults to noAcl.