Class: Google::Apis::DataflowV1b3::WorkItemServiceState

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

The Dataflow service's idea of the current state of a WorkItem being processed by a worker.

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) ⇒ WorkItemServiceState

Returns a new instance of WorkItemServiceState.


2324
2325
2326
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2324

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#harness_dataHash<String,Object>

Other data returned by the service, specific to the particular worker harness. Corresponds to the JSON property harnessData

Returns:

  • (Hash<String,Object>)

2294
2295
2296
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2294

def harness_data
  @harness_data
end

#lease_expire_timeString

Time at which the current lease will expire. Corresponds to the JSON property leaseExpireTime

Returns:

  • (String)

2284
2285
2286
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2284

def lease_expire_time
  @lease_expire_time
end

#metric_short_idArray<Google::Apis::DataflowV1b3::MetricShortId>

The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics. Corresponds to the JSON property metricShortId


2310
2311
2312
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2310

def metric_short_id
  @metric_short_id
end

#next_report_indexString

The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts. Corresponds to the JSON property nextReportIndex

Returns:

  • (String)

2301
2302
2303
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2301

def next_report_index
  @next_report_index
end

#report_status_intervalString

New recommended reporting interval. Corresponds to the JSON property reportStatusInterval

Returns:

  • (String)

2289
2290
2291
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2289

def report_status_interval
  @report_status_interval
end

#split_requestGoogle::Apis::DataflowV1b3::ApproximateSplitRequest

A suggestion by the service to the worker to dynamically split the WorkItem. Corresponds to the JSON property splitRequest


2279
2280
2281
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2279

def split_request
  @split_request
end

#suggested_stop_pointGoogle::Apis::DataflowV1b3::ApproximateProgress

Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. Corresponds to the JSON property suggestedStopPoint


2322
2323
2324
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2322

def suggested_stop_point
  @suggested_stop_point
end

#suggested_stop_positionGoogle::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 suggestedStopPosition


2317
2318
2319
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2317

def suggested_stop_position
  @suggested_stop_position
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2329

def update!(**args)
  @split_request = args[:split_request] if args.key?(:split_request)
  @lease_expire_time = args[:lease_expire_time] if args.key?(:lease_expire_time)
  @report_status_interval = args[:report_status_interval] if args.key?(:report_status_interval)
  @harness_data = args[:harness_data] if args.key?(:harness_data)
  @next_report_index = args[:next_report_index] if args.key?(:next_report_index)
  @metric_short_id = args[:metric_short_id] if args.key?(:metric_short_id)
  @suggested_stop_position = args[:suggested_stop_position] if args.key?(:suggested_stop_position)
  @suggested_stop_point = args[:suggested_stop_point] if args.key?(:suggested_stop_point)
end