public final class BucketOperation extends GeneratedMessage implements BucketOperationOrBuilder
BucketOperation represents a bucket-level breakdown of a Job.
Protobuf type google.cloud.storagebatchoperations.v1.BucketOperation
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
BUCKET_NAME_FIELD_NUMBER
public static final int BUCKET_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMPLETE_TIME_FIELD_NUMBER
public static final int COMPLETE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COUNTERS_FIELD_NUMBER
public static final int COUNTERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DELETE_OBJECT_FIELD_NUMBER
public static final int DELETE_OBJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_SUMMARIES_FIELD_NUMBER
public static final int ERROR_SUMMARIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MANIFEST_FIELD_NUMBER
public static final int MANIFEST_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREFIX_LIST_FIELD_NUMBER
public static final int PREFIX_LIST_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PUT_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PUT_OBJECT_HOLD_FIELD_NUMBER
public static final int PUT_OBJECT_HOLD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REWRITE_OBJECT_FIELD_NUMBER
public static final int REWRITE_OBJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BucketOperation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BucketOperation.Builder newBuilder()
newBuilder(BucketOperation prototype)
public static BucketOperation.Builder newBuilder(BucketOperation prototype)
public static BucketOperation parseDelimitedFrom(InputStream input)
public static BucketOperation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BucketOperation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BucketOperation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BucketOperation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BucketOperation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BucketOperation parseFrom(CodedInputStream input)
public static BucketOperation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BucketOperation parseFrom(InputStream input)
public static BucketOperation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BucketOperation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BucketOperation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BucketOperation> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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];
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.
|
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];
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.
|
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];
getDefaultInstanceForType()
public BucketOperation getDefaultInstanceForType()
getDeleteObject()
public DeleteObject getDeleteObject()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 12;
getDeleteObjectOrBuilder()
public DeleteObjectOrBuilder getDeleteObjectOrBuilder()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 12;
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
|
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];
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
|
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.
|
getManifestOrBuilder()
public ManifestOrBuilder getManifestOrBuilder()
Specifies objects in a manifest file.
.google.cloud.storagebatchoperations.v1.Manifest manifest = 4;
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()
getParserForType()
public Parser<BucketOperation> getParserForType()
Overrides
getPrefixList()
public PrefixList getPrefixList()
Specifies objects matching a prefix set.
.google.cloud.storagebatchoperations.v1.PrefixList prefix_list = 3;
| Returns |
| Type |
Description |
PrefixList |
The prefixList.
|
getPrefixListOrBuilder()
public PrefixListOrBuilder getPrefixListOrBuilder()
Specifies objects matching a prefix set.
.google.cloud.storagebatchoperations.v1.PrefixList prefix_list = 3;
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;
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;
getPutObjectHold()
public PutObjectHold getPutObjectHold()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 11;
getPutObjectHoldOrBuilder()
public PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 11;
getRewriteObject()
public RewriteObject getRewriteObject()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 14;
getRewriteObjectOrBuilder()
public RewriteObjectOrBuilder getRewriteObjectOrBuilder()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 14;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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];
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];
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.
|
public BucketOperation.TransformationCase getTransformationCase()
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BucketOperation.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected BucketOperation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public BucketOperation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides