google_container_api::OperationProgress Class Reference

#include <operation_progress.h>

Inheritance diagram for google_container_api::OperationProgress:

Public Member Functions
	OperationProgress (const Json::Value &storage)
	OperationProgress (Json::Value *storage)
virtual	~OperationProgress ()
const StringPiece	GetTypeName () const
bool	has_metrics () const
void	clear_metrics ()
const client::JsonCppArray< Metric >	get_metrics () const
client::JsonCppArray< Metric >	mutable_metrics ()
bool	has_name () const
void	clear_name ()
const StringPiece	get_name () const
void	set_name (const StringPiece &value)
bool	has_stages () const
void	clear_stages ()
const client::JsonCppArray< OperationProgress >	get_stages () const
client::JsonCppArray< OperationProgress >	mutable_stages ()
bool	has_status () const
void	clear_status ()
const StringPiece	get_status () const
void	set_status (const StringPiece &value)

Static Public Member Functions
static OperationProgress *	New ()

Detailed Description

Information about operation (or operation stage) progress.

Constructor & Destructor Documentation

OperationProgress() [1/2]

google_container_api::OperationProgress::OperationProgress ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

OperationProgress() [2/2]

google_container_api::OperationProgress::OperationProgress ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~OperationProgress()

google_container_api::OperationProgress::~OperationProgress ( )

virtual

Standard destructor.

Member Function Documentation

clear_metrics()

void google_container_api::OperationProgress::clear_metrics ( )

inline

Clears the 'metrics' attribute.

clear_name()

void google_container_api::OperationProgress::clear_name ( )

inline

Clears the 'name' attribute.

clear_stages()

void google_container_api::OperationProgress::clear_stages ( )

inline

Clears the 'stages' attribute.

clear_status()

void google_container_api::OperationProgress::clear_status ( )

inline

Clears the 'status' attribute.

get_metrics()

const client::JsonCppArray<Metric > google_container_api::OperationProgress::get_metrics

(

)

const

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

get_name()

const StringPiece google_container_api::OperationProgress::get_name ( ) const

inline

Get the value of the 'name' attribute.

get_stages()

const client::JsonCppArray<OperationProgress > google_container_api::OperationProgress::get_stages

(

)

const

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

get_status()

const StringPiece google_container_api::OperationProgress::get_status ( ) const

inline

Get the value of the 'status' attribute.

GetTypeName()

const StringPiece google_container_api::OperationProgress::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_container_api::OperationProgress

has_metrics()

bool google_container_api::OperationProgress::has_metrics ( ) const

inline

Determine if the 'metrics' attribute was set.

Returns

true if the 'metrics' attribute was set.

has_name()

bool google_container_api::OperationProgress::has_name ( ) const

inline

Determine if the 'name' attribute was set.

Returns

true if the 'name' attribute was set.

has_stages()

bool google_container_api::OperationProgress::has_stages ( ) const

inline

Determine if the 'stages' attribute was set.

Returns

true if the 'stages' attribute was set.

has_status()

bool google_container_api::OperationProgress::has_status ( ) const

inline

Determine if the 'status' attribute was set.

Returns

true if the 'status' attribute was set.

mutable_metrics()

client::JsonCppArray<Metric > google_container_api::OperationProgress::mutable_metrics

(

)

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

Progress metric bundle, for example:

metrics

[{name: "nodes done", int_value: 15},.

{name

"nodes total", int_value: 32}].

or

metrics

[{name: "progress", double_value: 0.56},.

{name

"progress scale", double_value: 1.0}].

Returns

The result can be modified to change the attribute value.

mutable_stages()

client::JsonCppArray<OperationProgress > google_container_api::OperationProgress::mutable_stages

(

)

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

Substages of an operation or a stage.

Returns

The result can be modified to change the attribute value.

New()

OperationProgress * google_container_api::OperationProgress::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_name()

void google_container_api::OperationProgress::set_name ( const StringPiece &  value )

inline

Change the 'name' attribute.

A non-parameterized string describing an operation stage. Unset for single-stage operations.

Parameters

[in]

value

The new value.

set_status()

void google_container_api::OperationProgress::set_status ( const StringPiece &  value )

inline

Change the 'status' attribute.

Status of an operation stage. Unset for single-stage operations.

Parameters

[in]

value

The new value.

---

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

• google/container_api/operation_progress.h
• google/container_api/operation_progress.cc