Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Job

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 job represents an instance of a task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Job

Returns a new instance of GoogleCloudDataplexV1Job.



3437
3438
3439
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3437

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#end_time ⇒ String

Output only. The time when the job ended. Corresponds to the JSON property endTime

Returns:

  • (String) 


3377
3378
3379
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3377

def end_time
  @end_time
end

#execution_spec ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionSpec

Execution related settings, like retry and service_account. Corresponds to the JSON property executionSpec

Returns:



3382
3383
3384
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3382

def execution_spec
  @execution_spec
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


3387
3388
3389
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3387

def labels
  @labels
end

#message ⇒ String

Output only. Additional information about the current state. Corresponds to the JSON property message

Returns:

  • (String) 


3392
3393
3394
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3392

def message
  @message
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


3399
3400
3401
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3399

def name
  @name
end

#retry_count ⇒ Fixnum

Output only. The number of times the job has been retried (excluding the initial attempt). Corresponds to the JSON property retryCount

Returns:

  • (Fixnum) 


3405
3406
3407
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3405

def retry_count
  @retry_count
end

#service ⇒ String

Output only. The underlying service running a job. Corresponds to the JSON property service

Returns:

  • (String) 


3410
3411
3412
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3410

def service
  @service
end

#service_job ⇒ String

Output only. The full resource name for the job run under a particular service. Corresponds to the JSON property serviceJob

Returns:

  • (String) 


3415
3416
3417
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3415

def service_job
  @service_job
end

#start_time ⇒ String

Output only. The time when the job was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


3420
3421
3422
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3420

def start_time
  @start_time
end

#state ⇒ String

Output only. Execution state for the job. Corresponds to the JSON property state

Returns:

  • (String) 


3425
3426
3427
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3425

def state
  @state
end

#trigger ⇒ String

Output only. Job execution trigger. Corresponds to the JSON property trigger

Returns:

  • (String) 


3430
3431
3432
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3430

def trigger
  @trigger
end

#uid ⇒ String

Output only. System generated globally unique ID for the job. Corresponds to the JSON property uid

Returns:

  • (String) 


3435
3436
3437
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3435

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 3442

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @execution_spec = args[:execution_spec] if args.key?(:execution_spec)
  @labels = args[:labels] if args.key?(:labels)
  @message = args[:message] if args.key?(:message)
  @name = args[:name] if args.key?(:name)
  @retry_count = args[:retry_count] if args.key?(:retry_count)
  @service = args[:service] if args.key?(:service)
  @service_job = args[:service_job] if args.key?(:service_job)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @trigger = args[:trigger] if args.key?(:trigger)
  @uid = args[:uid] if args.key?(:uid)
end