Package com.google.cloud.dataplex.v1

Class Job

  • All Implemented Interfaces:
    JobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Job
extends com.google.protobuf.GeneratedMessageV3
implements JobOrBuilder
     A job represents an instance of a task.
    Protobuf type google.cloud.dataplex.v1.Job
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getName in interface JobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getNameBytes in interface JobOrBuilder
        Returns:
        The bytes for name.

      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the job.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface JobOrBuilder
        Returns:
        The uid.

      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the job.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface JobOrBuilder
        Returns:
        The bytes for uid.

      • 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];
        Specified by:
        hasStartTime in interface JobOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Output only. The time when the job was started.
        .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTime in interface JobOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. The time when the job was started.
        .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface JobOrBuilder

      • hasEndTime

        public boolean hasEndTime()
         Output only. The time when the job ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEndTime in interface JobOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         Output only. The time when the job ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTime in interface JobOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. The time when the job ended.
        .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEndTimeOrBuilder in interface JobOrBuilder

      • 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];
        Specified by:
        getStateValue in interface JobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface JobOrBuilder
        Returns:
        The state.

      • 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];
        Specified by:
        getRetryCount in interface JobOrBuilder
        Returns:
        The retryCount.

      • 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];
        Specified by:
        getServiceValue in interface JobOrBuilder
        Returns:
        The enum numeric value on the wire for service.

      • 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];
        Specified by:
        getService in interface JobOrBuilder
        Returns:
        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];
        Specified by:
        getServiceJob in interface JobOrBuilder
        Returns:
        The serviceJob.

      • getServiceJobBytes

        public com.google.protobuf.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];
        Specified by:
        getServiceJobBytes in interface JobOrBuilder
        Returns:
        The bytes for serviceJob.

      • getMessage

        public String getMessage()
         Output only. Additional information about the current state.
        string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMessage in interface JobOrBuilder
        Returns:
        The message.

      • getMessageBytes

        public com.google.protobuf.ByteString getMessageBytes()
         Output only. Additional information about the current state.
        string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMessageBytes in interface JobOrBuilder
        Returns:
        The bytes for message.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: JobOrBuilder
         Output only. User-defined labels for the task.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLabelsCount in interface JobOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         Output only. User-defined labels for the task.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        containsLabels in interface JobOrBuilder

      • 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];
        Specified by:
        getLabelsMap in interface JobOrBuilder

      • getLabelsOrDefault

        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];
        Specified by:
        getLabelsOrDefault in interface JobOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Output only. User-defined labels for the task.
        map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLabelsOrThrow in interface JobOrBuilder

      • getTriggerValue

        public int getTriggerValue()
         Output only. Job execution trigger.
        .google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTriggerValue in interface JobOrBuilder
        Returns:
        The enum numeric value on the wire for trigger.

      • getTrigger

        public Job.Trigger getTrigger()
         Output only. Job execution trigger.
        .google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTrigger in interface JobOrBuilder
        Returns:
        The trigger.

      • 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];
        Specified by:
        hasExecutionSpec in interface JobOrBuilder
        Returns:
        Whether the executionSpec field is set.

      • 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];
        Specified by:
        getExecutionSpec in interface JobOrBuilder
        Returns:
        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];
        Specified by:
        getExecutionSpecOrBuilder in interface JobOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Job parseFrom​(ByteBuffer data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(ByteBuffer data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.ByteString data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.ByteString data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(byte[] data)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Job parseFrom​(byte[] data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseDelimitedFrom

        public static Job parseDelimitedFrom​(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.CodedInputStream input)
                     throws IOException
        Throws:
        IOException

      • parseFrom

        public static Job parseFrom​(com.google.protobuf.CodedInputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Job.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilder

        public static Job.Builder newBuilder​(Job prototype)

      • toBuilder

        public Job.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Job.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Job getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Job> parser()

      • getParserForType

        public com.google.protobuf.Parser<Job> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Job getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder