Class Task

  • All Implemented Interfaces:
    TaskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Task
    extends com.google.protobuf.GeneratedMessageV3
    implements TaskOrBuilder
     A task represents a user-visible job.
     
    Protobuf type google.cloud.dataplex.v1.Task
    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 task, of the form:
         projects/{project_number}/locations/{location_id}/lakes/{lake_id}/
         tasks/{task_id}.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface TaskOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The relative resource name of the task, of the form:
         projects/{project_number}/locations/{location_id}/lakes/{lake_id}/
         tasks/{task_id}.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface TaskOrBuilder
        Returns:
        The bytes for name.
      • getUid

        public String getUid()
         Output only. System generated globally unique ID for the task. This ID will
         be different if the task is deleted and re-created with the same name.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUid in interface TaskOrBuilder
        Returns:
        The uid.
      • getUidBytes

        public com.google.protobuf.ByteString getUidBytes()
         Output only. System generated globally unique ID for the task. This ID will
         be different if the task is deleted and re-created with the same name.
         
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUidBytes in interface TaskOrBuilder
        Returns:
        The bytes for uid.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The time when the task was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface TaskOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The time when the task was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface TaskOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time when the task was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface TaskOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The time when the task was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface TaskOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time when the task was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface TaskOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time when the task was last updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface TaskOrBuilder
      • getDescription

        public String getDescription()
         Optional. Description of the task.
         
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface TaskOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Description of the task.
         
        string description = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface TaskOrBuilder
        Returns:
        The bytes for description.
      • getDisplayName

        public String getDisplayName()
         Optional. User friendly display name.
         
        string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface TaskOrBuilder
        Returns:
        The displayName.
      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Optional. User friendly display name.
         
        string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface TaskOrBuilder
        Returns:
        The bytes for displayName.
      • getStateValue

        public int getStateValue()
         Output only. Current state of the task.
         
        .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface TaskOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • getState

        public State getState()
         Output only. Current state of the task.
         
        .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface TaskOrBuilder
        Returns:
        The state.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: TaskOrBuilder
         Optional. User-defined labels for the task.
         
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface TaskOrBuilder
      • containsLabels

        public boolean containsLabels​(String key)
         Optional. User-defined labels for the task.
         
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface TaskOrBuilder
      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. User-defined labels for the task.
         
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface TaskOrBuilder
      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                         String defaultValue)
         Optional. User-defined labels for the task.
         
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface TaskOrBuilder
      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. User-defined labels for the task.
         
        map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface TaskOrBuilder
      • hasTriggerSpec

        public boolean hasTriggerSpec()
         Required. Spec related to how often and when a task should be triggered.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasTriggerSpec in interface TaskOrBuilder
        Returns:
        Whether the triggerSpec field is set.
      • getTriggerSpec

        public Task.TriggerSpec getTriggerSpec()
         Required. Spec related to how often and when a task should be triggered.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTriggerSpec in interface TaskOrBuilder
        Returns:
        The triggerSpec.
      • getTriggerSpecOrBuilder

        public Task.TriggerSpecOrBuilder getTriggerSpecOrBuilder()
         Required. Spec related to how often and when a task should be triggered.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTriggerSpecOrBuilder in interface TaskOrBuilder
      • hasExecutionSpec

        public boolean hasExecutionSpec()
         Required. Spec related to how a task is executed.
         
        .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasExecutionSpec in interface TaskOrBuilder
        Returns:
        Whether the executionSpec field is set.
      • getExecutionSpec

        public Task.ExecutionSpec getExecutionSpec()
         Required. Spec related to how a task is executed.
         
        .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getExecutionSpec in interface TaskOrBuilder
        Returns:
        The executionSpec.
      • hasExecutionStatus

        public boolean hasExecutionStatus()
         Output only. Status of the latest task executions.
         
        .google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasExecutionStatus in interface TaskOrBuilder
        Returns:
        Whether the executionStatus field is set.
      • getExecutionStatus

        public Task.ExecutionStatus getExecutionStatus()
         Output only. Status of the latest task executions.
         
        .google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getExecutionStatus in interface TaskOrBuilder
        Returns:
        The executionStatus.
      • hasSpark

        public boolean hasSpark()
         Config related to running custom Spark tasks.
         
        .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
        Specified by:
        hasSpark in interface TaskOrBuilder
        Returns:
        Whether the spark field is set.
      • getSpark

        public Task.SparkTaskConfig getSpark()
         Config related to running custom Spark tasks.
         
        .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
        Specified by:
        getSpark in interface TaskOrBuilder
        Returns:
        The spark.
      • hasNotebook

        public boolean hasNotebook()
         Config related to running scheduled Notebooks.
         
        .google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
        Specified by:
        hasNotebook in interface TaskOrBuilder
        Returns:
        Whether the notebook field is set.
      • getNotebook

        public Task.NotebookTaskConfig getNotebook()
         Config related to running scheduled Notebooks.
         
        .google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
        Specified by:
        getNotebook in interface TaskOrBuilder
        Returns:
        The notebook.
      • 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 Task parseFrom​(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static Task getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Task> parser()
      • getParserForType

        public com.google.protobuf.Parser<Task> 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 Task getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder