Interface BucketOperationOrBuilder (0.25.0)

public interface BucketOperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBucketName()

public abstract String getBucketName()

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

string bucket_name = 2;

Returns
Type	Description
`String`	The bucketName.

getBucketNameBytes()

public abstract ByteString getBucketNameBytes()

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

string bucket_name = 2;

Returns
Type	Description
`ByteString`	The bytes for bucketName.

getCompleteTime()

public abstract Timestamp getCompleteTime()

Output only. The time that the BucketOperation was completed.

.google.protobuf.Timestamp complete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The completeTime.

getCompleteTimeOrBuilder()

public abstract TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. The time that the BucketOperation was completed.

.google.protobuf.Timestamp complete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getCounters()

public abstract Counters getCounters()

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

.google.cloud.storagebatchoperations.v1.Counters counters = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Counters`	The counters.

getCountersOrBuilder()

public abstract CountersOrBuilder getCountersOrBuilder()

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

.google.cloud.storagebatchoperations.v1.Counters counters = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`CountersOrBuilder`

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time that the BucketOperation was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time that the BucketOperation was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDeleteObject()

public abstract DeleteObject getDeleteObject()

Delete objects.

.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 12;

Returns
Type	Description
`DeleteObject`	The deleteObject.

getDeleteObjectOrBuilder()

public abstract DeleteObjectOrBuilder getDeleteObjectOrBuilder()

Delete objects.

.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 12;

Returns
Type	Description
`DeleteObjectOrBuilder`

getErrorSummaries(int index)

public abstract ErrorSummary getErrorSummaries(int index)

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

repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ErrorSummary`

getErrorSummariesCount()

public abstract int getErrorSummariesCount()

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

repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

getErrorSummariesList()

public abstract List<ErrorSummary> getErrorSummariesList()

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

repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<ErrorSummary>`

getErrorSummariesOrBuilder(int index)

public abstract ErrorSummaryOrBuilder getErrorSummariesOrBuilder(int index)

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

repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ErrorSummaryOrBuilder`

getErrorSummariesOrBuilderList()

public abstract List<? extends ErrorSummaryOrBuilder> getErrorSummariesOrBuilderList()

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

repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`List<? extends com.google.cloud.storagebatchoperations.v1.ErrorSummaryOrBuilder>`

getManifest()

public abstract Manifest getManifest()

Specifies objects in a manifest file.

.google.cloud.storagebatchoperations.v1.Manifest manifest = 4;

Returns
Type	Description
`Manifest`	The manifest.

getManifestOrBuilder()

public abstract ManifestOrBuilder getManifestOrBuilder()

Specifies objects in a manifest file.

.google.cloud.storagebatchoperations.v1.Manifest manifest = 4;

Returns
Type	Description
`ManifestOrBuilder`

getName()

public abstract String 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}.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
`ByteString`	The bytes for name.

getObjectConfigurationCase()

public abstract BucketOperation.ObjectConfigurationCase getObjectConfigurationCase()

Returns
Type	Description
`BucketOperation.ObjectConfigurationCase`

getPrefixList()

public abstract PrefixList getPrefixList()

Specifies objects matching a prefix set.

.google.cloud.storagebatchoperations.v1.PrefixList prefix_list = 3;

Returns
Type	Description
`PrefixList`	The prefixList.

getPrefixListOrBuilder()

public abstract PrefixListOrBuilder getPrefixListOrBuilder()

Specifies objects matching a prefix set.

.google.cloud.storagebatchoperations.v1.PrefixList prefix_list = 3;

Returns
Type	Description
`PrefixListOrBuilder`

getPutMetadata()

public abstract PutMetadata 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.

.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 13;

Returns
Type	Description
`PutMetadata`	The putMetadata.

getPutMetadataOrBuilder()

public abstract PutMetadataOrBuilder getPutMetadataOrBuilder()

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.

.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 13;

Returns
Type	Description
`PutMetadataOrBuilder`

getPutObjectHold()

public abstract PutObjectHold getPutObjectHold()

Changes object hold status.

.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 11;

Returns
Type	Description
`PutObjectHold`	The putObjectHold.

getPutObjectHoldOrBuilder()

public abstract PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()

Changes object hold status.

.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 11;

Returns
Type	Description
`PutObjectHoldOrBuilder`

getRewriteObject()

public abstract RewriteObject getRewriteObject()

Rewrite the object and updates metadata like KMS key.

.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 14;

Returns
Type	Description
`RewriteObject`	The rewriteObject.

getRewriteObjectOrBuilder()

public abstract RewriteObjectOrBuilder getRewriteObjectOrBuilder()

Rewrite the object and updates metadata like KMS key.

.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 14;

Returns
Type	Description
`RewriteObjectOrBuilder`

getStartTime()

public abstract Timestamp getStartTime()

Output only. The time that the BucketOperation was started.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time that the BucketOperation was started.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getState()

public abstract BucketOperation.State getState()

Output only. State of the BucketOperation.

.google.cloud.storagebatchoperations.v1.BucketOperation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`BucketOperation.State`	The state.

getStateValue()

public abstract int getStateValue()

Output only. State of the BucketOperation.

.google.cloud.storagebatchoperations.v1.BucketOperation.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getTransformationCase()

public abstract BucketOperation.TransformationCase getTransformationCase()

Returns
Type	Description
`BucketOperation.TransformationCase`

hasCompleteTime()

public abstract boolean hasCompleteTime()

Output only. The time that the BucketOperation was completed.

.google.protobuf.Timestamp complete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the completeTime field is set.

hasCounters()

public abstract boolean hasCounters()

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

.google.cloud.storagebatchoperations.v1.Counters counters = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the counters field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time that the BucketOperation was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasDeleteObject()

public abstract boolean hasDeleteObject()

Delete objects.

.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 12;

Returns
Type	Description
`boolean`	Whether the deleteObject field is set.

hasManifest()

public abstract boolean hasManifest()

Specifies objects in a manifest file.

.google.cloud.storagebatchoperations.v1.Manifest manifest = 4;

Returns
Type	Description
`boolean`	Whether the manifest field is set.

hasPrefixList()

public abstract boolean hasPrefixList()

Specifies objects matching a prefix set.

.google.cloud.storagebatchoperations.v1.PrefixList prefix_list = 3;

Returns
Type	Description
`boolean`	Whether the prefixList field is set.

hasPutMetadata()

public abstract boolean hasPutMetadata()

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.

.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 13;

Returns
Type	Description
`boolean`	Whether the putMetadata field is set.

hasPutObjectHold()

public abstract boolean hasPutObjectHold()

Changes object hold status.

.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 11;

Returns
Type	Description
`boolean`	Whether the putObjectHold field is set.

hasRewriteObject()

public abstract boolean hasRewriteObject()

Rewrite the object and updates metadata like KMS key.

.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 14;

Returns
Type	Description
`boolean`	Whether the rewriteObject field is set.

hasStartTime()

public abstract boolean hasStartTime()

Output only. The time that the BucketOperation was started.

.google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the startTime field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-23 UTC.