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

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

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

Constructor Details

#initialize(**args) ⇒ WorkItemServiceState

Returns a new instance of WorkItemServiceState.



5992
5993
5994
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5992

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

Instance Attribute Details

#complete_work_status ⇒ Google::Apis::DataflowV1b3::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property completeWorkStatus

Returns:



5937
5938
5939
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5937

def complete_work_status
  @complete_work_status
end

#harness_data ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


5942
5943
5944
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5942

def harness_data
  @harness_data
end

#hot_key_detection ⇒ Google::Apis::DataflowV1b3::HotKeyDetection

Proto describing a hot key detected on a given WorkItem. Corresponds to the JSON property hotKeyDetection

Returns:



5947
5948
5949
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5947

def hot_key_detection
  @hot_key_detection
end

#lease_expire_time ⇒ String

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

Returns:

  • (String) 


5952
5953
5954
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5952

def lease_expire_time
  @lease_expire_time
end

#metric_short_id ⇒ Array<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

Returns:



5961
5962
5963
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5961

def metric_short_id
  @metric_short_id
end

#next_report_index ⇒ Fixnum

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:

  • (Fixnum) 


5968
5969
5970
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5968

def next_report_index
  @next_report_index
end

#report_status_interval ⇒ String

New recommended reporting interval. Corresponds to the JSON property reportStatusInterval

Returns:

  • (String) 


5973
5974
5975
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5973

def report_status_interval
  @report_status_interval
end

#split_request ⇒ Google::Apis::DataflowV1b3::ApproximateSplitRequest

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

Returns:



5978
5979
5980
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5978

def split_request
  @split_request
end

#suggested_stop_point ⇒ Google::Apis::DataflowV1b3::ApproximateProgress

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

Returns:



5983
5984
5985
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5983

def suggested_stop_point
  @suggested_stop_point
end

#suggested_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 suggestedStopPosition

Returns:



5990
5991
5992
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5990

def suggested_stop_position
  @suggested_stop_position
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 5997

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