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



4105
4106
4107
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4105

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) 


4092
4093
4094
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4092

def completed
  @completed
end

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

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

Returns:



4024
4025
4026
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4024

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:



4048
4049
4050
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4048

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:



4041
4042
4043
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4041

def errors
  @errors
end

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

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

Returns:



4034
4035
4036
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4034

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:



4060
4061
4062
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4060

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) 


4080
4081
4082
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4080

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:



4098
4099
4100
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4098

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) 


4065
4066
4067
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4065

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:



4103
4104
4105
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4103

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:



4055
4056
4057
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4055

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:



4087
4088
4089
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4087

def stop_position
  @stop_position
end

#work_item_id ⇒ String

Identifies the WorkItem. Corresponds to the JSON property workItemId

Returns:

  • (String) 


4029
4030
4031
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4029

def work_item_id
  @work_item_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4110

def update!(**args)
  @counter_updates = args[:counter_updates] if args.key?(:counter_updates)
  @work_item_id = args[:work_item_id] if args.key?(:work_item_id)
  @metric_updates = args[:metric_updates] if args.key?(:metric_updates)
  @errors = args[:errors] if args.key?(:errors)
  @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)
  @progress = args[:progress] if args.key?(:progress)
  @requested_lease_duration = args[:requested_lease_duration] if args.key?(:requested_lease_duration)
  @report_index = args[:report_index] if args.key?(:report_index)
  @stop_position = args[:stop_position] if args.key?(:stop_position)
  @completed = args[:completed] if args.key?(:completed)
  @reported_progress = args[:reported_progress] if args.key?(:reported_progress)
  @source_fork = args[:source_fork] if args.key?(:source_fork)
end