Class Job (1.46.0) 

public final class Job extends GeneratedMessageV3 implements JobOrBuilder

A job represents an instance of a task.

Protobuf type google.cloud.dataplex.v1.Job

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Job

Implements

JobOrBuilder

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_SPEC_FIELD_NUMBER

public static final int EXECUTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RETRY_COUNT_FIELD_NUMBER

public static final int RETRY_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_JOB_FIELD_NUMBER

public static final int SERVICE_JOB_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

TRIGGER_FIELD_NUMBER

public static final int TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_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()
Returns
Type Description
Descriptor

newBuilder()

public static Job.Builder newBuilder()
Returns
Type Description
Job.Builder

newBuilder(Job prototype)

public static Job.Builder newBuilder(Job prototype)
Parameter
Name Description
prototype Job
Returns
Type Description
Job.Builder

parseDelimitedFrom(InputStream input)

public static Job parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Job parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Job parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Job parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Job parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Job parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Job
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Job> parser()
Returns
Type Description
Parser<Job>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Output only. User-defined labels for the task.

map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Job getDefaultInstanceForType()
Returns
Type Description
Job

getEndTime()

public Timestamp getEndTime()

Output only. The time when the job ended.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time when the job ended.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getExecutionSpec()

public Task.ExecutionSpec getExecutionSpec()

Output only. Spec related to how a task is executed.

.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Task.ExecutionSpec

The executionSpec.

getExecutionSpecOrBuilder()

public Task.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()

Output only. Spec related to how a task is executed.

.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Task.ExecutionSpecOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Output only. User-defined labels for the task.

map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Output only. User-defined labels for the task.

map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Output only. User-defined labels for the task.

map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Output only. User-defined labels for the task.

map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
String

getMessage()

public String getMessage()

Output only. Additional information about the current state.

string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Output only. Additional information about the current state.

string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for message.

getName()

public String getName()

Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Job> getParserForType()
Returns
Type Description
Parser<Job>
Overrides

getRetryCount()

public int getRetryCount()

Output only. The number of times the job has been retried (excluding the initial attempt).

uint32 retry_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The retryCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getService()

public Job.Service getService()

Output only. The underlying service running a job.

.google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Job.Service

The service.

getServiceJob()

public String getServiceJob()

Output only. The full resource name for the job run under a particular service.

string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The serviceJob.

getServiceJobBytes()

public ByteString getServiceJobBytes()

Output only. The full resource name for the job run under a particular service.

string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for serviceJob.

getServiceValue()

public int getServiceValue()

Output only. The underlying service running a job.

.google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for service.

getStartTime()

public Timestamp getStartTime()

Output only. The time when the job was started.

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

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The time when the job was started.

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

Returns
Type Description
TimestampOrBuilder

getState()

public Job.State getState()

Output only. Execution state for the job.

.google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Job.State

The state.

getStateValue()

public int getStateValue()

Output only. Execution state for the job.

.google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTrigger()

public Job.Trigger getTrigger()

Output only. Job execution trigger.

.google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Job.Trigger

The trigger.

getTriggerValue()

public int getTriggerValue()

Output only. Job execution trigger.

.google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for trigger.

getUid()

public String getUid()

Output only. System generated globally unique ID for the job.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System generated globally unique ID for the job.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

hasEndTime()

public boolean hasEndTime()

Output only. The time when the job ended.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasExecutionSpec()

public boolean hasExecutionSpec()

Output only. Spec related to how a task is executed.

.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the executionSpec field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The time when the job was started.

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

Returns
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Job.Builder newBuilderForType()
Returns
Type Description
Job.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Job.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Job.Builder toBuilder()
Returns
Type Description
Job.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException