Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Task

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Task

Returns a new instance of GoogleCloudDataplexV1Task.



2808
2809
2810
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2808

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

Returns:

  • (String) 


2744
2745
2746
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2744

def create_time
  @create_time
end

#description ⇒ String

Optional. Description of the task. Corresponds to the JSON property description

Returns:

  • (String) 


2749
2750
2751
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2749

def description
  @description
end

#display_name ⇒ String

Optional. User friendly display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


2754
2755
2756
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2754

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

Returns:



2759
2760
2761
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2759

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

Returns:



2764
2765
2766
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2764

def execution_status
  @execution_status
end

#labels ⇒ Hash<String,String>

Optional. User-defined labels for the task. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2769
2770
2771
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2769

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

Returns:

  • (String) 


2775
2776
2777
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2775

def name
  @name
end

#notebook ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskNotebookTaskConfig

Config for running scheduled notebooks. Corresponds to the JSON property notebook

Returns:



2780
2781
2782
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2780

def notebook
  @notebook
end

#spark ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskSparkTaskConfig

User-specified config for running a Spark task. Corresponds to the JSON property spark

Returns:



2785
2786
2787
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2785

def spark
  @spark
end

#state ⇒ String

Output only. Current state of the task. Corresponds to the JSON property state

Returns:

  • (String) 


2790
2791
2792
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2790

def state
  @state
end

#trigger_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskTriggerSpec

Task scheduling and trigger settings. Corresponds to the JSON property triggerSpec

Returns:



2795
2796
2797
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2795

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

Returns:

  • (String) 


2801
2802
2803
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2801

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the task was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2806
2807
2808
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2806

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 2813

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