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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataflow_v1b3/classes.rb,
lib/google/apis/dataflow_v1b3/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ WorkItemStatus

Returns a new instance of WorkItemStatus.



7188
7189
7190
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7188

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) 


7106
7107
7108
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7106

def completed
  @completed
end

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

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

Returns:



7112
7113
7114
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7112

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:



7119
7120
7121
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7119

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:



7125
7126
7127
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7125

def errors
  @errors
end

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

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

Returns:



7130
7131
7132
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7130

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:



7135
7136
7137
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7135

def progress
  @progress
end

#report_index ⇒ Fixnum

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:

  • (Fixnum) 


7148
7149
7150
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7148

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:



7153
7154
7155
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7153

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) 


7158
7159
7160
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7158

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:



7163
7164
7165
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7163

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:



7169
7170
7171
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7169

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:



7176
7177
7178
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7176

def stop_position
  @stop_position
end

#total_throttler_wait_time_seconds ⇒ Float

Total time the worker spent being throttled by external systems. Corresponds to the JSON property totalThrottlerWaitTimeSeconds

Returns:

  • (Float) 


7181
7182
7183
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7181

def total_throttler_wait_time_seconds
  @total_throttler_wait_time_seconds
end

#work_item_id ⇒ String

Identifies the WorkItem. Corresponds to the JSON property workItemId

Returns:

  • (String) 


7186
7187
7188
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7186

def work_item_id
  @work_item_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7193

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