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

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

WorkerMessage provides information to the backend about a worker.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkerMessage

Returns a new instance of WorkerMessage.



6323
6324
6325
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6323

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


6278
6279
6280
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6278

def labels
  @labels
end

#time ⇒ String

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

Returns:

  • (String) 


6283
6284
6285
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6283

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:



6290
6291
6292
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6290

def worker_health_report
  @worker_health_report
end

#worker_lifecycle_event ⇒ Google::Apis::DataflowV1b3::WorkerLifecycleEvent

A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. Corresponds to the JSON property workerLifecycleEvent

Returns:



6299
6300
6301
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6299

def worker_lifecycle_event
  @worker_lifecycle_event
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:



6308
6309
6310
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6308

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:



6315
6316
6317
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6315

def worker_metrics
  @worker_metrics
end

#worker_shutdown_notice ⇒ Google::Apis::DataflowV1b3::WorkerShutdownNotice

Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down. Corresponds to the JSON property workerShutdownNotice

Returns:



6321
6322
6323
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6321

def worker_shutdown_notice
  @worker_shutdown_notice
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6328
6329
6330
6331
6332
6333
6334
6335
6336
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 6328

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_lifecycle_event = args[:worker_lifecycle_event] if args.key?(:worker_lifecycle_event)
  @worker_message_code = args[:worker_message_code] if args.key?(:worker_message_code)
  @worker_metrics = args[:worker_metrics] if args.key?(:worker_metrics)
  @worker_shutdown_notice = args[:worker_shutdown_notice] if args.key?(:worker_shutdown_notice)
end