Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Task
- Inherits:
-
Object
- Object
- Google::Apis::DataplexV1::GoogleCloudDataplexV1Task
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb
Overview
A task represents a user-visible job.
Instance Attribute Summary collapse
-
#create_time ⇒ String
Output only.
-
#description ⇒ String
Optional.
-
#display_name ⇒ String
Optional.
-
#execution_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionSpec
Execution related settings, like retry and service_account.
-
#execution_status ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionStatus
Status of the task execution (e.g. Jobs).
-
#labels ⇒ Hash<String,String>
Optional.
-
#name ⇒ String
Output only.
-
#notebook ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskNotebookTaskConfig
Config for running scheduled notebooks.
-
#spark ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskSparkTaskConfig
User-specified config for running a Spark task.
-
#state ⇒ String
Output only.
-
#trigger_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskTriggerSpec
Task scheduling and trigger settings.
-
#uid ⇒ String
Output only.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDataplexV1Task
constructor
A new instance of GoogleCloudDataplexV1Task.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDataplexV1Task
Returns a new instance of GoogleCloudDataplexV1Task.
7284 7285 7286 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7284 def initialize(**args) update!(**args) end |
Instance Attribute Details
#create_time ⇒ String
Output only. The time when the task was created.
Corresponds to the JSON property createTime
7220 7221 7222 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7220 def create_time @create_time end |
#description ⇒ String
Optional. Description of the task.
Corresponds to the JSON property description
7225 7226 7227 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7225 def description @description end |
#display_name ⇒ String
Optional. User friendly display name.
Corresponds to the JSON property displayName
7230 7231 7232 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7230 def display_name @display_name end |
#execution_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionSpec
Execution related settings, like retry and service_account.
Corresponds to the JSON property executionSpec
7235 7236 7237 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7235 def execution_spec @execution_spec end |
#execution_status ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionStatus
Status of the task execution (e.g. Jobs).
Corresponds to the JSON property executionStatus
7240 7241 7242 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7240 def execution_status @execution_status end |
#labels ⇒ Hash<String,String>
Optional. User-defined labels for the task.
Corresponds to the JSON property labels
7245 7246 7247 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7245 def labels @labels end |
#name ⇒ 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
.
Corresponds to the JSON property name
7251 7252 7253 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7251 def name @name end |
#notebook ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskNotebookTaskConfig
Config for running scheduled notebooks.
Corresponds to the JSON property notebook
7256 7257 7258 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7256 def notebook @notebook end |
#spark ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskSparkTaskConfig
User-specified config for running a Spark task.
Corresponds to the JSON property spark
7261 7262 7263 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7261 def spark @spark end |
#state ⇒ String
Output only. Current state of the task.
Corresponds to the JSON property state
7266 7267 7268 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7266 def state @state end |
#trigger_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskTriggerSpec
Task scheduling and trigger settings.
Corresponds to the JSON property triggerSpec
7271 7272 7273 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7271 def trigger_spec @trigger_spec end |
#uid ⇒ 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.
Corresponds to the JSON property uid
7277 7278 7279 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7277 def uid @uid end |
#update_time ⇒ String
Output only. The time when the task was last updated.
Corresponds to the JSON property updateTime
7282 7283 7284 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7282 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 |
# File 'lib/google/apis/dataplex_v1/classes.rb', line 7289 def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @execution_spec = args[:execution_spec] if args.key?(:execution_spec) @execution_status = args[:execution_status] if args.key?(:execution_status) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @notebook = args[:notebook] if args.key?(:notebook) @spark = args[:spark] if args.key?(:spark) @state = args[:state] if args.key?(:state) @trigger_spec = args[:trigger_spec] if args.key?(:trigger_spec) @uid = args[:uid] if args.key?(:uid) @update_time = args[:update_time] if args.key?(:update_time) end |