google_dataflow_api::WorkerLifecycleEvent Class Reference

#include <worker_lifecycle_event.h>

Inheritance diagram for google_dataflow_api::WorkerLifecycleEvent:

Public Member Functions
	WorkerLifecycleEvent (const Json::Value &storage)
	WorkerLifecycleEvent (Json::Value *storage)
virtual	~WorkerLifecycleEvent ()
const StringPiece	GetTypeName () const
bool	has_container_start_time () const
void	clear_container_start_time ()
const StringPiece	get_container_start_time () const
void	set_container_start_time (const StringPiece &value)
bool	has_event () const
void	clear_event ()
const StringPiece	get_event () const
void	set_event (const StringPiece &value)
bool	has_metadata () const
void	clear_metadata ()
const client::JsonCppAssociativeArray< string >	get_metadata () const
client::JsonCppAssociativeArray< string >	mutable_metadata ()

Static Public Member Functions
static WorkerLifecycleEvent *	New ()

Detailed Description

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.

Constructor & Destructor Documentation

WorkerLifecycleEvent() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

WorkerLifecycleEvent() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~WorkerLifecycleEvent()

google_dataflow_api::WorkerLifecycleEvent::~WorkerLifecycleEvent ( )

virtual

Standard destructor.

Member Function Documentation

clear_container_start_time()

void google_dataflow_api::WorkerLifecycleEvent::clear_container_start_time ( )

inline

Clears the 'containerStartTime' attribute.

clear_event()

void google_dataflow_api::WorkerLifecycleEvent::clear_event ( )

inline

Clears the 'event' attribute.

clear_metadata()

void google_dataflow_api::WorkerLifecycleEvent::clear_metadata ( )

inline

Clears the 'metadata' attribute.

get_container_start_time()

const StringPiece google_dataflow_api::WorkerLifecycleEvent::get_container_start_time ( ) const

inline

Get the value of the 'containerStartTime' attribute.

get_event()

const StringPiece google_dataflow_api::WorkerLifecycleEvent::get_event ( ) const

inline

Get the value of the 'event' attribute.

get_metadata()

const client::JsonCppAssociativeArray<string > google_dataflow_api::WorkerLifecycleEvent::get_metadata ( ) const

inline

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

GetTypeName()

const StringPiece google_dataflow_api::WorkerLifecycleEvent::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::WorkerLifecycleEvent

has_container_start_time()

bool google_dataflow_api::WorkerLifecycleEvent::has_container_start_time ( ) const

inline

Determine if the 'containerStartTime' attribute was set.

Returns

true if the 'containerStartTime' attribute was set.

has_event()

bool google_dataflow_api::WorkerLifecycleEvent::has_event ( ) const

inline

Determine if the 'event' attribute was set.

Returns

true if the 'event' attribute was set.

has_metadata()

bool google_dataflow_api::WorkerLifecycleEvent::has_metadata ( ) const

inline

Determine if the 'metadata' attribute was set.

Returns

true if the 'metadata' attribute was set.

mutable_metadata()

client::JsonCppAssociativeArray<string > google_dataflow_api::WorkerLifecycleEvent::mutable_metadata ( )

inline

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

Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" }.

Returns

The result can be modified to change the attribute value.

New()

WorkerLifecycleEvent * google_dataflow_api::WorkerLifecycleEvent::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_container_start_time()

void google_dataflow_api::WorkerLifecycleEvent::set_container_start_time ( const StringPiece &  value )

inline

Change the 'containerStartTime' attribute.

The start time of this container. All events will report this so that events can be grouped together across container/VM restarts.

Parameters

[in]

value

The new value.

set_event()

void google_dataflow_api::WorkerLifecycleEvent::set_event ( const StringPiece &  value )

inline

Change the 'event' attribute.

The event being reported.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/worker_lifecycle_event.h
• google/dataflow_api/worker_lifecycle_event.cc