Concatenates a list of existing objects into a new object in the same bucket.
Arguments
destinationBucket
string
Required. Name of the bucket containing the source objects. The destination object is stored in this bucket.
destinationObject
string
Required. Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts .
destinationPredefinedAcl
enum
Apply a predefined set of access controls to the destination object.
authenticatedRead
bucketOwnerFullControl
bucketOwnerRead
private
projectPrivate
publicRead
ifGenerationMatch
string ( int64
format)
Makes the operation conditional on whether the 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.
ifMetagenerationMatch
string ( int64
format)
Makes the operation conditional on whether the object's current metageneration matches the given value.
kmsKeyName
string
Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
userProject
string
The project to be billed for this request. Required for Requester Pays buckets.
body
object ( ComposeRequest
)
Required.
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
Response
If successful, the response contains an instance of Object
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- compose : call : googleapis.storage.v1.objects.compose args : destinationBucket : ... destinationObject : ... destinationPredefinedAcl : ... ifGenerationMatch : ... ifMetagenerationMatch : ... kmsKeyName : ... userProject : ... body : destination : acl : ... bucket : ... cacheControl : ... componentCount : ... contentDisposition : ... contentEncoding : ... contentLanguage : ... contentType : ... crc32c : ... customTime : ... customerEncryption : encryptionAlgorithm : ... keySha256 : ... etag : ... eventBasedHold : ... generation : ... id : ... kind : ... kmsKeyName : ... md5Hash : ... mediaLink : ... metadata : ... metageneration : ... name : ... owner : entity : ... entityId : ... retentionExpirationTime : ... selfLink : ... size : ... storageClass : ... temporaryHold : ... timeCreated : ... timeDeleted : ... timeStorageClassUpdated : ... updated : ... kind : ... sourceObjects : generation : ... name : ... objectPreconditions : ifGenerationMatch : ... result : composeResult
JSON
[ { "compose" : { "call" : "googleapis.storage.v1.objects.compose" , "args" : { "destinationBucket" : "..." , "destinationObject" : "..." , "destinationPredefinedAcl" : "..." , "ifGenerationMatch" : "..." , "ifMetagenerationMatch" : "..." , "kmsKeyName" : "..." , "userProject" : "..." , "body" : { "destination" : { "acl" : "..." , "bucket" : "..." , "cacheControl" : "..." , "componentCount" : "..." , "contentDisposition" : "..." , "contentEncoding" : "..." , "contentLanguage" : "..." , "contentType" : "..." , "crc32c" : "..." , "customTime" : "..." , "customerEncryption" : { "encryptionAlgorithm" : "..." , "keySha256" : "..." }, "etag" : "..." , "eventBasedHold" : "..." , "generation" : "..." , "id" : "..." , "kind" : "..." , "kmsKeyName" : "..." , "md5Hash" : "..." , "mediaLink" : "..." , "metadata" : "..." , "metageneration" : "..." , "name" : "..." , "owner" : { "entity" : "..." , "entityId" : "..." }, "retentionExpirationTime" : "..." , "selfLink" : "..." , "size" : "..." , "storageClass" : "..." , "temporaryHold" : "..." , "timeCreated" : "..." , "timeDeleted" : "..." , "timeStorageClassUpdated" : "..." , "updated" : "..." }, "kind" : "..." , "sourceObjects" : { "generation" : "..." , "name" : "..." , "objectPreconditions" : { "ifGenerationMatch" : "..." } } } }, "result" : "composeResult" } } ]
