Class: Google::Apis::DataflowV1b3::WorkItemStatus
- Inherits:
-
Object
- Object
- Google::Apis::DataflowV1b3::WorkItemStatus
- 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
-
#completed ⇒ Boolean
(also: #completed?)
True if the WorkItem was completed (successfully or unsuccessfully).
-
#counter_updates ⇒ Array<Google::Apis::DataflowV1b3::CounterUpdate>
Worker output counters for this WorkItem.
-
#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.
-
#errors ⇒ Array<Google::Apis::DataflowV1b3::Status>
Specifies errors which occurred during processing.
-
#metric_updates ⇒ Array<Google::Apis::DataflowV1b3::MetricUpdate>
DEPRECATED in favor of counter_updates.
-
#progress ⇒ Google::Apis::DataflowV1b3::ApproximateProgress
Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.
-
#report_index ⇒ Fixnum
The report index.
-
#reported_progress ⇒ Google::Apis::DataflowV1b3::ApproximateReportedProgress
A progress measurement of a WorkItem by a worker.
-
#requested_lease_duration ⇒ String
Amount of time the worker requests for its lease.
-
#source_fork ⇒ Google::Apis::DataflowV1b3::SourceFork
DEPRECATED in favor of DynamicSourceSplit.
-
#source_operation_response ⇒ Google::Apis::DataflowV1b3::SourceOperationResponse
The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.
-
#stop_position ⇒ Google::Apis::DataflowV1b3::Position
Position defines a position within a collection of data.
-
#total_throttler_wait_time_seconds ⇒ Float
Total time the worker spent being throttled by external systems.
-
#work_item_id ⇒ String
Identifies the WorkItem.
Instance Method Summary collapse
-
#initialize(**args) ⇒ WorkItemStatus
constructor
A new instance of WorkItemStatus.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ WorkItemStatus
Returns a new instance of WorkItemStatus
5334 5335 5336 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5334 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
5248 5249 5250 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5248 def completed @completed end |
#counter_updates ⇒ Array<Google::Apis::DataflowV1b3::CounterUpdate>
Worker output counters for this WorkItem.
Corresponds to the JSON property counterUpdates
5254 5255 5256 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5254 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
5261 5262 5263 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5261 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
5268 5269 5270 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5268 def errors @errors end |
#metric_updates ⇒ Array<Google::Apis::DataflowV1b3::MetricUpdate>
DEPRECATED in favor of counter_updates.
Corresponds to the JSON property metricUpdates
5273 5274 5275 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5273 def metric_updates @metric_updates end |
#progress ⇒ Google::Apis::DataflowV1b3::ApproximateProgress
Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.
Corresponds to the JSON property progress
5278 5279 5280 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5278 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
5293 5294 5295 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5293 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
5298 5299 5300 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5298 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
5303 5304 5305 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5303 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
5308 5309 5310 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5308 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
5315 5316 5317 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5315 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
5322 5323 5324 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5322 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
5327 5328 5329 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5327 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
5332 5333 5334 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5332 def work_item_id @work_item_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 |
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 5339 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 |