Class BucketOperation.Builder (0.25.0)

public static final class BucketOperation.Builder extends GeneratedMessage.Builder<BucketOperation.Builder> implements BucketOperationOrBuilder

BucketOperation represents a bucket-level breakdown of a Job.

Protobuf type google.cloud.storagebatchoperations.v1.BucketOperation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllErrorSummaries(Iterable<? extends ErrorSummary> values)

public BucketOperation.Builder addAllErrorSummaries(Iterable<? extends ErrorSummary> values)

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
values Iterable<? extends com.google.cloud.storagebatchoperations.v1.ErrorSummary>
Returns
Type Description
BucketOperation.Builder

addErrorSummaries(ErrorSummary value)

public BucketOperation.Builder addErrorSummaries(ErrorSummary value)

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
value ErrorSummary
Returns
Type Description
BucketOperation.Builder

addErrorSummaries(ErrorSummary.Builder builderForValue)

public BucketOperation.Builder addErrorSummaries(ErrorSummary.Builder builderForValue)

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
builderForValue ErrorSummary.Builder
Returns
Type Description
BucketOperation.Builder

addErrorSummaries(int index, ErrorSummary value)

public BucketOperation.Builder addErrorSummaries(int index, ErrorSummary value)

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];

Parameters
Name Description
index int
value ErrorSummary
Returns
Type Description
BucketOperation.Builder

addErrorSummaries(int index, ErrorSummary.Builder builderForValue)

public BucketOperation.Builder addErrorSummaries(int index, ErrorSummary.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue ErrorSummary.Builder
Returns
Type Description
BucketOperation.Builder

addErrorSummariesBuilder()

public ErrorSummary.Builder addErrorSummariesBuilder()

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
ErrorSummary.Builder

addErrorSummariesBuilder(int index)

public ErrorSummary.Builder addErrorSummariesBuilder(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.Builder

build()

public BucketOperation build()
Returns
Type Description
BucketOperation

buildPartial()

public BucketOperation buildPartial()
Returns
Type Description
BucketOperation

clear()

public BucketOperation.Builder clear()
Returns
Type Description
BucketOperation.Builder
Overrides

clearBucketName()

public BucketOperation.Builder clearBucketName()

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

string bucket_name = 2;

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

clearCompleteTime()

public BucketOperation.Builder clearCompleteTime()

Output only. The time that the BucketOperation was completed.

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

Returns
Type Description
BucketOperation.Builder

clearCounters()

public BucketOperation.Builder clearCounters()

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
BucketOperation.Builder

clearCreateTime()

public BucketOperation.Builder clearCreateTime()

Output only. The time that the BucketOperation was created.

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

Returns
Type Description
BucketOperation.Builder

clearDeleteObject()

public BucketOperation.Builder clearDeleteObject()

Delete objects.

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

Returns
Type Description
BucketOperation.Builder

clearErrorSummaries()

public BucketOperation.Builder clearErrorSummaries()

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
BucketOperation.Builder

clearManifest()

public BucketOperation.Builder clearManifest()

Specifies objects in a manifest file.

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

Returns
Type Description
BucketOperation.Builder

clearName()

public BucketOperation.Builder clearName()

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
BucketOperation.Builder

This builder for chaining.

clearObjectConfiguration()

public BucketOperation.Builder clearObjectConfiguration()
Returns
Type Description
BucketOperation.Builder

clearPrefixList()

public BucketOperation.Builder clearPrefixList()

Specifies objects matching a prefix set.

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

Returns
Type Description
BucketOperation.Builder

clearPutMetadata()

public BucketOperation.Builder clearPutMetadata()

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
BucketOperation.Builder

clearPutObjectHold()

public BucketOperation.Builder clearPutObjectHold()

Changes object hold status.

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

Returns
Type Description
BucketOperation.Builder

clearRewriteObject()

public BucketOperation.Builder clearRewriteObject()

Rewrite the object and updates metadata like KMS key.

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

Returns
Type Description
BucketOperation.Builder

clearStartTime()

public BucketOperation.Builder clearStartTime()

Output only. The time that the BucketOperation was started.

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

Returns
Type Description
BucketOperation.Builder

clearState()

public BucketOperation.Builder clearState()

Output only. State of the BucketOperation.

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

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

clearTransformation()

public BucketOperation.Builder clearTransformation()
Returns
Type Description
BucketOperation.Builder

getBucketName()

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

getCompleteTimeBuilder()

public Timestamp.Builder getCompleteTimeBuilder()

Output only. The time that the BucketOperation was completed.

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

Returns
Type Description
Builder

getCompleteTimeOrBuilder()

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

getCountersBuilder()

public Counters.Builder getCountersBuilder()

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.Builder

getCountersOrBuilder()

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

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time that the BucketOperation was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public BucketOperation getDefaultInstanceForType()
Returns
Type Description
BucketOperation

getDeleteObject()

public DeleteObject getDeleteObject()

Delete objects.

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

Returns
Type Description
DeleteObject

The deleteObject.

getDeleteObjectBuilder()

public DeleteObject.Builder getDeleteObjectBuilder()

Delete objects.

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

Returns
Type Description
DeleteObject.Builder

getDeleteObjectOrBuilder()

public DeleteObjectOrBuilder getDeleteObjectOrBuilder()

Delete objects.

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

Returns
Type Description
DeleteObjectOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getErrorSummaries(int index)

public 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

getErrorSummariesBuilder(int index)

public ErrorSummary.Builder getErrorSummariesBuilder(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.Builder

getErrorSummariesBuilderList()

public List<ErrorSummary.Builder> getErrorSummariesBuilderList()

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<Builder>

getErrorSummariesCount()

public 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 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 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 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 Manifest getManifest()

Specifies objects in a manifest file.

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

Returns
Type Description
Manifest

The manifest.

getManifestBuilder()

public Manifest.Builder getManifestBuilder()

Specifies objects in a manifest file.

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

Returns
Type Description
Manifest.Builder

getManifestOrBuilder()

public ManifestOrBuilder getManifestOrBuilder()

Specifies objects in a manifest file.

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

Returns
Type Description
ManifestOrBuilder

getName()

public 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 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 BucketOperation.ObjectConfigurationCase getObjectConfigurationCase()
Returns
Type Description
BucketOperation.ObjectConfigurationCase

getPrefixList()

public PrefixList getPrefixList()

Specifies objects matching a prefix set.

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

Returns
Type Description
PrefixList

The prefixList.

getPrefixListBuilder()

public PrefixList.Builder getPrefixListBuilder()

Specifies objects matching a prefix set.

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

Returns
Type Description
PrefixList.Builder

getPrefixListOrBuilder()

public PrefixListOrBuilder getPrefixListOrBuilder()

Specifies objects matching a prefix set.

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

Returns
Type Description
PrefixListOrBuilder

getPutMetadata()

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

getPutMetadataBuilder()

public PutMetadata.Builder getPutMetadataBuilder()

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.Builder

getPutMetadataOrBuilder()

public 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 PutObjectHold getPutObjectHold()

Changes object hold status.

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

Returns
Type Description
PutObjectHold

The putObjectHold.

getPutObjectHoldBuilder()

public PutObjectHold.Builder getPutObjectHoldBuilder()

Changes object hold status.

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

Returns
Type Description
PutObjectHold.Builder

getPutObjectHoldOrBuilder()

public PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()

Changes object hold status.

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

Returns
Type Description
PutObjectHoldOrBuilder

getRewriteObject()

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

getRewriteObjectBuilder()

public RewriteObject.Builder getRewriteObjectBuilder()

Rewrite the object and updates metadata like KMS key.

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

Returns
Type Description
RewriteObject.Builder

getRewriteObjectOrBuilder()

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

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The time that the BucketOperation was started.

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

Returns
Type Description
Builder

getStartTimeOrBuilder()

public 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 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 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 BucketOperation.TransformationCase getTransformationCase()
Returns
Type Description
BucketOperation.TransformationCase

hasCompleteTime()

public 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 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 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 boolean hasDeleteObject()

Delete objects.

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

Returns
Type Description
boolean

Whether the deleteObject field is set.

hasManifest()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompleteTime(Timestamp value)

public BucketOperation.Builder mergeCompleteTime(Timestamp value)

Output only. The time that the BucketOperation was completed.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

mergeCounters(Counters value)

public BucketOperation.Builder mergeCounters(Counters value)

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

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

Parameter
Name Description
value Counters
Returns
Type Description
BucketOperation.Builder

mergeCreateTime(Timestamp value)

public BucketOperation.Builder mergeCreateTime(Timestamp value)

Output only. The time that the BucketOperation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

mergeDeleteObject(DeleteObject value)

public BucketOperation.Builder mergeDeleteObject(DeleteObject value)

Delete objects.

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

Parameter
Name Description
value DeleteObject
Returns
Type Description
BucketOperation.Builder

mergeFrom(BucketOperation other)

public BucketOperation.Builder mergeFrom(BucketOperation other)
Parameter
Name Description
other BucketOperation
Returns
Type Description
BucketOperation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BucketOperation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BucketOperation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BucketOperation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BucketOperation.Builder
Overrides

mergeManifest(Manifest value)

public BucketOperation.Builder mergeManifest(Manifest value)

Specifies objects in a manifest file.

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

Parameter
Name Description
value Manifest
Returns
Type Description
BucketOperation.Builder

mergePrefixList(PrefixList value)

public BucketOperation.Builder mergePrefixList(PrefixList value)

Specifies objects matching a prefix set.

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

Parameter
Name Description
value PrefixList
Returns
Type Description
BucketOperation.Builder

mergePutMetadata(PutMetadata value)

public BucketOperation.Builder mergePutMetadata(PutMetadata value)

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;

Parameter
Name Description
value PutMetadata
Returns
Type Description
BucketOperation.Builder

mergePutObjectHold(PutObjectHold value)

public BucketOperation.Builder mergePutObjectHold(PutObjectHold value)

Changes object hold status.

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

Parameter
Name Description
value PutObjectHold
Returns
Type Description
BucketOperation.Builder

mergeRewriteObject(RewriteObject value)

public BucketOperation.Builder mergeRewriteObject(RewriteObject value)

Rewrite the object and updates metadata like KMS key.

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

Parameter
Name Description
value RewriteObject
Returns
Type Description
BucketOperation.Builder

mergeStartTime(Timestamp value)

public BucketOperation.Builder mergeStartTime(Timestamp value)

Output only. The time that the BucketOperation was started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

removeErrorSummaries(int index)

public BucketOperation.Builder removeErrorSummaries(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
BucketOperation.Builder

setBucketName(String value)

public BucketOperation.Builder setBucketName(String value)

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

string bucket_name = 2;

Parameter
Name Description
value String

The bucketName to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

setBucketNameBytes(ByteString value)

public BucketOperation.Builder setBucketNameBytes(ByteString value)

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

string bucket_name = 2;

Parameter
Name Description
value ByteString

The bytes for bucketName to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

setCompleteTime(Timestamp value)

public BucketOperation.Builder setCompleteTime(Timestamp value)

Output only. The time that the BucketOperation was completed.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

setCompleteTime(Timestamp.Builder builderForValue)

public BucketOperation.Builder setCompleteTime(Timestamp.Builder builderForValue)

Output only. The time that the BucketOperation was completed.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BucketOperation.Builder

setCounters(Counters value)

public BucketOperation.Builder setCounters(Counters value)

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

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

Parameter
Name Description
value Counters
Returns
Type Description
BucketOperation.Builder

setCounters(Counters.Builder builderForValue)

public BucketOperation.Builder setCounters(Counters.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Counters.Builder
Returns
Type Description
BucketOperation.Builder

setCreateTime(Timestamp value)

public BucketOperation.Builder setCreateTime(Timestamp value)

Output only. The time that the BucketOperation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BucketOperation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time that the BucketOperation was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BucketOperation.Builder

setDeleteObject(DeleteObject value)

public BucketOperation.Builder setDeleteObject(DeleteObject value)

Delete objects.

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

Parameter
Name Description
value DeleteObject
Returns
Type Description
BucketOperation.Builder

setDeleteObject(DeleteObject.Builder builderForValue)

public BucketOperation.Builder setDeleteObject(DeleteObject.Builder builderForValue)

Delete objects.

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

Parameter
Name Description
builderForValue DeleteObject.Builder
Returns
Type Description
BucketOperation.Builder

setErrorSummaries(int index, ErrorSummary value)

public BucketOperation.Builder setErrorSummaries(int index, ErrorSummary value)

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];

Parameters
Name Description
index int
value ErrorSummary
Returns
Type Description
BucketOperation.Builder

setErrorSummaries(int index, ErrorSummary.Builder builderForValue)

public BucketOperation.Builder setErrorSummaries(int index, ErrorSummary.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue ErrorSummary.Builder
Returns
Type Description
BucketOperation.Builder

setManifest(Manifest value)

public BucketOperation.Builder setManifest(Manifest value)

Specifies objects in a manifest file.

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

Parameter
Name Description
value Manifest
Returns
Type Description
BucketOperation.Builder

setManifest(Manifest.Builder builderForValue)

public BucketOperation.Builder setManifest(Manifest.Builder builderForValue)

Specifies objects in a manifest file.

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

Parameter
Name Description
builderForValue Manifest.Builder
Returns
Type Description
BucketOperation.Builder

setName(String value)

public BucketOperation.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BucketOperation.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

setPrefixList(PrefixList value)

public BucketOperation.Builder setPrefixList(PrefixList value)

Specifies objects matching a prefix set.

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

Parameter
Name Description
value PrefixList
Returns
Type Description
BucketOperation.Builder

setPrefixList(PrefixList.Builder builderForValue)

public BucketOperation.Builder setPrefixList(PrefixList.Builder builderForValue)

Specifies objects matching a prefix set.

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

Parameter
Name Description
builderForValue PrefixList.Builder
Returns
Type Description
BucketOperation.Builder

setPutMetadata(PutMetadata value)

public BucketOperation.Builder setPutMetadata(PutMetadata value)

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;

Parameter
Name Description
value PutMetadata
Returns
Type Description
BucketOperation.Builder

setPutMetadata(PutMetadata.Builder builderForValue)

public BucketOperation.Builder setPutMetadata(PutMetadata.Builder builderForValue)

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;

Parameter
Name Description
builderForValue PutMetadata.Builder
Returns
Type Description
BucketOperation.Builder

setPutObjectHold(PutObjectHold value)

public BucketOperation.Builder setPutObjectHold(PutObjectHold value)

Changes object hold status.

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

Parameter
Name Description
value PutObjectHold
Returns
Type Description
BucketOperation.Builder

setPutObjectHold(PutObjectHold.Builder builderForValue)

public BucketOperation.Builder setPutObjectHold(PutObjectHold.Builder builderForValue)

Changes object hold status.

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

Parameter
Name Description
builderForValue PutObjectHold.Builder
Returns
Type Description
BucketOperation.Builder

setRewriteObject(RewriteObject value)

public BucketOperation.Builder setRewriteObject(RewriteObject value)

Rewrite the object and updates metadata like KMS key.

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

Parameter
Name Description
value RewriteObject
Returns
Type Description
BucketOperation.Builder

setRewriteObject(RewriteObject.Builder builderForValue)

public BucketOperation.Builder setRewriteObject(RewriteObject.Builder builderForValue)

Rewrite the object and updates metadata like KMS key.

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

Parameter
Name Description
builderForValue RewriteObject.Builder
Returns
Type Description
BucketOperation.Builder

setStartTime(Timestamp value)

public BucketOperation.Builder setStartTime(Timestamp value)

Output only. The time that the BucketOperation was started.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
BucketOperation.Builder

setStartTime(Timestamp.Builder builderForValue)

public BucketOperation.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. The time that the BucketOperation was started.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BucketOperation.Builder

setState(BucketOperation.State value)

public BucketOperation.Builder setState(BucketOperation.State value)

Output only. State of the BucketOperation.

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

Parameter
Name Description
value BucketOperation.State

The state to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.

setStateValue(int value)

public BucketOperation.Builder setStateValue(int value)

Output only. State of the BucketOperation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
BucketOperation.Builder

This builder for chaining.