Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Task.
A task represents a user-visible job.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the task was created.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the task.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the task.
Returns
- (::String) — Optional. Description of the task.
#display_name
def display_name() -> ::String
Returns
- (::String) — Optional. User friendly display name.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Optional. User friendly display name.
Returns
- (::String) — Optional. User friendly display name.
#execution_spec
def execution_spec() -> ::Google::Cloud::Dataplex::V1::Task::ExecutionSpec
Returns
- (::Google::Cloud::Dataplex::V1::Task::ExecutionSpec) — Required. Spec related to how a task is executed.
#execution_spec=
def execution_spec=(value) -> ::Google::Cloud::Dataplex::V1::Task::ExecutionSpec
Parameter
- value (::Google::Cloud::Dataplex::V1::Task::ExecutionSpec) — Required. Spec related to how a task is executed.
Returns
- (::Google::Cloud::Dataplex::V1::Task::ExecutionSpec) — Required. Spec related to how a task is executed.
#execution_status
def execution_status() -> ::Google::Cloud::Dataplex::V1::Task::ExecutionStatus
Returns
- (::Google::Cloud::Dataplex::V1::Task::ExecutionStatus) — Output only. Status of the latest task executions.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the task.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the task.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels for the task.
#name
def name() -> ::String
Returns
- (::String) — Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.
#notebook
def notebook() -> ::Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig
Returns
- (::Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig) — Config related to running scheduled Notebooks.
#notebook=
def notebook=(value) -> ::Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig
Parameter
- value (::Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig) — Config related to running scheduled Notebooks.
Returns
- (::Google::Cloud::Dataplex::V1::Task::NotebookTaskConfig) — Config related to running scheduled Notebooks.
#spark
def spark() -> ::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig
Returns
- (::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig) — Config related to running custom Spark tasks.
#spark=
def spark=(value) -> ::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig
Parameter
- value (::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig) — Config related to running custom Spark tasks.
Returns
- (::Google::Cloud::Dataplex::V1::Task::SparkTaskConfig) — Config related to running custom Spark tasks.
#state
def state() -> ::Google::Cloud::Dataplex::V1::State
Returns
- (::Google::Cloud::Dataplex::V1::State) — Output only. Current state of the task.
#trigger_spec
def trigger_spec() -> ::Google::Cloud::Dataplex::V1::Task::TriggerSpec
Returns
- (::Google::Cloud::Dataplex::V1::Task::TriggerSpec) — Required. Spec related to how often and when a task should be triggered.
#trigger_spec=
def trigger_spec=(value) -> ::Google::Cloud::Dataplex::V1::Task::TriggerSpec
Parameter
- value (::Google::Cloud::Dataplex::V1::Task::TriggerSpec) — Required. Spec related to how often and when a task should be triggered.
Returns
- (::Google::Cloud::Dataplex::V1::Task::TriggerSpec) — Required. Spec related to how often and when a task should be triggered.
#uid
def uid() -> ::String
Returns
- (::String) — 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.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the task was last updated.