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.



7436
7437
7438
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7436

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

Instance Attribute Details

#data_sampling_report ⇒ Google::Apis::DataflowV1b3::DataSamplingReport

Contains per-worker telemetry about the data sampling feature. Corresponds to the JSON property dataSamplingReport

Returns:



7366
7367
7368
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7366

def data_sampling_report
  @data_sampling_report
end

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


7376
7377
7378
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7376

def labels
  @labels
end

#per_worker_metrics ⇒ Google::Apis::DataflowV1b3::PerWorkerMetrics

Per worker metrics. Corresponds to the JSON property perWorkerMetrics

Returns:



7381
7382
7383
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7381

def per_worker_metrics
  @per_worker_metrics
end

#streaming_scaling_report ⇒ Google::Apis::DataflowV1b3::StreamingScalingReport

Contains per-user worker telemetry used in streaming autoscaling. Corresponds to the JSON property streamingScalingReport

Returns:



7386
7387
7388
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7386

def streaming_scaling_report
  @streaming_scaling_report
end

#time ⇒ String

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

Returns:

  • (String) 


7391
7392
7393
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7391

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:



7398
7399
7400
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7398

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:



7407
7408
7409
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7407

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:



7416
7417
7418
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7416

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:



7423
7424
7425
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7423

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:



7429
7430
7431
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7429

def worker_shutdown_notice
  @worker_shutdown_notice
end

#worker_thread_scaling_report ⇒ Google::Apis::DataflowV1b3::WorkerThreadScalingReport

Contains information about the thread scaling information of a worker. Corresponds to the JSON property workerThreadScalingReport

Returns:



7434
7435
7436
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7434

def worker_thread_scaling_report
  @worker_thread_scaling_report
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7441

def update!(**args)
  @data_sampling_report = args[:data_sampling_report] if args.key?(:data_sampling_report)
  @labels = args[:labels] if args.key?(:labels)
  @per_worker_metrics = args[:per_worker_metrics] if args.key?(:per_worker_metrics)
  @streaming_scaling_report = args[:streaming_scaling_report] if args.key?(:streaming_scaling_report)
  @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)
  @worker_thread_scaling_report = args[:worker_thread_scaling_report] if args.key?(:worker_thread_scaling_report)
end