Path parameters
|
destinationBucket
|
string
|
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
|
string
|
Name of the new object. Required when the object metadata is not otherwise provided.
Overrides the object metadata's
name
value, if any.
|
sourceBucket
|
string
|
Name of the bucket in which to find the source object.
|
sourceObject
|
string
|
Name of the source object. For information about how to URL encode object names to be path
safe, see
Encoding URI path parts
.
|
Optional query parameters
|
destinationKmsKeyName
|
string
|
Resource name of the
Cloud KMS key
that will be used to encrypt the object. The Cloud KMS
key must be located in same location as the object.
If the parameter is not specified, the request uses the destination bucket's
default encryption key, if any, or else it uses
standard Cloud Storage
encryption
.
If the object is large, re-encryption with the key may take too long and result
in a
Deadline exceeded
error. For large objects, consider using the
rewrite
method instead.
|
destinationPredefinedAcl
|
string
|
Apply a predefined set of access controls to the destination object.
Acceptable values are:
authenticatedRead
: Object owner gets
OWNER
access, and
allAuthenticatedUsers
get
READER
access.
bucketOwnerFullControl
: Object owner gets
OWNER
access,
and project team owners get
OWNER
access.
bucketOwnerRead
: Object owner gets
OWNER
access, and
project team owners get
READER
access.
private
: Object owner gets
OWNER
access.
projectPrivate
: Object owner gets
OWNER
access, and
project team members get access according to their roles.
publicRead
: Object owner gets
OWNER
access, and
allUsers
get
READER
access.
If
iamConfiguration.uniformBucketLevelAccess.enabled
is set to
true
, requests that include this parameter fail with a
400 Bad Request
response.
|
ifGenerationMatch
|
long
|
Makes the operation conditional on there being a live destination object with a generation
number that matches the given value. Setting
ifGenerationMatch
to 0 makes the
operation succeed only if there is no live destination object.
|
ifGenerationNotMatch
|
long
|
Makes the operation conditional on there being a live destination object with a generation
number that does not match the given value. If no live destination object exists, the
precondition fails. Setting
ifGenerationNotMatch
to 0 makes the operation
succeed if there is a live version of the object.
|
ifMetagenerationMatch
|
long
|
Makes the operation conditional on there being a live destination object with a
metageneration number that matches the given value.
|
ifMetagenerationNotMatch
|
long
|
Makes the operation conditional on there being a live destination object with a
metageneration number that does not match the given value.
|
ifSourceGenerationMatch
|
long
|
Makes the operation conditional on whether the source object's generation matches the
given value.
|
ifSourceGenerationNotMatch
|
long
|
Makes the operation conditional on whether the source object's generation does not match
the given value.
|
ifSourceMetagenerationMatch
|
long
|
Makes the operation conditional on whether the source object's current metageneration
matches the given value.
|
ifSourceMetagenerationNotMatch
|
long
|
Makes the operation conditional on whether the source object's current metageneration
does not match the given value.
|
projection
|
string
|
Set of properties to return. Defaults to
noAcl
, unless the object resource
specifies the
acl
property, when it defaults to
full
.
Acceptable values are:
full
: Include all properties.
noAcl
: Omit the
owner
,
acl
property.
|
sourceGeneration
|
long
|
If present, selects a specific revision of the source object (as opposed to the latest
version, the default).
|
X-Goog-Copy-Source-Encryption-Algorithm
|
string
|
The encryption algorithm to use, which must be
AES256
. Used if the source
object was encrypted with a
customer-supplied
encryption key
.
|
X-Goog-Copy-Source-Encryption-Key
|
string
|
An
RFC 4648
Base64-encoded string of the AES-256 encryption key used to encrypt the source object, if
it was encrypted with a
customer-supplied
encryption key
.
|
X-Goog-Copy-Source-Encryption-Key-Sha256
|
string
|
An
RFC 4648
Base64-encoded string of the SHA256 hash of the encryption key used to encrypt the source
object, if it was encrypted with a
customer-supplied encryption
key
.
|
X-Goog-Encryption-Algorithm
|
string
|
The encryption algorithm to use, which must be
AES256
. Used for encrypting
the destination object with a
customer-supplied encryption
key
.
|
X-Goog-Encryption-Key
|
string
|
An
RFC 4648
Base64-encoded string of your AES-256 encryption key. Used for encrypting the destination
object with a
customer-supplied
encryption key
.
|
X-Goog-Encryption-Key-Sha256
|
string
|
An
RFC 4648
Base64-encoded string of the SHA256 hash of your encryption key. Used for encrypting the
destination object with a
customer-supplied
encryption key
.
|