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.



6629
6630
6631
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6629

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) 


6547
6548
6549
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6547

def completed
  @completed
end

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

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

Returns:



6553
6554
6555
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6553

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:



6560
6561
6562
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6560

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:



6566
6567
6568
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6566

def errors
  @errors
end

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

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

Returns:



6571
6572
6573
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6571

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:



6576
6577
6578
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6576

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) 


6589
6590
6591
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6589

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:



6594
6595
6596
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6594

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) 


6599
6600
6601
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6599

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:



6604
6605
6606
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6604

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:



6610
6611
6612
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6610

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:



6617
6618
6619
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6617

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) 


6622
6623
6624
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6622

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) 


6627
6628
6629
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6627

def work_item_id
  @work_item_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6634

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