Google Cloud Storage Batch Operations V1 Client - Class BucketOperation (0.5.0)

Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class BucketOperation.

BucketOperation represents a bucket-level breakdown of a Job.

Generated from protobuf message google.cloud.storagebatchoperations.v1.BucketOperation

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.
`↳ bucket_name`	`string` The bucket name of the objects to be transformed in the BucketOperation.
`↳ prefix_list`	`PrefixList` Specifies objects matching a prefix set.
`↳ manifest`	`Manifest` Specifies objects in a manifest file.
`↳ put_object_hold`	`PutObjectHold` Changes object hold status.
`↳ delete_object`	`DeleteObject` Delete objects.
`↳ put_metadata`	`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.
`↳ rewrite_object`	`RewriteObject` Rewrite the object and updates metadata like KMS key.
`↳ update_object_custom_context`	`UpdateObjectCustomContext` Update object custom context.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time that the BucketOperation was created.
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. The time that the BucketOperation was started.
`↳ complete_time`	`Google\Protobuf\Timestamp` Output only. The time that the BucketOperation was completed.
`↳ counters`	`Counters` Output only. Information about the progress of the bucket operation.
`↳ error_summaries`	`array<ErrorSummary>` Output only. Summarizes errors encountered with sample error log entries.
`↳ state`	`int` Output only. State of the BucketOperation.

getName

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

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBucketName

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

Returns
Type	Description
`string`

setBucketName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPrefixList

Specifies objects matching a prefix set.

Returns
Type	Description
`PrefixList\|null`

hasPrefixList

setPrefixList

Specifies objects matching a prefix set.

Parameter
Name	Description
`var`	`PrefixList`

Returns
Type	Description
`$this`

getManifest

Specifies objects in a manifest file.

Returns
Type	Description
`Manifest\|null`

hasManifest

setManifest

Specifies objects in a manifest file.

Parameter
Name	Description
`var`	`Manifest`

Returns
Type	Description
`$this`

getPutObjectHold

Changes object hold status.

Returns
Type	Description
`PutObjectHold\|null`

hasPutObjectHold

setPutObjectHold

Changes object hold status.

Parameter
Name	Description
`var`	`PutObjectHold`

Returns
Type	Description
`$this`

getDeleteObject

Delete objects.

Returns
Type	Description
`DeleteObject\|null`

hasDeleteObject

setDeleteObject

Delete objects.

Parameter
Name	Description
`var`	`DeleteObject`

Returns
Type	Description
`$this`

getPutMetadata

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.

Returns
Type	Description
`PutMetadata\|null`

hasPutMetadata

setPutMetadata

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.

Parameter
Name	Description
`var`	`PutMetadata`

Returns
Type	Description
`$this`

getRewriteObject

Rewrite the object and updates metadata like KMS key.

Returns
Type	Description
`RewriteObject\|null`

hasRewriteObject

setRewriteObject

Rewrite the object and updates metadata like KMS key.

Parameter
Name	Description
`var`	`RewriteObject`

Returns
Type	Description
`$this`

getUpdateObjectCustomContext

Update object custom context.

Returns
Type	Description
`UpdateObjectCustomContext\|null`

hasUpdateObjectCustomContext

setUpdateObjectCustomContext

Update object custom context.

Parameter
Name	Description
`var`	`UpdateObjectCustomContext`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time that the BucketOperation was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime