public final class Job extends GeneratedMessage implements JobOrBuilder
The Storage Batch Operations Job description.
Protobuf type google.cloud.storagebatchoperations.v1.Job
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_LIST_FIELD_NUMBER
public static final int BUCKET_LIST_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 |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DRY_RUN_FIELD_NUMBER
public static final int DRY_RUN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ERROR_SUMMARIES_FIELD_NUMBER
public static final int ERROR_SUMMARIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOGGING_CONFIG_FIELD_NUMBER
public static final int LOGGING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_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 |
|
SCHEDULE_TIME_FIELD_NUMBER
public static final int SCHEDULE_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 Job getDefaultInstance()
| Returns |
| Type |
Description |
Job |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Job.Builder newBuilder()
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
| Parameter |
| Name |
Description |
prototype |
Job
|
public static Job parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Job |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(InputStream input)
| Returns |
| Type |
Description |
Job |
|
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Job |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Job |
|
parser()
public static Parser<Job> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
getBucketListOrBuilder()
public BucketListOrBuilder getBucketListOrBuilder()
Specifies a list of buckets and their objects to be transformed.
.google.cloud.storagebatchoperations.v1.BucketList bucket_list = 19;
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.
|
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];
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.
|
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];
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.
|
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];
getDefaultInstanceForType()
public Job getDefaultInstanceForType()
| Returns |
| Type |
Description |
Job |
|
getDeleteObject()
public DeleteObject getDeleteObject()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
getDeleteObjectOrBuilder()
public DeleteObjectOrBuilder getDeleteObjectOrBuilder()
Delete objects.
.google.cloud.storagebatchoperations.v1.DeleteObject delete_object = 6;
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.
|
getDryRun()
public boolean getDryRun()
Optional. If true, the job will run in dry run mode, returning the total
object count and, if the object configuration is a prefix list, the bytes
found from source. No transformations will be performed.
bool dry_run = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The dryRun.
|
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
|
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];
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
|
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];
getLoggingConfigOrBuilder()
public LoggingConfigOrBuilder getLoggingConfigOrBuilder()
Optional. Logging configuration.
.google.cloud.storagebatchoperations.v1.LoggingConfig logging_config = 9 [(.google.api.field_behavior) = OPTIONAL];
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.
|
getParserForType()
public Parser<Job> getParserForType()
Overrides
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;
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;
getPutObjectHold()
public PutObjectHold getPutObjectHold()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
getPutObjectHoldOrBuilder()
public PutObjectHoldOrBuilder getPutObjectHoldOrBuilder()
Changes object hold status.
.google.cloud.storagebatchoperations.v1.PutObjectHold put_object_hold = 5;
getRewriteObject()
public RewriteObject getRewriteObject()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
getRewriteObjectOrBuilder()
public RewriteObjectOrBuilder getRewriteObjectOrBuilder()
Rewrite the object and updates metadata like KMS key.
.google.cloud.storagebatchoperations.v1.RewriteObject rewrite_object = 20;
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.
|
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSourceCase()
public Job.SourceCase getSourceCase()
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.
|
public Job.TransformationCase getTransformationCase()
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Job.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Job.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Job.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides