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.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>
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.Copy(String sourceBucket, String sourceObject, String destinationBucket, String destinationObject, StorageObject content)` Copies an object to a destination in the same location.

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 destination object's current generation matches the given value.
`BigInteger`	`getIfGenerationNotMatch()` Makes the operation conditional on whether the destination object's current generation does not match the given value.
`BigInteger`	`getIfMetagenerationMatch()` Makes the operation conditional on whether the destination object's current metageneration matches the given value.
`BigInteger`	`getIfMetagenerationNotMatch()` Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
`BigInteger`	`getIfSourceGenerationMatch()` Makes the operation conditional on whether the source object's generation matches the given value.
`BigInteger`	`getIfSourceGenerationNotMatch()` Makes the operation conditional on whether the source object's generation does not match the given value.
`BigInteger`	`getIfSourceMetagenerationMatch()` Makes the operation conditional on whether the source object's current metageneration matches the given value.
`BigInteger`	`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.
`BigInteger`	`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`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Objects.Copy`	`setIfGenerationMatch(BigInteger ifGenerationMatch)` Makes the operation conditional on whether the destination object's current generation matches the given value.
`Storage.Objects.Copy`	`setIfGenerationNotMatch(BigInteger ifGenerationNotMatch)` Makes the operation conditional on whether the destination object's current generation does not match the given value.
`Storage.Objects.Copy`	`setIfMetagenerationMatch(BigInteger ifMetagenerationMatch)` Makes the operation conditional on whether the destination object's current metageneration matches the given value.
`Storage.Objects.Copy`	`setIfMetagenerationNotMatch(BigInteger ifMetagenerationNotMatch)` Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
`Storage.Objects.Copy`	`setIfSourceGenerationMatch(BigInteger ifSourceGenerationMatch)` Makes the operation conditional on whether the source object's generation matches the given value.
`Storage.Objects.Copy`	`setIfSourceGenerationNotMatch(BigInteger ifSourceGenerationNotMatch)` Makes the operation conditional on whether the source object's generation does not match the given value.
`Storage.Objects.Copy`	`setIfSourceMetagenerationMatch(BigInteger ifSourceMetagenerationMatch)` Makes the operation conditional on whether the source object's current metageneration matches the given value.
`Storage.Objects.Copy`	`setIfSourceMetagenerationNotMatch(BigInteger 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(BigInteger 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.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 an object to a destination in the same location. 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.; destinationBucket - Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.; 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