Class: Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datapipelines_v1/classes.rb,
lib/google/apis/datapipelines_v1/representations.rb,
lib/google/apis/datapipelines_v1/representations.rb

Overview

Definition of the job information maintained by the pipeline. Fields in this entity are retrieved from the executor API (e.g. Dataflow API).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatapipelinesV1Job

Returns a new instance of GoogleCloudDatapipelinesV1Job.



242
243
244
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 242

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time of job creation. Corresponds to the JSON property createTime

Returns:

  • (String) 


203
204
205
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 203

def create_time
  @create_time
end

#dataflow_job_details ⇒ Google::Apis::DatapipelinesV1::GoogleCloudDatapipelinesV1DataflowJobDetails

Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. Corresponds to the JSON property dataflowJobDetails

Returns:



209
210
211
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 209

def dataflow_job_details
  @dataflow_job_details
end

#end_time ⇒ String

Output only. The time of job termination. This is absent if the job is still running. Corresponds to the JSON property endTime

Returns:

  • (String) 


215
216
217
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 215

def end_time
  @end_time
end

#id ⇒ String

Output only. The internal ID for the job. Corresponds to the JSON property id

Returns:

  • (String) 


220
221
222
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 220

def id
  @id
end

#name ⇒ String

Required. The fully qualified resource name for the job. Corresponds to the JSON property name

Returns:

  • (String) 


225
226
227
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 225

def name
  @name
end

#state ⇒ String

The current state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


230
231
232
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 230

def state
  @state
end

#status ⇒ Google::Apis::DatapipelinesV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property status

Returns:



240
241
242
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 240

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



247
248
249
250
251
252
253
254
255
 
# File 'lib/google/apis/datapipelines_v1/classes.rb', line 247

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dataflow_job_details = args[:dataflow_job_details] if args.key?(:dataflow_job_details)
  @end_time = args[:end_time] if args.key?(:end_time)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @status = args[:status] if args.key?(:status)
end