bucket_operations

Creates, updates, deletes, gets or lists a bucket_operations resource.

Overview

Name	bucket_operations
Type	Resource
Id	google.storagebatchoperations.bucket_operations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project_id}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.
bucketName	string	The bucket name of the objects to be transformed in the BucketOperation.
completeTime	string (google-datetime)	Output only. The time that the BucketOperation was completed.
counters	object	Output only. Information about the progress of the bucket operation. (id: Counters)
createTime	string (google-datetime)	Output only. The time that the BucketOperation was created.
deleteObject	object	Delete objects. (id: DeleteObject)
errorSummaries	array	Output only. Summarizes errors encountered with sample error log entries.
manifest	object	Specifies objects in a manifest file. (id: Manifest)
prefixList	object	Specifies objects matching a prefix set. (id: PrefixList)
projectSource	object	Specifies objects matching the object filters in a project source. (id: ProjectSource)
putMetadata	object	Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time. (id: PutMetadata)
putObjectHold	object	Changes object hold status. (id: PutObjectHold)
rewriteObject	object	Rewrite the object and updates metadata like KMS key. (id: RewriteObject)
setObjectAcls	object	Updates object ACLs. (id: SetObjectAcls)
startTime	string (google-datetime)	Output only. The time that the BucketOperation was started.
state	string	Output only. State of the BucketOperation. (STATE_UNSPECIFIED, QUEUED, RUNNING, SUCCEEDED, CANCELED, FAILED)
updateObjectCustomContext	object	Update object custom context. (id: UpdateObjectCustomContext)

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, jobsId, bucketOperationsId		Gets a BucketOperation.
list	select	projectsId, locationsId, jobsId	filter, pageSize, orderBy, pageToken	Lists BucketOperations in a given project and job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bucketOperationsId	string
jobsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets a BucketOperation.

SELECT
name,
bucketName,
completeTime,
counters,
createTime,
deleteObject,
errorSummaries,
manifest,
prefixList,
projectSource,
putMetadata,
putObjectHold,
rewriteObject,
setObjectAcls,
startTime,
state,
updateObjectCustomContext
FROM google.storagebatchoperations.bucket_operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobsId = '{{ jobsId }}' -- required
AND bucketOperationsId = '{{ bucketOperationsId }}' -- required
;

list

Lists BucketOperations in a given project and job.

SELECT
*
FROM google.storagebatchoperations.bucket_operations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND jobsId = '{{ jobsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
;