REST Resource: projects.locations.jobs.bucketOperations

Resource: BucketOperation

BucketOperation represents a bucket-level breakdown of a Job.

JSON representation
{
  "name": string,
  "bucketName": string,
  "createTime": string,
  "startTime": string,
  "completeTime": string,
  "counters": {
    object (Counters)
  },
  "errorSummaries": [
    {
      object (ErrorSummary)
    }
  ],
  "state": enum (State),

  // Union field object_configuration can be only one of the following:
  "prefixList": {
    object (PrefixList)
  },
  "manifest": {
    object (Manifest)
  },
  "projectSource": {
    object (ProjectSource)
  }
  // End of list of possible types for union field object_configuration.

  // Union field transformation can be only one of the following:
  "putObjectHold": {
    object (PutObjectHold)
  },
  "deleteObject": {
    object (DeleteObject)
  },
  "putMetadata": {
    object (PutMetadata)
  },
  "rewriteObject": {
    object (RewriteObject)
  },
  "updateObjectCustomContext": {
    object (UpdateObjectCustomContext)
  },
  "setObjectAcls": {
    object (SetObjectAcls)
  }
  // End of list of possible types for union field transformation.
}
Fields
name

string

Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{projectId}/locations/global/jobs/{jobId}/bucketOperations/{bucket_operation}.

bucketName

string

The bucket name of the objects to be transformed in the BucketOperation.

createTime

string (Timestamp format)

Output only. The time that the BucketOperation was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

startTime

string (Timestamp format)

Output only. The time that the BucketOperation was started.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

completeTime

string (Timestamp format)

Output only. The time that the BucketOperation was completed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

counters

object (Counters)

Output only. Information about the progress of the bucket operation.

errorSummaries[]

object (ErrorSummary)

Output only. Summarizes errors encountered with sample error log entries.

state

enum (State)

Output only. State of the BucketOperation.

Union field object_configuration. Specifies objects to be transformed in the BucketOperation. object_configuration can be only one of the following:
prefixList

object (PrefixList)

Specifies objects matching a prefix set.

manifest

object (Manifest)

Specifies objects in a manifest file.

projectSource

object (ProjectSource)

Specifies objects matching the object filters in a project source.

Union field transformation. Action to be performed on the objects. transformation can be only one of the following:
putObjectHold

object (PutObjectHold)

Changes object hold status.

deleteObject

object (DeleteObject)

Delete objects.

putMetadata

object (PutMetadata)

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.

rewriteObject

object (RewriteObject)

Rewrite the object and updates metadata like KMS key.

updateObjectCustomContext

object (UpdateObjectCustomContext)

Update object custom context.

setObjectAcls

object (SetObjectAcls)

Updates object ACLs.

State

Describes state of the BucketOperation.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
QUEUED Created but not yet started.
RUNNING In progress.
SUCCEEDED Completed successfully.
CANCELED Cancelled by the user.
FAILED Terminated due to an unrecoverable failure.

Methods

get

Gets a BucketOperation.

list

Lists BucketOperations in a given project and job.