Class: Google::Apis::DataflowV1b3::WorkItemStatus

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

Overview

Conveys a worker's progress through the work described by a WorkItem.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ WorkItemStatus

Returns a new instance of WorkItemStatus.



1281
1282
1283
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1281

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

Instance Attribute Details

#completed ⇒ Boolean Also known as: completed?

True if the WorkItem was completed (successfully or unsuccessfully). Corresponds to the JSON property completed

Returns:

  • (Boolean) 


1227
1228
1229
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1227

def completed
  @completed
end

#counter_updates ⇒ Array<Google::Apis::DataflowV1b3::CounterUpdate>

Worker output counters for this WorkItem. Corresponds to the JSON property counterUpdates

Returns:



1239
1240
1241
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1239

def counter_updates
  @counter_updates
end

#dynamic_source_split ⇒ Google::Apis::DataflowV1b3::DynamicSourceSplit

When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input. Corresponds to the JSON property dynamicSourceSplit

Returns:



1263
1264
1265
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1263

def dynamic_source_split
  @dynamic_source_split
end

#errors ⇒ Array<Google::Apis::DataflowV1b3::Status>

Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed. Corresponds to the JSON property errors

Returns:



1234
1235
1236
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1234

def errors
  @errors
end

#metric_updates ⇒ Array<Google::Apis::DataflowV1b3::MetricUpdate>

DEPRECATED in favor of counter_updates. Corresponds to the JSON property metricUpdates

Returns:



1244
1245
1246
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1244

def metric_updates
  @metric_updates
end

#progress ⇒ Google::Apis::DataflowV1b3::ApproximateProgress

Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. Corresponds to the JSON property progress

Returns:



1279
1280
1281
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1279

def progress
  @progress
end

#report_index ⇒ String

The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service. Corresponds to the JSON property reportIndex

Returns:

  • (String) 


1217
1218
1219
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1217

def report_index
  @report_index
end

#reported_progress ⇒ Google::Apis::DataflowV1b3::ApproximateReportedProgress

A progress measurement of a WorkItem by a worker. Corresponds to the JSON property reportedProgress

Returns:



1249
1250
1251
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1249

def reported_progress
  @reported_progress
end

#requested_lease_duration ⇒ String

Amount of time the worker requests for its lease. Corresponds to the JSON property requestedLeaseDuration

Returns:

  • (String) 


1222
1223
1224
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1222

def requested_lease_duration
  @requested_lease_duration
end

#source_fork ⇒ Google::Apis::DataflowV1b3::SourceFork

DEPRECATED in favor of DynamicSourceSplit. Corresponds to the JSON property sourceFork

Returns:



1274
1275
1276
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1274

def source_fork
  @source_fork
end

#source_operation_response ⇒ Google::Apis::DataflowV1b3::SourceOperationResponse

The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed. Corresponds to the JSON property sourceOperationResponse

Returns:



1269
1270
1271
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1269

def source_operation_response
  @source_operation_response
end

#stop_position ⇒ Google::Apis::DataflowV1b3::Position

Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index. Corresponds to the JSON property stopPosition

Returns:



1256
1257
1258
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1256

def stop_position
  @stop_position
end

#work_item_id ⇒ String

Identifies the WorkItem. Corresponds to the JSON property workItemId

Returns:

  • (String) 


1204
1205
1206
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1204

def work_item_id
  @work_item_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1286

def update!(**args)
  @work_item_id = args[:work_item_id] if args.key?(:work_item_id)
  @report_index = args[:report_index] if args.key?(:report_index)
  @requested_lease_duration = args[:requested_lease_duration] if args.key?(:requested_lease_duration)
  @completed = args[:completed] if args.key?(:completed)
  @errors = args[:errors] if args.key?(:errors)
  @counter_updates = args[:counter_updates] if args.key?(:counter_updates)
  @metric_updates = args[:metric_updates] if args.key?(:metric_updates)
  @reported_progress = args[:reported_progress] if args.key?(:reported_progress)
  @stop_position = args[:stop_position] if args.key?(:stop_position)
  @dynamic_source_split = args[:dynamic_source_split] if args.key?(:dynamic_source_split)
  @source_operation_response = args[:source_operation_response] if args.key?(:source_operation_response)
  @source_fork = args[:source_fork] if args.key?(:source_fork)
  @progress = args[:progress] if args.key?(:progress)
end