Class: Google::Apis::DataflowV1b3::WorkerMessage

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

WorkerMessage provides information to the backend about 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) ⇒ WorkerMessage

Returns a new instance of WorkerMessage.



3846
3847
3848
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3846

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

Instance Attribute Details

#labels ⇒ Hash<String,String>

Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: "JOB_ID": "2015-04-22", " WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": " ac1234def" Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3823
3824
3825
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3823

def labels
  @labels
end

#time ⇒ String

The timestamp of the worker_message. Corresponds to the JSON property time

Returns:

  • (String) 


3828
3829
3830
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3828

def time
  @time
end

#worker_health_report ⇒ Google::Apis::DataflowV1b3::WorkerHealthReport

WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. Corresponds to the JSON property workerHealthReport

Returns:



3835
3836
3837
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3835

def worker_health_report
  @worker_health_report
end

#worker_message_code ⇒ Google::Apis::DataflowV1b3::WorkerMessageCode

A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). Corresponds to the JSON property workerMessageCode

Returns:



3844
3845
3846
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3844

def worker_message_code
  @worker_message_code
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3851
3852
3853
3854
3855
3856
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3851

def update!(**args)
  @labels = args[:labels] if args.key?(:labels)
  @time = args[:time] if args.key?(:time)
  @worker_health_report = args[:worker_health_report] if args.key?(:worker_health_report)
  @worker_message_code = args[:worker_message_code] if args.key?(:worker_message_code)
end