com.google.api.services.storage

Class Storage.Objects.Move

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Objects

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

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Move(String bucket, String sourceObject, String destinationObject) Moves the source object to the destination object in the same bucket.

Method Summary

Modifier and Type	Method and Description
String	getBucket() Name of the bucket in which the object resides.
String	getDestinationObject() Name of 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 current generation matches the given value.
Long	getIfSourceGenerationNotMatch() Makes the operation conditional on whether the source object's current 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	getSourceObject() Name of the source object.
String	getUserProject() The project to be billed for this request.
Storage.Objects.Move	set(String parameterName, Object value)
Storage.Objects.Move	setAlt(String alt) Data format for the response.
Storage.Objects.Move	setBucket(String bucket) Name of the bucket in which the object resides.
Storage.Objects.Move	setDestinationObject(String destinationObject) Name of the destination object.
Storage.Objects.Move	setFields(String fields) Selector specifying which fields to include in a partial response.
Storage.Objects.Move	setIfGenerationMatch(Long ifGenerationMatch) Makes the operation conditional on whether the destination object's current generation matches the given value.
Storage.Objects.Move	setIfGenerationNotMatch(Long ifGenerationNotMatch) Makes the operation conditional on whether the destination object's current generation does not match the given value.
Storage.Objects.Move	setIfMetagenerationMatch(Long ifMetagenerationMatch) Makes the operation conditional on whether the destination object's current metageneration matches the given value.
Storage.Objects.Move	setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch) Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
Storage.Objects.Move	setIfSourceGenerationMatch(Long ifSourceGenerationMatch) Makes the operation conditional on whether the source object's current generation matches the given value.
Storage.Objects.Move	setIfSourceGenerationNotMatch(Long ifSourceGenerationNotMatch) Makes the operation conditional on whether the source object's current generation does not match the given value.
Storage.Objects.Move	setIfSourceMetagenerationMatch(Long ifSourceMetagenerationMatch) Makes the operation conditional on whether the source object's current metageneration matches the given value.
Storage.Objects.Move	setIfSourceMetagenerationNotMatch(Long ifSourceMetagenerationNotMatch) Makes the operation conditional on whether the source object's current metageneration does not match the given value.
Storage.Objects.Move	setKey(String key) API key.
Storage.Objects.Move	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Storage.Objects.Move	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Storage.Objects.Move	setProjection(String projection) Set of properties to return.
Storage.Objects.Move	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Storage.Objects.Move	setSourceObject(String sourceObject) Name of the source object.
Storage.Objects.Move	setUploadType(String uploadType) Upload protocol for media (e.g.
Storage.Objects.Move	setUserIp(String userIp) Deprecated.
Storage.Objects.Move	setUserProject(String userProject) The project to be billed for this request.

Methods inherited from class com.google.api.services.storage.StorageRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadType, 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, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Move

protected Move(String bucket,
               String sourceObject,
               String destinationObject)

Moves the source object to the destination object in the same bucket. Create a request for the method "objects.move". 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.

sourceObject - Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

destinationObject - Name of the destination object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

Since:

1.13

Method Detail

setAlt

public Storage.Objects.Move setAlt(String alt)

Description copied from class: StorageRequest

Data format for the response.

Overrides:

setAlt in class StorageRequest<StorageObject>

setFields

public Storage.Objects.Move 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.Move 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.Move 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.Move 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.Move setQuotaUser(String quotaUser)

Description copied from class: StorageRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class StorageRequest<StorageObject>

setUploadType

public Storage.Objects.Move setUploadType(String uploadType)

Description copied from class: StorageRequest

Upload protocol for media (e.g. "media", "multipart", "resumable").

Overrides:

setUploadType in class StorageRequest<StorageObject>

setUserIp

public Storage.Objects.Move setUserIp(String userIp)

Description copied from class: StorageRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class StorageRequest<StorageObject>

getBucket

public String getBucket()

Name of the bucket in which the object resides.

setBucket

public Storage.Objects.Move setBucket(String bucket)

Name of the bucket in which the object resides.

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](https://cloud.google.com/storage/docs/request-endpoints#encoding).

setSourceObject

public Storage.Objects.Move 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](https://cloud.google.com/storage/docs/request- endpoints#encoding).

getDestinationObject

public String getDestinationObject()

Name of the destination object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

setDestinationObject

public Storage.Objects.Move setDestinationObject(String destinationObject)

Name of the destination object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request- endpoints#encoding).

getIfGenerationMatch

public Long getIfGenerationMatch()

Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. `ifGenerationMatch` and `ifGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfGenerationMatch

public Storage.Objects.Move setIfGenerationMatch(Long ifGenerationMatch)

Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. `ifGenerationMatch` and `ifGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfGenerationNotMatch

public Long getIfGenerationNotMatch()

Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.`ifGenerationMatch` and `ifGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfGenerationNotMatch

public Storage.Objects.Move setIfGenerationNotMatch(Long ifGenerationNotMatch)

Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.`ifGenerationMatch` and `ifGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfMetagenerationMatch

public Long getIfMetagenerationMatch()

Makes the operation conditional on whether the destination object's current metageneration matches the given value. `ifMetagenerationMatch` and `ifMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfMetagenerationMatch

public Storage.Objects.Move setIfMetagenerationMatch(Long ifMetagenerationMatch)

Makes the operation conditional on whether the destination object's current metageneration matches the given value. `ifMetagenerationMatch` and `ifMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfMetagenerationNotMatch

public Long getIfMetagenerationNotMatch()

Makes the operation conditional on whether the destination object's current metageneration does not match the given value. `ifMetagenerationMatch` and `ifMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfMetagenerationNotMatch

public Storage.Objects.Move setIfMetagenerationNotMatch(Long ifMetagenerationNotMatch)

Makes the operation conditional on whether the destination object's current metageneration does not match the given value. `ifMetagenerationMatch` and `ifMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfSourceGenerationMatch

public Long getIfSourceGenerationMatch()

Makes the operation conditional on whether the source object's current generation matches the given value. `ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfSourceGenerationMatch

public Storage.Objects.Move setIfSourceGenerationMatch(Long ifSourceGenerationMatch)

Makes the operation conditional on whether the source object's current generation matches the given value. `ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfSourceGenerationNotMatch

public Long getIfSourceGenerationNotMatch()

Makes the operation conditional on whether the source object's current generation does not match the given value. `ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfSourceGenerationNotMatch

public Storage.Objects.Move setIfSourceGenerationNotMatch(Long ifSourceGenerationNotMatch)

Makes the operation conditional on whether the source object's current generation does not match the given value. `ifSourceGenerationMatch` and `ifSourceGenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfSourceMetagenerationMatch

public Long getIfSourceMetagenerationMatch()

Makes the operation conditional on whether the source object's current metageneration matches the given value. `ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfSourceMetagenerationMatch

public Storage.Objects.Move setIfSourceMetagenerationMatch(Long ifSourceMetagenerationMatch)

Makes the operation conditional on whether the source object's current metageneration matches the given value. `ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getIfSourceMetagenerationNotMatch

public Long getIfSourceMetagenerationNotMatch()

Makes the operation conditional on whether the source object's current metageneration does not match the given value. `ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

setIfSourceMetagenerationNotMatch

public Storage.Objects.Move setIfSourceMetagenerationNotMatch(Long ifSourceMetagenerationNotMatch)

Makes the operation conditional on whether the source object's current metageneration does not match the given value. `ifSourceMetagenerationMatch` and `ifSourceMetagenerationNotMatch` conditions are mutually exclusive: it's an error for both of them to be set in the request.

getProjection

public String getProjection()

Set of properties to return. Defaults to noAcl.

setProjection

public Storage.Objects.Move setProjection(String projection)

Set of properties to return. Defaults to noAcl.

getUserProject

public String getUserProject()

The project to be billed for this request. Required for Requester Pays buckets.

setUserProject

public Storage.Objects.Move setUserProject(String userProject)

The project to be billed for this request. Required for Requester Pays buckets.

set

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

Overrides:

set in class StorageRequest<StorageObject>