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



3247
3248
3249
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3247

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) 


3234
3235
3236
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3234

def completed
  @completed
end

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

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

Returns:



3166
3167
3168
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3166

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:



3190
3191
3192
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3190

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:



3183
3184
3185
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3183

def errors
  @errors
end

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

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

Returns:



3176
3177
3178
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3176

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:



3202
3203
3204
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3202

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) 


3222
3223
3224
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3222

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:



3240
3241
3242
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3240

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) 


3207
3208
3209
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3207

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:



3245
3246
3247
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3245

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:



3197
3198
3199
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3197

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:



3229
3230
3231
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3229

def stop_position
  @stop_position
end

#work_item_id ⇒ String

Identifies the WorkItem. Corresponds to the JSON property workItemId

Returns:

  • (String) 


3171
3172
3173
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3171

def work_item_id
  @work_item_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3252

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