#include <worker_message.h>

Inheritance diagram for google_dataflow_api::WorkerMessage:

Public Member Functions
	WorkerMessage (const Json::Value &storage)

	WorkerMessage (Json::Value *storage)

virtual	~WorkerMessage ()

const StringPiece	GetTypeName () const

bool	has_labels () const

void	clear_labels ()

const client::JsonCppAssociativeArray< string >	get_labels () const

client::JsonCppAssociativeArray< string >	mutable_labels ()

bool	has_time () const

void	clear_time ()

const StringPiece	get_time () const

void	set_time (const StringPiece &value)

bool	has_worker_health_report () const

void	clear_worker_health_report ()

const WorkerHealthReport	get_worker_health_report () const

WorkerHealthReport	mutable_workerHealthReport ()

bool	has_worker_lifecycle_event () const

void	clear_worker_lifecycle_event ()

const WorkerLifecycleEvent	get_worker_lifecycle_event () const

WorkerLifecycleEvent	mutable_workerLifecycleEvent ()

bool	has_worker_message_code () const

void	clear_worker_message_code ()

const WorkerMessageCode	get_worker_message_code () const

WorkerMessageCode	mutable_workerMessageCode ()

bool	has_worker_metrics () const

void	clear_worker_metrics ()

const ResourceUtilizationReport	get_worker_metrics () const

ResourceUtilizationReport	mutable_workerMetrics ()

bool	has_worker_shutdown_notice () const

void	clear_worker_shutdown_notice ()

const WorkerShutdownNotice	get_worker_shutdown_notice () const

WorkerShutdownNotice	mutable_workerShutdownNotice ()

Static Public Member Functions
static WorkerMessage *	New ()

Detailed Description

WorkerMessage provides information to the backend about a worker.

Constructor & Destructor Documentation

◆ WorkerMessage() [1/2]

google_dataflow_api::WorkerMessage::WorkerMessage ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ WorkerMessage() [2/2]

google_dataflow_api::WorkerMessage::WorkerMessage ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~WorkerMessage()

google_dataflow_api::WorkerMessage::~WorkerMessage ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_labels()

void google_dataflow_api::WorkerMessage::clear_labels ( )

inline

Clears the 'labels' attribute.

◆ clear_time()

void google_dataflow_api::WorkerMessage::clear_time ( )

inline

Clears the 'time' attribute.

◆ clear_worker_health_report()

void google_dataflow_api::WorkerMessage::clear_worker_health_report ( )

inline

Clears the 'workerHealthReport' attribute.

◆ clear_worker_lifecycle_event()

void google_dataflow_api::WorkerMessage::clear_worker_lifecycle_event ( )

inline

Clears the 'workerLifecycleEvent' attribute.

◆ clear_worker_message_code()

void google_dataflow_api::WorkerMessage::clear_worker_message_code ( )

inline

Clears the 'workerMessageCode' attribute.

◆ clear_worker_metrics()

void google_dataflow_api::WorkerMessage::clear_worker_metrics ( )

inline

Clears the 'workerMetrics' attribute.

◆ clear_worker_shutdown_notice()

void google_dataflow_api::WorkerMessage::clear_worker_shutdown_notice ( )

inline

Clears the 'workerShutdownNotice' attribute.

◆ get_labels()

const client::JsonCppAssociativeArray<string > google_dataflow_api::WorkerMessage::get_labels ( ) const

inline

Get a reference to the value of the 'labels' attribute.

◆ get_time()

const StringPiece google_dataflow_api::WorkerMessage::get_time ( ) const

inline

Get the value of the 'time' attribute.

◆ get_worker_health_report()

const WorkerHealthReport google_dataflow_api::WorkerMessage::get_worker_health_report ( ) const

Get a reference to the value of the 'workerHealthReport' attribute.

◆ get_worker_lifecycle_event()

const WorkerLifecycleEvent google_dataflow_api::WorkerMessage::get_worker_lifecycle_event ( ) const

Get a reference to the value of the 'workerLifecycleEvent' attribute.

◆ get_worker_message_code()

const WorkerMessageCode google_dataflow_api::WorkerMessage::get_worker_message_code ( ) const

Get a reference to the value of the 'workerMessageCode' attribute.

◆ get_worker_metrics()

const ResourceUtilizationReport google_dataflow_api::WorkerMessage::get_worker_metrics ( ) const

Get a reference to the value of the 'workerMetrics' attribute.

◆ get_worker_shutdown_notice()

const WorkerShutdownNotice google_dataflow_api::WorkerMessage::get_worker_shutdown_notice ( ) const

Get a reference to the value of the 'workerShutdownNotice' attribute.

◆ GetTypeName()

const StringPiece google_dataflow_api::WorkerMessage::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dataflow_api::WorkerMessage

◆ has_labels()

bool google_dataflow_api::WorkerMessage::has_labels ( ) const

inline

Determine if the 'labels' attribute was set.

Returns: true if the 'labels' attribute was set.

◆ has_time()

bool google_dataflow_api::WorkerMessage::has_time ( ) const

inline

Determine if the 'time' attribute was set.

Returns: true if the 'time' attribute was set.

◆ has_worker_health_report()

bool google_dataflow_api::WorkerMessage::has_worker_health_report ( ) const

inline

Determine if the 'workerHealthReport' attribute was set.

Returns: true if the 'workerHealthReport' attribute was set.

◆ has_worker_lifecycle_event()

bool google_dataflow_api::WorkerMessage::has_worker_lifecycle_event ( ) const

inline

Determine if the 'workerLifecycleEvent' attribute was set.

Returns: true if the 'workerLifecycleEvent' attribute was set.

◆ has_worker_message_code()

bool google_dataflow_api::WorkerMessage::has_worker_message_code ( ) const

inline

Determine if the 'workerMessageCode' attribute was set.

Returns: true if the 'workerMessageCode' attribute was set.

◆ has_worker_metrics()

bool google_dataflow_api::WorkerMessage::has_worker_metrics ( ) const

inline

Determine if the 'workerMetrics' attribute was set.

Returns: true if the 'workerMetrics' attribute was set.

◆ has_worker_shutdown_notice()

bool google_dataflow_api::WorkerMessage::has_worker_shutdown_notice ( ) const

inline

Determine if the 'workerShutdownNotice' attribute was set.

Returns: true if the 'workerShutdownNotice' attribute was set.

◆ mutable_labels()

client::JsonCppAssociativeArray<string > google_dataflow_api::WorkerMessage::mutable_labels ( )

inline

Gets a reference to a mutable value of the 'labels' property.

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.

Returns: The result can be modified to change the attribute value.

◆ mutable_workerHealthReport()

WorkerHealthReport google_dataflow_api::WorkerMessage::mutable_workerHealthReport ( )

Gets a reference to a mutable value of the 'workerHealthReport' property.

The health of a worker.

Returns: The result can be modified to change the attribute value.

◆ mutable_workerLifecycleEvent()

WorkerLifecycleEvent google_dataflow_api::WorkerMessage::mutable_workerLifecycleEvent ( )

Gets a reference to a mutable value of the 'workerLifecycleEvent' property.

Record of worker lifecycle events.

Returns: The result can be modified to change the attribute value.

◆ mutable_workerMessageCode()

WorkerMessageCode google_dataflow_api::WorkerMessage::mutable_workerMessageCode ( )

Gets a reference to a mutable value of the 'workerMessageCode' property.

A worker message code.

Returns: The result can be modified to change the attribute value.

◆ mutable_workerMetrics()

ResourceUtilizationReport google_dataflow_api::WorkerMessage::mutable_workerMetrics ( )

Gets a reference to a mutable value of the 'workerMetrics' property.

Resource metrics reported by workers.

Returns: The result can be modified to change the attribute value.

◆ mutable_workerShutdownNotice()

WorkerShutdownNotice google_dataflow_api::WorkerMessage::mutable_workerShutdownNotice ( )

Gets a reference to a mutable value of the 'workerShutdownNotice' property.

Shutdown notice by workers.

Returns: The result can be modified to change the attribute value.

◆ New()

WorkerMessage * google_dataflow_api::WorkerMessage::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_time()

void google_dataflow_api::WorkerMessage::set_time ( const StringPiece & value )

inline

Change the 'time' attribute.

The timestamp of the worker_message.

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/dataflow_api/worker_message.h
google/dataflow_api/worker_message.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WorkerMessage() [1/2]

◆ WorkerMessage() [2/2]

◆ ~WorkerMessage()

Member Function Documentation

◆ clear_labels()

◆ clear_time()

◆ clear_worker_health_report()

◆ clear_worker_lifecycle_event()

◆ clear_worker_message_code()

◆ clear_worker_metrics()

◆ clear_worker_shutdown_notice()

◆ get_labels()

◆ get_time()

◆ get_worker_health_report()

◆ get_worker_lifecycle_event()

◆ get_worker_message_code()

◆ get_worker_metrics()

◆ get_worker_shutdown_notice()

◆ GetTypeName()

◆ has_labels()

◆ has_time()

◆ has_worker_health_report()

◆ has_worker_lifecycle_event()

◆ has_worker_message_code()

◆ has_worker_metrics()

◆ has_worker_shutdown_notice()

◆ mutable_labels()

◆ mutable_workerHealthReport()

◆ mutable_workerLifecycleEvent()

◆ mutable_workerMessageCode()

◆ mutable_workerMetrics()

◆ mutable_workerShutdownNotice()

◆ New()

◆ set_time()