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.



7783
7784
7785
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7783

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:



7713
7714
7715
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7713

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


7723
7724
7725
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7723

def labels
  @labels
end

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

Per worker metrics. Corresponds to the JSON property perWorkerMetrics

Returns:



7728
7729
7730
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7728

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:



7733
7734
7735
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7733

def streaming_scaling_report
  @streaming_scaling_report
end

#time ⇒ String

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

Returns:

  • (String) 


7738
7739
7740
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7738

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:



7745
7746
7747
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7745

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:



7754
7755
7756
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7754

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:



7763
7764
7765
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7763

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:



7770
7771
7772
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7770

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:



7776
7777
7778
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7776

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:



7781
7782
7783
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7781

def worker_thread_scaling_report
  @worker_thread_scaling_report
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 7788

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