com.google.api.services.storage

Class Storage.Objects.Copy

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

public class Storage.Objects.Copy
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.Copy(String sourceBucket, String sourceObject, String destinationBucket, String destinationObject, StorageObject content) Copies a source object to a destination object.

Method Summary

Methods

Modifier and Type	Method and Description
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.
String	getDestinationPredefinedAcl() Apply a predefined set of access controls to the destination object.
Long	getIfGenerationMatch() Makes the operation conditional on whether the destination object's current generation matches the given value.
Long	getIfGenerationNotMatch() Makes the operation conditional on whether the destination object's current generation does not match the given value.
Long	getIfMetagenerationMatch() Makes the operation conditional on whether the destination object's current metageneration matches the given value.
Long	getIfMetagenerationNotMatch() Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
Long	getIfSourceGenerationMatch() Makes the operation conditional on whether the source object's generation matches the given value.
Long	getIfSourceGenerationNotMatch() Makes the operation conditional on whether the source object's generation does not match the given value.
Long	getIfSourceMetagenerationMatch() Makes the operation conditional on whether the source object's current metageneration matches the given value.
Long	getIfSourceMetagenerationNotMatch() Makes the operation conditional on whether the source object's current metageneration does not match the given value.
String	getProjection() Set of properties to return.
String	getSourceBucket() Name of the bucket in which to find the source object.
Long	getSourceGeneration() If present, selects a specific revision of the source object (as opposed to the latest version, the default).
String	getSourceObject() Name of the source object.
Storage.Objects.Copy	set(String parameterName, Object value)
Storage.Objects.Copy	setAlt(String alt) Data format for the response.
Storage.Objects.Copy	setDestinationBucket(String destinationBucket) Name of the bucket in which to store the new object.
Storage.Objects.Copy	setDestinationObject(String destinationObject) Name of the new object.
Storage.Objects.Copy	setDestinationPredefinedAcl(String destinationPredefinedAcl) Apply a predefined set of access controls to the destination object.
Storage.Objects.Copy	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Copy	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the destination object's current generation matches the given value.
Storage.Objects.Copy	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether the destination object's current generation does not match the given value.
Storage.Objects.Copy	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the destination object's current metageneration matches the given value.
Storage.Objects.Copy	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
Storage.Objects.Copy	setIfSourceGenerationMatch(Long ifSourceGenerationMatch) Makes the operation conditional on whether the source object's generation matches the given value.
Storage.Objects.Copy	setIfSourceGenerationNotMatch(Long ifSourceGenerationNotMatch) Makes the operation conditional on whether the source object's generation does not match the given value.
Storage.Objects.Copy	setIfSourceMetagenerationMatch(Long ifSourceMetagenerationMatch) Makes the operation conditional on whether the source object's current metageneration matches the given value.
Storage.Objects.Copy	setIfSourceMetagenerationNotMatch(Long ifSourceMetagenerationNotMatch) Makes the operation conditional on whether the source object's current metageneration does not match the given value.
Storage.Objects.Copy	setKey(String key) API key.
Storage.Objects.Copy	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Copy	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Copy	setProjection(String projection) Set of properties to return.
Storage.Objects.Copy	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Storage.Objects.Copy	setSourceBucket(String sourceBucket) Name of the bucket in which to find the source object.
Storage.Objects.Copy	setSourceGeneration(Long sourceGeneration) If present, selects a specific revision of the source object (as opposed to the latest version, the default).
Storage.Objects.Copy	setSourceObject(String sourceObject) Name of the source object.
Storage.Objects.Copy	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.Copy

protected Storage.Objects.Copy(String sourceBucket,
                    String sourceObject,
                    String destinationBucket,
                    String destinationObject,
                    StorageObject content)

Copies a source object to a destination object. Optionally overrides metadata. Create a request for the method "objects.copy". 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:

sourceBucket - Name of the bucket in which to find the source object.

sourceObject - Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

destinationBucket - Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

destinationObject - Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.

content - the StorageObject

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.Copy setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

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

getSourceBucket

public String getSourceBucket()

Name of the bucket in which to find the source object.

setSourceBucket

public Storage.Objects.Copy setSourceBucket(String sourceBucket)

Name of the bucket in which to find the source object.

getSourceObject

public String getSourceObject()

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

setSourceObject

public Storage.Objects.Copy setSourceObject(String sourceObject)

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

getDestinationBucket

public String getDestinationBucket()

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

setDestinationBucket

public Storage.Objects.Copy setDestinationBucket(String destinationBucket)

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

getDestinationObject

public String getDestinationObject()

Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.

setDestinationObject

public Storage.Objects.Copy setDestinationObject(String destinationObject)

Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.

getDestinationPredefinedAcl

public String getDestinationPredefinedAcl()

Apply a predefined set of access controls to the destination object.

setDestinationPredefinedAcl

public Storage.Objects.Copy setDestinationPredefinedAcl(String destinationPredefinedAcl)

Apply a predefined set of access controls to the destination object.

getIfGenerationMatch

public Long getIfGenerationMatch()

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

setIfGenerationMatch

public Storage.Objects.Copy setIfGenerationMatch(Long ifGenerationMatch)

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

getIfGenerationNotMatch

public Long getIfGenerationNotMatch()

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

setIfGenerationNotMatch

public Storage.Objects.Copy setIfGenerationNotMatch(Long ifGenerationNotMatch)

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

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

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

setIfMetagenerationMatch

public Storage.Objects.Copy setIfMetagenerationMatch(Long ifMetagenerationMatch)

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

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

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

setIfMetagenerationNotMatch

public Storage.Objects.Copy setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

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

getIfSourceGenerationMatch

public Long getIfSourceGenerationMatch()

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

setIfSourceGenerationMatch

public Storage.Objects.Copy setIfSourceGenerationMatch(Long ifSourceGenerationMatch)

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

getIfSourceGenerationNotMatch

public Long getIfSourceGenerationNotMatch()

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

setIfSourceGenerationNotMatch

public Storage.Objects.Copy setIfSourceGenerationNotMatch(Long ifSourceGenerationNotMatch)

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

getIfSourceMetagenerationMatch

public Long getIfSourceMetagenerationMatch()

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

setIfSourceMetagenerationMatch

public Storage.Objects.Copy setIfSourceMetagenerationMatch(Long ifSourceMetagenerationMatch)

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

getIfSourceMetagenerationNotMatch

public Long getIfSourceMetagenerationNotMatch()

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

setIfSourceMetagenerationNotMatch

public Storage.Objects.Copy setIfSourceMetagenerationNotMatch(Long ifSourceMetagenerationNotMatch)

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

getProjection

public String getProjection()

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

setProjection

public Storage.Objects.Copy setProjection(String projection)

Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

getSourceGeneration

public Long getSourceGeneration()

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

setSourceGeneration

public Storage.Objects.Copy setSourceGeneration(Long sourceGeneration)

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

set

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

Overrides:

set in class StorageRequest<StorageObject>