public interface JobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBucketList()
public abstract 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. |
getBucketListOrBuilder()
public abstract 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 abstract 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. |
getCompleteTimeOrBuilder()
public abstract 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 abstract 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. |
getCountersOrBuilder()
public abstract 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 abstract 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. |
getCreateTimeOrBuilder()
public abstract 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 |
|
getDeleteObject()
public abstract DeleteObject getDeleteObject()Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
| Returns | |
|---|---|
| Type | Description |
DeleteObject |
The deleteObject. |
getDeleteObjectOrBuilder()
public abstract DeleteObjectOrBuilder getDeleteObjectOrBuilder()Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
| Returns | |
|---|---|
| Type | Description |
DeleteObjectOrBuilder |
|
getDescription()
public abstract 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 abstract 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. |
getErrorSummaries(int index)
public abstract ErrorSummary getErrorSummaries(int index)Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ErrorSummary |
|
getErrorSummariesCount()
public abstract int getErrorSummariesCount()Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getErrorSummariesList()
public abstract List<ErrorSummary> getErrorSummariesList()Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<ErrorSummary> |
|
getErrorSummariesOrBuilder(int index)
public abstract ErrorSummaryOrBuilder getErrorSummariesOrBuilder(int index)Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ErrorSummaryOrBuilder |
|
getErrorSummariesOrBuilderList()
public abstract List<? extends ErrorSummaryOrBuilder> getErrorSummariesOrBuilderList()Output only. Summarizes errors encountered with sample error log entries.
repeated .google.cloud.storagebatchoperations.v1.ErrorSummary error_summaries = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.storagebatchoperations.v1.ErrorSummaryOrBuilder> |
|
getLoggingConfig()
public abstract LoggingConfig getLoggingConfig()Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LoggingConfig |
The loggingConfig. |
getLoggingConfigOrBuilder()
public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
LoggingConfigOrBuilder |
|
getName()
public abstract 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 abstract 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 abstract PutMetadata getPutMetadata()Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 8;
| Returns | |
|---|---|
| Type | Description |
PutMetadata |
The putMetadata. |
getPutMetadataOrBuilder()
public abstract PutMetadataOrBuilder getPutMetadataOrBuilder()Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 8;
| Returns | |
|---|---|
| Type | Description |
PutMetadataOrBuilder |
|
getPutObjectHold()
public abstract PutObjectHold getPutObjectHold()Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
| Returns | |
|---|---|
| Type | Description |
PutObjectHold |
The putObjectHold. |
getPutObjectHoldOrBuilder()
public abstract PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
| Returns | |
|---|---|
| Type | Description |
PutObjectHoldOrBuilder |
|
getRewriteObject()
public abstract RewriteObject getRewriteObject()Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
| Returns | |
|---|---|
| Type | Description |
RewriteObject |
The rewriteObject. |
getRewriteObjectOrBuilder()
public abstract RewriteObjectOrBuilder getRewriteObjectOrBuilder()Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
| Returns | |
|---|---|
| Type | Description |
RewriteObjectOrBuilder |
|
getScheduleTime()
public abstract 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. |
getScheduleTimeOrBuilder()
public abstract 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 abstract Job.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
Job.SourceCase |
|
getState()
public abstract 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 abstract 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 abstract Job.TransformationCase getTransformationCase()| Returns | |
|---|---|
| Type | Description |
Job.TransformationCase |
|
hasBucketList()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasDeleteObject()Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the deleteObject field is set. |
hasLoggingConfig()
public abstract 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 abstract boolean hasPutMetadata()Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
.google.cloud.storagebatchoperations.v1.PutMetadata put_metadata = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the putMetadata field is set. |
hasPutObjectHold()
public abstract boolean hasPutObjectHold()Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the putObjectHold field is set. |
hasRewriteObject()
public abstract boolean hasRewriteObject()Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rewriteObject field is set. |
hasScheduleTime()
public abstract 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. |