public static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilder
The Storage Batch Operations Job description.
Protobuf type google.cloud.storagebatchoperations.v1.Job
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Job.BuilderImplements
JobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllErrorSummaries(Iterable<? extends ErrorSummary> values)
public Job.Builder addAllErrorSummaries(Iterable<? extends ErrorSummary> values)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.storagebatchoperations.v1.ErrorSummary> |
Returns | |
---|---|
Type | Description |
Job.Builder |
addErrorSummaries(ErrorSummary value)
public Job.Builder addErrorSummaries(ErrorSummary value)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ErrorSummary |
Returns | |
---|---|
Type | Description |
Job.Builder |
addErrorSummaries(ErrorSummary.Builder builderForValue)
public Job.Builder addErrorSummaries(ErrorSummary.Builder builderForValue)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
ErrorSummary.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addErrorSummaries(int index, ErrorSummary value)
public Job.Builder addErrorSummaries(int index, ErrorSummary value)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ErrorSummary |
Returns | |
---|---|
Type | Description |
Job.Builder |
addErrorSummaries(int index, ErrorSummary.Builder builderForValue)
public Job.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ErrorSummary.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
addErrorSummariesBuilder()
public ErrorSummary.Builder addErrorSummariesBuilder()
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
ErrorSummary.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
build()
public Job build()
Returns | |
---|---|
Type | Description |
Job |
buildPartial()
public Job buildPartial()
Returns | |
---|---|
Type | Description |
Job |
clear()
public Job.Builder clear()
Returns | |
---|---|
Type | Description |
Job.Builder |
clearBucketList()
public Job.Builder clearBucketList()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearCompleteTime()
public Job.Builder clearCompleteTime()
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearCounters()
public Job.Builder clearCounters()
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearCreateTime()
public Job.Builder clearCreateTime()
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearDeleteObject()
public Job.Builder clearDeleteObject()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearDescription()
public Job.Builder clearDescription()
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
clearErrorSummaries()
public Job.Builder clearErrorSummaries()
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearField(Descriptors.FieldDescriptor field)
public Job.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Job.Builder |
clearLoggingConfig()
public Job.Builder clearLoggingConfig()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearName()
public Job.Builder clearName()
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Job.Builder |
clearPutMetadata()
public Job.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 = 8;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearPutObjectHold()
public Job.Builder clearPutObjectHold()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearRewriteObject()
public Job.Builder clearRewriteObject()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
Returns | |
---|---|
Type | Description |
Job.Builder |
clearScheduleTime()
public Job.Builder clearScheduleTime()
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
clearSource()
public Job.Builder clearSource()
Returns | |
---|---|
Type | Description |
Job.Builder |
clearState()
public Job.Builder clearState()
Output only. State of the job.
.google.cloud.storagebatchoperations.v1.Job.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
clearTransformation()
public Job.Builder clearTransformation()
Returns | |
---|---|
Type | Description |
Job.Builder |
clone()
public Job.Builder clone()
Returns | |
---|---|
Type | Description |
Job.Builder |
getBucketList()
public BucketList getBucketList()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Returns | |
---|---|
Type | Description |
BucketList |
The bucketList. |
getBucketListBuilder()
public BucketList.Builder getBucketListBuilder()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Returns | |
---|---|
Type | Description |
BucketList.Builder |
getBucketListOrBuilder()
public BucketListOrBuilder getBucketListOrBuilder()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Returns | |
---|---|
Type | Description |
BucketListOrBuilder |
getCompleteTime()
public Timestamp getCompleteTime()
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The completeTime. |
getCompleteTimeBuilder()
public Timestamp.Builder getCompleteTimeBuilder()
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCompleteTimeOrBuilder()
public TimestampOrBuilder getCompleteTimeOrBuilder()
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getCounters()
public Counters getCounters()
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.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 job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Counters.Builder |
getCountersOrBuilder()
public CountersOrBuilder getCountersOrBuilder()
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
CountersOrBuilder |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Job |
getDeleteObject()
public DeleteObject getDeleteObject()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Returns | |
---|---|
Type | Description |
DeleteObject |
The deleteObject. |
getDeleteObjectBuilder()
public DeleteObject.Builder getDeleteObjectBuilder()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Returns | |
---|---|
Type | Description |
DeleteObject.Builder |
getDeleteObjectOrBuilder()
public DeleteObjectOrBuilder getDeleteObjectOrBuilder()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Returns | |
---|---|
Type | Description |
DeleteObjectOrBuilder |
getDescription()
public String getDescription()
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.storagebatchoperations.v1.ErrorSummaryOrBuilder> |
getLoggingConfig()
public LoggingConfig getLoggingConfig()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
LoggingConfig |
The loggingConfig. |
getLoggingConfigBuilder()
public LoggingConfig.Builder getLoggingConfigBuilder()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
LoggingConfig.Builder |
getLoggingConfigOrBuilder()
public LoggingConfigOrBuilder getLoggingConfigOrBuilder()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
LoggingConfigOrBuilder |
getName()
public String getName()
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
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 = 8;
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 = 8;
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 = 8;
Returns | |
---|---|
Type | Description |
PutMetadataOrBuilder |
getPutObjectHold()
public PutObjectHold getPutObjectHold()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Returns | |
---|---|
Type | Description |
PutObjectHold |
The putObjectHold. |
getPutObjectHoldBuilder()
public PutObjectHold.Builder getPutObjectHoldBuilder()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Returns | |
---|---|
Type | Description |
PutObjectHold.Builder |
getPutObjectHoldOrBuilder()
public PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Returns | |
---|---|
Type | Description |
PutObjectHoldOrBuilder |
getRewriteObject()
public RewriteObject getRewriteObject()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
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 = 20;
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 = 20;
Returns | |
---|---|
Type | Description |
RewriteObjectOrBuilder |
getScheduleTime()
public Timestamp getScheduleTime()
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The scheduleTime. |
getScheduleTimeBuilder()
public Timestamp.Builder getScheduleTimeBuilder()
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getScheduleTimeOrBuilder()
public TimestampOrBuilder getScheduleTimeOrBuilder()
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getSourceCase()
public Job.SourceCase getSourceCase()
Returns | |
---|---|
Type | Description |
Job.SourceCase |
getState()
public Job.State getState()
Output only. State of the job.
.google.cloud.storagebatchoperations.v1.Job.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Job.State |
The state. |
getStateValue()
public int getStateValue()
Output only. State of the job.
.google.cloud.storagebatchoperations.v1.Job.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
getTransformationCase()
public Job.TransformationCase getTransformationCase()
Returns | |
---|---|
Type | Description |
Job.TransformationCase |
hasBucketList()
public boolean hasBucketList()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Returns | |
---|---|
Type | Description |
boolean |
Whether the bucketList field is set. |
hasCompleteTime()
public boolean hasCompleteTime()
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.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 job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.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 job was created.
.google.protobuf.Timestamp create_time = 10 [(.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 = 6;
Returns | |
---|---|
Type | Description |
boolean |
Whether the deleteObject field is set. |
hasLoggingConfig()
public boolean hasLoggingConfig()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the loggingConfig 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 = 8;
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 = 5;
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 = 20;
Returns | |
---|---|
Type | Description |
boolean |
Whether the rewriteObject field is set. |
hasScheduleTime()
public boolean hasScheduleTime()
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the scheduleTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeBucketList(BucketList value)
public Job.Builder mergeBucketList(BucketList value)
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Parameter | |
---|---|
Name | Description |
value |
BucketList |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeCompleteTime(Timestamp value)
public Job.Builder mergeCompleteTime(Timestamp value)
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeCounters(Counters value)
public Job.Builder mergeCounters(Counters value)
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Counters |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeCreateTime(Timestamp value)
public Job.Builder mergeCreateTime(Timestamp value)
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeDeleteObject(DeleteObject value)
public Job.Builder mergeDeleteObject(DeleteObject value)
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Parameter | |
---|---|
Name | Description |
value |
DeleteObject |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeFrom(Job other)
public Job.Builder mergeFrom(Job other)
Parameter | |
---|---|
Name | Description |
other |
Job |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Job.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Job.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeLoggingConfig(LoggingConfig value)
public Job.Builder mergeLoggingConfig(LoggingConfig value)
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
LoggingConfig |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergePutMetadata(PutMetadata value)
public Job.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 = 8;
Parameter | |
---|---|
Name | Description |
value |
PutMetadata |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergePutObjectHold(PutObjectHold value)
public Job.Builder mergePutObjectHold(PutObjectHold value)
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Parameter | |
---|---|
Name | Description |
value |
PutObjectHold |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeRewriteObject(RewriteObject value)
public Job.Builder mergeRewriteObject(RewriteObject value)
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
Parameter | |
---|---|
Name | Description |
value |
RewriteObject |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeScheduleTime(Timestamp value)
public Job.Builder mergeScheduleTime(Timestamp value)
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Job.Builder |
removeErrorSummaries(int index)
public Job.Builder removeErrorSummaries(int index)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Job.Builder |
setBucketList(BucketList value)
public Job.Builder setBucketList(BucketList value)
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Parameter | |
---|---|
Name | Description |
value |
BucketList |
Returns | |
---|---|
Type | Description |
Job.Builder |
setBucketList(BucketList.Builder builderForValue)
public Job.Builder setBucketList(BucketList.Builder builderForValue)
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
Parameter | |
---|---|
Name | Description |
builderForValue |
BucketList.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCompleteTime(Timestamp value)
public Job.Builder setCompleteTime(Timestamp value)
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCompleteTime(Timestamp.Builder builderForValue)
public Job.Builder setCompleteTime(Timestamp.Builder builderForValue)
Output only. The time that the job was completed.
.google.protobuf.Timestamp complete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCounters(Counters value)
public Job.Builder setCounters(Counters value)
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Counters |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCounters(Counters.Builder builderForValue)
public Job.Builder setCounters(Counters.Builder builderForValue)
Output only. Information about the progress of the job.
.google.cloud.storagebatchoperations.v1.Counters counters = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Counters.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCreateTime(Timestamp value)
public Job.Builder setCreateTime(Timestamp value)
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Job.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time that the job was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setDeleteObject(DeleteObject value)
public Job.Builder setDeleteObject(DeleteObject value)
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Parameter | |
---|---|
Name | Description |
value |
DeleteObject |
Returns | |
---|---|
Type | Description |
Job.Builder |
setDeleteObject(DeleteObject.Builder builderForValue)
public Job.Builder setDeleteObject(DeleteObject.Builder builderForValue)
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
Parameter | |
---|---|
Name | Description |
builderForValue |
DeleteObject.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setDescription(String value)
public Job.Builder setDescription(String value)
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Job.Builder setDescriptionBytes(ByteString value)
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setErrorSummaries(int index, ErrorSummary value)
public Job.Builder setErrorSummaries(int index, ErrorSummary value)
Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
ErrorSummary |
Returns | |
---|---|
Type | Description |
Job.Builder |
setErrorSummaries(int index, ErrorSummary.Builder builderForValue)
public Job.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 = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
ErrorSummary.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
setLoggingConfig(LoggingConfig value)
public Job.Builder setLoggingConfig(LoggingConfig value)
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
LoggingConfig |
Returns | |
---|---|
Type | Description |
Job.Builder |
setLoggingConfig(LoggingConfig.Builder builderForValue)
public Job.Builder setLoggingConfig(LoggingConfig.Builder builderForValue)
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
LoggingConfig.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setName(String value)
public Job.Builder setName(String value)
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Job.Builder setNameBytes(ByteString value)
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setPutMetadata(PutMetadata value)
public Job.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 = 8;
Parameter | |
---|---|
Name | Description |
value |
PutMetadata |
Returns | |
---|---|
Type | Description |
Job.Builder |
setPutMetadata(PutMetadata.Builder builderForValue)
public Job.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 = 8;
Parameter | |
---|---|
Name | Description |
builderForValue |
PutMetadata.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setPutObjectHold(PutObjectHold value)
public Job.Builder setPutObjectHold(PutObjectHold value)
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Parameter | |
---|---|
Name | Description |
value |
PutObjectHold |
Returns | |
---|---|
Type | Description |
Job.Builder |
setPutObjectHold(PutObjectHold.Builder builderForValue)
public Job.Builder setPutObjectHold(PutObjectHold.Builder builderForValue)
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
Parameter | |
---|---|
Name | Description |
builderForValue |
PutObjectHold.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Job.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Job.Builder |
setRewriteObject(RewriteObject value)
public Job.Builder setRewriteObject(RewriteObject value)
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
Parameter | |
---|---|
Name | Description |
value |
RewriteObject |
Returns | |
---|---|
Type | Description |
Job.Builder |
setRewriteObject(RewriteObject.Builder builderForValue)
public Job.Builder setRewriteObject(RewriteObject.Builder builderForValue)
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
Parameter | |
---|---|
Name | Description |
builderForValue |
RewriteObject.Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setScheduleTime(Timestamp value)
public Job.Builder setScheduleTime(Timestamp value)
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Job.Builder |
setScheduleTime(Timestamp.Builder builderForValue)
public Job.Builder setScheduleTime(Timestamp.Builder builderForValue)
Output only. The time that the job was scheduled.
.google.protobuf.Timestamp schedule_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Job.Builder |
setState(Job.State value)
public Job.Builder setState(Job.State value)
Output only. State of the job.
.google.cloud.storagebatchoperations.v1.Job.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Job.State The state to set. |
Returns | |
---|---|
Type | Description |
Job.Builder |
This builder for chaining. |
setStateValue(int value)
public Job.Builder setStateValue(int value)
Output only. State of the job.
.google.cloud.storagebatchoperations.v1.Job.State state = 15 [(.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 |
Job.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Job.Builder |