google_dataflow_api::Status Class Reference

#include <status.h>

Inheritance diagram for google_dataflow_api::Status:

Public Member Functions
	Status (const Json::Value &storage)
	Status (Json::Value *storage)
virtual	~Status ()
const StringPiece	GetTypeName () const
bool	has_code () const
void	clear_code ()
int32	get_code () const
void	set_code (int32 value)
bool	has_details () const
void	clear_details ()
const client::JsonCppArray< client::JsonCppAssociativeArray< client::JsonCppData > >	get_details () const
client::JsonCppArray< client::JsonCppAssociativeArray< client::JsonCppData > >	mutable_details ()
bool	has_message () const
void	clear_message ()
const StringPiece	get_message () const
void	set_message (const StringPiece &value)

Static Public Member Functions
static Status *	New ()

Detailed Description

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Constructor & Destructor Documentation

Status() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

Status() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~Status()

google_dataflow_api::Status::~Status ( )

virtual

Standard destructor.

Member Function Documentation

clear_code()

void google_dataflow_api::Status::clear_code ( )

inline

Clears the 'code' attribute.

clear_details()

void google_dataflow_api::Status::clear_details ( )

inline

Clears the 'details' attribute.

clear_message()

void google_dataflow_api::Status::clear_message ( )

inline

Clears the 'message' attribute.

get_code()

int32 google_dataflow_api::Status::get_code ( ) const

inline

Get the value of the 'code' attribute.

get_details()

const client::JsonCppArray<client::JsonCppAssociativeArray<client::JsonCppData > > google_dataflow_api::Status::get_details ( ) const

inline

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

get_message()

const StringPiece google_dataflow_api::Status::get_message ( ) const

inline

Get the value of the 'message' attribute.

GetTypeName()

const StringPiece google_dataflow_api::Status::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_dataflow_api::Status

has_code()

bool google_dataflow_api::Status::has_code ( ) const

inline

Determine if the 'code' attribute was set.

Returns

true if the 'code' attribute was set.

has_details()

bool google_dataflow_api::Status::has_details ( ) const

inline

Determine if the 'details' attribute was set.

Returns

true if the 'details' attribute was set.

has_message()

bool google_dataflow_api::Status::has_message ( ) const

inline

Determine if the 'message' attribute was set.

Returns

true if the 'message' attribute was set.

mutable_details()

client::JsonCppArray<client::JsonCppAssociativeArray<client::JsonCppData > > google_dataflow_api::Status::mutable_details ( )

inline

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

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Returns

The result can be modified to change the attribute value.

New()

Status * google_dataflow_api::Status::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_code()

void google_dataflow_api::Status::set_code ( int32  value )

inline

Change the 'code' attribute.

The status code, which should be an enum value of google.rpc.Code.

Parameters

[in]

value

The new value.

set_message()

void google_dataflow_api::Status::set_message ( const StringPiece &  value )

inline

Change the 'message' attribute.

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Parameters

[in]

value

The new value.

---

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

• google/dataflow_api/status.h
• google/dataflow_api/status.cc