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



2958
2959
2960
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2958

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


2944
2945
2946
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2944

def labels
  @labels
end

#time ⇒ String

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

Returns:

  • (String) 


2949
2950
2951
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2949

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:



2956
2957
2958
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2956

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:



2923
2924
2925
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2923

def worker_message_code
  @worker_message_code
end

#worker_metrics ⇒ Google::Apis::DataflowV1b3::ResourceUtilizationReport

Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals. Corresponds to the JSON property workerMetrics

Returns:



2930
2931
2932
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2930

def worker_metrics
  @worker_metrics
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2963
2964
2965
2966
2967
2968
2969
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2963

def update!(**args)
  @worker_message_code = args[:worker_message_code] if args.key?(:worker_message_code)
  @worker_metrics = args[:worker_metrics] if args.key?(:worker_metrics)
  @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)
end