Cloud Storage API v1beta2 (revision 2)

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

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.Compose

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Compose
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.Compose(String destinationBucket, String destinationObject, ComposeRequest content) Concatenates a list of existing objects into a new object in the same bucket.

Method Summary

HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
String	getDestinationBucket() Name of the bucket in which to store the new object.
String	getDestinationObject() Name of the new object.
BigInteger	getIfGenerationMatch() Makes the operation conditional on whether the object's current generation matches the given value.
BigInteger	getIfMetagenerationMatch() Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Compose	set(String parameterName, Object value)
Storage.Objects.Compose	setAlt(String alt) Data format for the response.
Storage.Objects.Compose	setDestinationBucket(String destinationBucket) Name of the bucket in which to store the new object.
Storage.Objects.Compose	setDestinationObject(String destinationObject) Name of the new object.
Storage.Objects.Compose	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Compose	setIfGenerationMatch(BigInteger ifGenerationMatch) Makes the operation conditional on whether the object's current generation matches the given value.
Storage.Objects.Compose	setIfMetagenerationMatch(BigInteger ifMetagenerationMatch) Makes the operation conditional on whether the object's current metageneration matches the given value.
Storage.Objects.Compose	setKey(String key) API key.
Storage.Objects.Compose	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Compose	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Compose	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Storage.Objects.Compose	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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.Compose

protected Storage.Objects.Compose(String destinationBucket,
                                  String destinationObject,
                                  ComposeRequest content)

Concatenates a list of existing objects into a new object in the same bucket. Create a request for the method "objects.compose". 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:

destinationBucket - Name of the bucket in which to store the new object.

destinationObject - Name of the new object.

content - the ComposeRequest

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

setAlt

public Storage.Objects.Compose setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

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

getDestinationBucket

public String getDestinationBucket()

Name of the bucket in which to store the new object.

setDestinationBucket

public Storage.Objects.Compose setDestinationBucket(String destinationBucket)

Name of the bucket in which to store the new object.

getDestinationObject

public String getDestinationObject()

Name of the new object.

setDestinationObject

public Storage.Objects.Compose setDestinationObject(String destinationObject)

Name of the new object.

getIfMetagenerationMatch

public BigInteger getIfMetagenerationMatch()

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

setIfMetagenerationMatch

public Storage.Objects.Compose setIfMetagenerationMatch(BigInteger ifMetagenerationMatch)

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

getIfGenerationMatch

public BigInteger getIfGenerationMatch()

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

setIfGenerationMatch

public Storage.Objects.Compose setIfGenerationMatch(BigInteger ifGenerationMatch)

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

set

public Storage.Objects.Compose set(String parameterName,
                                   Object value)

Overrides:

set in class StorageRequest<StorageObject>