google_dataflow_api::WorkerShutdownNotice Class Reference

#include <worker_shutdown_notice.h>

Inheritance diagram for google_dataflow_api::WorkerShutdownNotice:

Public Member Functions
	WorkerShutdownNotice (const Json::Value &storage)
	WorkerShutdownNotice (Json::Value *storage)
virtual	~WorkerShutdownNotice ()
const StringPiece	GetTypeName () const
bool	has_reason () const
void	clear_reason ()
const StringPiece	get_reason () const
void	set_reason (const StringPiece &value)

Static Public Member Functions
static WorkerShutdownNotice *	New ()

Detailed Description

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.

Constructor & Destructor Documentation

WorkerShutdownNotice() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

WorkerShutdownNotice() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~WorkerShutdownNotice()

google_dataflow_api::WorkerShutdownNotice::~WorkerShutdownNotice ( )

virtual

Standard destructor.

Member Function Documentation

clear_reason()

void google_dataflow_api::WorkerShutdownNotice::clear_reason ( )

inline

Clears the 'reason' attribute.

get_reason()

const StringPiece google_dataflow_api::WorkerShutdownNotice::get_reason ( ) const

inline

Get the value of the 'reason' attribute.

GetTypeName()

const StringPiece google_dataflow_api::WorkerShutdownNotice::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::WorkerShutdownNotice

has_reason()

bool google_dataflow_api::WorkerShutdownNotice::has_reason ( ) const

inline

Determine if the 'reason' attribute was set.

Returns

true if the 'reason' attribute was set.

New()

WorkerShutdownNotice * google_dataflow_api::WorkerShutdownNotice::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_reason()

void google_dataflow_api::WorkerShutdownNotice::set_reason ( const StringPiece &  value )

inline

Change the 'reason' attribute.

The reason for the worker shutdown. Current possible values are:

"UNKNOWN"

shutdown reason is unknown.

"PREEMPTION"

shutdown reason is preemption.

Other possible reasons may be added in the future.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/worker_shutdown_notice.h
• google/dataflow_api/worker_shutdown_notice.cc