deploymentmanager  v2
Classes | Public Member Functions | Static Public Member Functions | List of all members
google_deploymentmanager_api::Operation Class Reference
Google Cloud Deployment Manager API Data Objects

#include <operation.h>

Inheritance diagram for google_deploymentmanager_api::Operation:

Classes

class  OperationError
 
class  OperationWarnings
 

Public Member Functions

 Operation (const Json::Value &storage)
 
 Operation (Json::Value *storage)
 
virtual ~Operation ()
 
const StringPiece GetTypeName () const
 
bool has_client_operation_id () const
 
void clear_client_operation_id ()
 
const StringPiece get_client_operation_id () const
 
void set_client_operation_id (const StringPiece &value)
 
bool has_creation_timestamp () const
 
void clear_creation_timestamp ()
 
const StringPiece get_creation_timestamp () const
 
void set_creation_timestamp (const StringPiece &value)
 
bool has_description () const
 
void clear_description ()
 
const StringPiece get_description () const
 
void set_description (const StringPiece &value)
 
bool has_end_time () const
 
void clear_end_time ()
 
const StringPiece get_end_time () const
 
void set_end_time (const StringPiece &value)
 
bool has_error () const
 
void clear_error ()
 
const OperationError get_error () const
 
OperationError mutable_error ()
 
bool has_http_error_message () const
 
void clear_http_error_message ()
 
const StringPiece get_http_error_message () const
 
void set_http_error_message (const StringPiece &value)
 
bool has_http_error_status_code () const
 
void clear_http_error_status_code ()
 
int32 get_http_error_status_code () const
 
void set_http_error_status_code (int32 value)
 
bool has_id () const
 
void clear_id ()
 
uint64 get_id () const
 
void set_id (uint64 value)
 
bool has_insert_time () const
 
void clear_insert_time ()
 
const StringPiece get_insert_time () const
 
void set_insert_time (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_name () const
 
void clear_name ()
 
const StringPiece get_name () const
 
void set_name (const StringPiece &value)
 
bool has_operation_type () const
 
void clear_operation_type ()
 
const StringPiece get_operation_type () const
 
void set_operation_type (const StringPiece &value)
 
bool has_progress () const
 
void clear_progress ()
 
int32 get_progress () const
 
void set_progress (int32 value)
 
bool has_region () const
 
void clear_region ()
 
const StringPiece get_region () const
 
void set_region (const StringPiece &value)
 
bool has_self_link () const
 
void clear_self_link ()
 
const StringPiece get_self_link () const
 
void set_self_link (const StringPiece &value)
 
bool has_start_time () const
 
void clear_start_time ()
 
const StringPiece get_start_time () const
 
void set_start_time (const StringPiece &value)
 
bool has_status () const
 
void clear_status ()
 
const StringPiece get_status () const
 
void set_status (const StringPiece &value)
 
bool has_status_message () const
 
void clear_status_message ()
 
const StringPiece get_status_message () const
 
void set_status_message (const StringPiece &value)
 
bool has_target_id () const
 
void clear_target_id ()
 
uint64 get_target_id () const
 
void set_target_id (uint64 value)
 
bool has_target_link () const
 
void clear_target_link ()
 
const StringPiece get_target_link () const
 
void set_target_link (const StringPiece &value)
 
bool has_user () const
 
void clear_user ()
 
const StringPiece get_user () const
 
void set_user (const StringPiece &value)
 
bool has_warnings () const
 
void clear_warnings ()
 
const client::JsonCppArray< OperationWarnings > get_warnings () const
 
client::JsonCppArray< OperationWarnings > mutable_warnings ()
 
bool has_zone () const
 
void clear_zone ()
 
const StringPiece get_zone () const
 
void set_zone (const StringPiece &value)
 

Static Public Member Functions

static Operation * New ()
 

Detailed Description

An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==).

Constructor & Destructor Documentation

◆ Operation() [1/2]

google_deploymentmanager_api::Operation::Operation ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ Operation() [2/2]

google_deploymentmanager_api::Operation::Operation ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~Operation()

google_deploymentmanager_api::Operation::~Operation ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_client_operation_id()

void google_deploymentmanager_api::Operation::clear_client_operation_id ( )
inline

Clears the 'clientOperationId' attribute.

◆ clear_creation_timestamp()

void google_deploymentmanager_api::Operation::clear_creation_timestamp ( )
inline

Clears the 'creationTimestamp' attribute.

◆ clear_description()

void google_deploymentmanager_api::Operation::clear_description ( )
inline

Clears the 'description' attribute.

◆ clear_end_time()

void google_deploymentmanager_api::Operation::clear_end_time ( )
inline

Clears the 'endTime' attribute.

◆ clear_error()

void google_deploymentmanager_api::Operation::clear_error ( )
inline

Clears the 'error' attribute.

◆ clear_http_error_message()

void google_deploymentmanager_api::Operation::clear_http_error_message ( )
inline

Clears the 'httpErrorMessage' attribute.

◆ clear_http_error_status_code()

void google_deploymentmanager_api::Operation::clear_http_error_status_code ( )
inline

Clears the 'httpErrorStatusCode' attribute.

◆ clear_id()

void google_deploymentmanager_api::Operation::clear_id ( )
inline

Clears the 'id' attribute.

◆ clear_insert_time()

void google_deploymentmanager_api::Operation::clear_insert_time ( )
inline

Clears the 'insertTime' attribute.

◆ clear_kind()

void google_deploymentmanager_api::Operation::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_name()

void google_deploymentmanager_api::Operation::clear_name ( )
inline

Clears the 'name' attribute.

◆ clear_operation_type()

void google_deploymentmanager_api::Operation::clear_operation_type ( )
inline

Clears the 'operationType' attribute.

◆ clear_progress()

void google_deploymentmanager_api::Operation::clear_progress ( )
inline

Clears the 'progress' attribute.

◆ clear_region()

void google_deploymentmanager_api::Operation::clear_region ( )
inline

Clears the 'region' attribute.

◆ clear_self_link()

void google_deploymentmanager_api::Operation::clear_self_link ( )
inline

Clears the 'selfLink' attribute.

◆ clear_start_time()

void google_deploymentmanager_api::Operation::clear_start_time ( )
inline

Clears the 'startTime' attribute.

◆ clear_status()

void google_deploymentmanager_api::Operation::clear_status ( )
inline

Clears the 'status' attribute.

◆ clear_status_message()

void google_deploymentmanager_api::Operation::clear_status_message ( )
inline

Clears the 'statusMessage' attribute.

◆ clear_target_id()

void google_deploymentmanager_api::Operation::clear_target_id ( )
inline

Clears the 'targetId' attribute.

◆ clear_target_link()

void google_deploymentmanager_api::Operation::clear_target_link ( )
inline

Clears the 'targetLink' attribute.

◆ clear_user()

void google_deploymentmanager_api::Operation::clear_user ( )
inline

Clears the 'user' attribute.

◆ clear_warnings()

void google_deploymentmanager_api::Operation::clear_warnings ( )
inline

Clears the 'warnings' attribute.

◆ clear_zone()

void google_deploymentmanager_api::Operation::clear_zone ( )
inline

Clears the 'zone' attribute.

◆ get_client_operation_id()

const StringPiece google_deploymentmanager_api::Operation::get_client_operation_id ( ) const
inline

Get the value of the 'clientOperationId' attribute.

◆ get_creation_timestamp()

const StringPiece google_deploymentmanager_api::Operation::get_creation_timestamp ( ) const
inline

Get the value of the 'creationTimestamp' attribute.

◆ get_description()

const StringPiece google_deploymentmanager_api::Operation::get_description ( ) const
inline

Get the value of the 'description' attribute.

◆ get_end_time()

const StringPiece google_deploymentmanager_api::Operation::get_end_time ( ) const
inline

Get the value of the 'endTime' attribute.

◆ get_error()

const OperationError google_deploymentmanager_api::Operation::get_error ( ) const
inline

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

◆ get_http_error_message()

const StringPiece google_deploymentmanager_api::Operation::get_http_error_message ( ) const
inline

Get the value of the 'httpErrorMessage' attribute.

◆ get_http_error_status_code()

int32 google_deploymentmanager_api::Operation::get_http_error_status_code ( ) const
inline

Get the value of the 'httpErrorStatusCode' attribute.

◆ get_id()

uint64 google_deploymentmanager_api::Operation::get_id ( ) const
inline

Get the value of the 'id' attribute.

◆ get_insert_time()

const StringPiece google_deploymentmanager_api::Operation::get_insert_time ( ) const
inline

Get the value of the 'insertTime' attribute.

◆ get_kind()

const StringPiece google_deploymentmanager_api::Operation::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_name()

const StringPiece google_deploymentmanager_api::Operation::get_name ( ) const
inline

Get the value of the 'name' attribute.

◆ get_operation_type()

const StringPiece google_deploymentmanager_api::Operation::get_operation_type ( ) const
inline

Get the value of the 'operationType' attribute.

◆ get_progress()

int32 google_deploymentmanager_api::Operation::get_progress ( ) const
inline

Get the value of the 'progress' attribute.

◆ get_region()

const StringPiece google_deploymentmanager_api::Operation::get_region ( ) const
inline

Get the value of the 'region' attribute.

◆ get_self_link()

const StringPiece google_deploymentmanager_api::Operation::get_self_link ( ) const
inline

Get the value of the 'selfLink' attribute.

◆ get_start_time()

const StringPiece google_deploymentmanager_api::Operation::get_start_time ( ) const
inline

Get the value of the 'startTime' attribute.

◆ get_status()

const StringPiece google_deploymentmanager_api::Operation::get_status ( ) const
inline

Get the value of the 'status' attribute.

◆ get_status_message()

const StringPiece google_deploymentmanager_api::Operation::get_status_message ( ) const
inline

Get the value of the 'statusMessage' attribute.

◆ get_target_id()

uint64 google_deploymentmanager_api::Operation::get_target_id ( ) const
inline

Get the value of the 'targetId' attribute.

◆ get_target_link()

const StringPiece google_deploymentmanager_api::Operation::get_target_link ( ) const
inline

Get the value of the 'targetLink' attribute.

◆ get_user()

const StringPiece google_deploymentmanager_api::Operation::get_user ( ) const
inline

Get the value of the 'user' attribute.

◆ get_warnings()

const client::JsonCppArray<OperationWarnings > google_deploymentmanager_api::Operation::get_warnings ( ) const
inline

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

◆ get_zone()

const StringPiece google_deploymentmanager_api::Operation::get_zone ( ) const
inline

Get the value of the 'zone' attribute.

◆ GetTypeName()

const StringPiece google_deploymentmanager_api::Operation::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_deploymentmanager_api::Operation

◆ has_client_operation_id()

bool google_deploymentmanager_api::Operation::has_client_operation_id ( ) const
inline

Determine if the 'clientOperationId' attribute was set.

Returns
true if the 'clientOperationId' attribute was set.

◆ has_creation_timestamp()

bool google_deploymentmanager_api::Operation::has_creation_timestamp ( ) const
inline

Determine if the 'creationTimestamp' attribute was set.

Returns
true if the 'creationTimestamp' attribute was set.

◆ has_description()

bool google_deploymentmanager_api::Operation::has_description ( ) const
inline

Determine if the 'description' attribute was set.

Returns
true if the 'description' attribute was set.

◆ has_end_time()

bool google_deploymentmanager_api::Operation::has_end_time ( ) const
inline

Determine if the 'endTime' attribute was set.

Returns
true if the 'endTime' attribute was set.

◆ has_error()

bool google_deploymentmanager_api::Operation::has_error ( ) const
inline

Determine if the 'error' attribute was set.

Returns
true if the 'error' attribute was set.

◆ has_http_error_message()

bool google_deploymentmanager_api::Operation::has_http_error_message ( ) const
inline

Determine if the 'httpErrorMessage' attribute was set.

Returns
true if the 'httpErrorMessage' attribute was set.

◆ has_http_error_status_code()

bool google_deploymentmanager_api::Operation::has_http_error_status_code ( ) const
inline

Determine if the 'httpErrorStatusCode' attribute was set.

Returns
true if the 'httpErrorStatusCode' attribute was set.

◆ has_id()

bool google_deploymentmanager_api::Operation::has_id ( ) const
inline

Determine if the 'id' attribute was set.

Returns
true if the 'id' attribute was set.

◆ has_insert_time()

bool google_deploymentmanager_api::Operation::has_insert_time ( ) const
inline

Determine if the 'insertTime' attribute was set.

Returns
true if the 'insertTime' attribute was set.

◆ has_kind()

bool google_deploymentmanager_api::Operation::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_name()

bool google_deploymentmanager_api::Operation::has_name ( ) const
inline

Determine if the 'name' attribute was set.

Returns
true if the 'name' attribute was set.

◆ has_operation_type()

bool google_deploymentmanager_api::Operation::has_operation_type ( ) const
inline

Determine if the 'operationType' attribute was set.

Returns
true if the 'operationType' attribute was set.

◆ has_progress()

bool google_deploymentmanager_api::Operation::has_progress ( ) const
inline

Determine if the 'progress' attribute was set.

Returns
true if the 'progress' attribute was set.

◆ has_region()

bool google_deploymentmanager_api::Operation::has_region ( ) const
inline

Determine if the 'region' attribute was set.

Returns
true if the 'region' attribute was set.

◆ has_self_link()

bool google_deploymentmanager_api::Operation::has_self_link ( ) const
inline

Determine if the 'selfLink' attribute was set.

Returns
true if the 'selfLink' attribute was set.

◆ has_start_time()

bool google_deploymentmanager_api::Operation::has_start_time ( ) const
inline

Determine if the 'startTime' attribute was set.

Returns
true if the 'startTime' attribute was set.

◆ has_status()

bool google_deploymentmanager_api::Operation::has_status ( ) const
inline

Determine if the 'status' attribute was set.

Returns
true if the 'status' attribute was set.

◆ has_status_message()

bool google_deploymentmanager_api::Operation::has_status_message ( ) const
inline

Determine if the 'statusMessage' attribute was set.

Returns
true if the 'statusMessage' attribute was set.

◆ has_target_id()

bool google_deploymentmanager_api::Operation::has_target_id ( ) const
inline

Determine if the 'targetId' attribute was set.

Returns
true if the 'targetId' attribute was set.

◆ has_target_link()

bool google_deploymentmanager_api::Operation::has_target_link ( ) const
inline

Determine if the 'targetLink' attribute was set.

Returns
true if the 'targetLink' attribute was set.

◆ has_user()

bool google_deploymentmanager_api::Operation::has_user ( ) const
inline

Determine if the 'user' attribute was set.

Returns
true if the 'user' attribute was set.

◆ has_warnings()

bool google_deploymentmanager_api::Operation::has_warnings ( ) const
inline

Determine if the 'warnings' attribute was set.

Returns
true if the 'warnings' attribute was set.

◆ has_zone()

bool google_deploymentmanager_api::Operation::has_zone ( ) const
inline

Determine if the 'zone' attribute was set.

Returns
true if the 'zone' attribute was set.

◆ mutable_error()

OperationError google_deploymentmanager_api::Operation::mutable_error ( )
inline

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

[Output Only] If errors are generated during processing of the operation, this field will be populated.

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

◆ mutable_warnings()

client::JsonCppArray<OperationWarnings > google_deploymentmanager_api::Operation::mutable_warnings ( )
inline

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

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

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

◆ New()

Operation * google_deploymentmanager_api::Operation::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_client_operation_id()

void google_deploymentmanager_api::Operation::set_client_operation_id ( const StringPiece &  value)
inline

Change the 'clientOperationId' attribute.

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

Parameters
[in]valueThe new value.

◆ set_creation_timestamp()

void google_deploymentmanager_api::Operation::set_creation_timestamp ( const StringPiece &  value)
inline

Change the 'creationTimestamp' attribute.

Deprecated:

[Deprecated] This field is deprecated.

Parameters
[in]valueThe new value.

◆ set_description()

void google_deploymentmanager_api::Operation::set_description ( const StringPiece &  value)
inline

Change the 'description' attribute.

[Output Only] A textual description of the operation, which is set when the operation is created.

Parameters
[in]valueThe new value.

◆ set_end_time()

void google_deploymentmanager_api::Operation::set_end_time ( const StringPiece &  value)
inline

Change the 'endTime' attribute.

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_http_error_message()

void google_deploymentmanager_api::Operation::set_http_error_message ( const StringPiece &  value)
inline

Change the 'httpErrorMessage' attribute.

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Parameters
[in]valueThe new value.

◆ set_http_error_status_code()

void google_deploymentmanager_api::Operation::set_http_error_status_code ( int32  value)
inline

Change the 'httpErrorStatusCode' attribute.

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Parameters
[in]valueThe new value.

◆ set_id()

void google_deploymentmanager_api::Operation::set_id ( uint64  value)
inline

Change the 'id' attribute.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters
[in]valueThe new value.

◆ set_insert_time()

void google_deploymentmanager_api::Operation::set_insert_time ( const StringPiece &  value)
inline

Change the 'insertTime' attribute.

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_deploymentmanager_api::Operation::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

[Output Only] Type of the resource. Always compute::operation for Operation resources.

Parameters
[in]valueThe new value.

◆ set_name()

void google_deploymentmanager_api::Operation::set_name ( const StringPiece &  value)
inline

Change the 'name' attribute.

[Output Only] Name of the resource.

Parameters
[in]valueThe new value.

◆ set_operation_type()

void google_deploymentmanager_api::Operation::set_operation_type ( const StringPiece &  value)
inline

Change the 'operationType' attribute.

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Parameters
[in]valueThe new value.

◆ set_progress()

void google_deploymentmanager_api::Operation::set_progress ( int32  value)
inline

Change the 'progress' attribute.

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Parameters
[in]valueThe new value.

◆ set_region()

void google_deploymentmanager_api::Operation::set_region ( const StringPiece &  value)
inline

Change the 'region' attribute.

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters
[in]valueThe new value.

◆ set_self_link()

void google_deploymentmanager_api::Operation::set_self_link ( const StringPiece &  value)
inline

Change the 'selfLink' attribute.

[Output Only] Server-defined URL for the resource.

Parameters
[in]valueThe new value.

◆ set_start_time()

void google_deploymentmanager_api::Operation::set_start_time ( const StringPiece &  value)
inline

Change the 'startTime' attribute.

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Parameters
[in]valueThe new value.

◆ set_status()

void google_deploymentmanager_api::Operation::set_status ( const StringPiece &  value)
inline

Change the 'status' attribute.

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Parameters
[in]valueThe new value.

◆ set_status_message()

void google_deploymentmanager_api::Operation::set_status_message ( const StringPiece &  value)
inline

Change the 'statusMessage' attribute.

[Output Only] An optional textual description of the current status of the operation.

Parameters
[in]valueThe new value.

◆ set_target_id()

void google_deploymentmanager_api::Operation::set_target_id ( uint64  value)
inline

Change the 'targetId' attribute.

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Parameters
[in]valueThe new value.

◆ set_target_link()

void google_deploymentmanager_api::Operation::set_target_link ( const StringPiece &  value)
inline

Change the 'targetLink' attribute.

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

Parameters
[in]valueThe new value.

◆ set_user()

void google_deploymentmanager_api::Operation::set_user ( const StringPiece &  value)
inline

Change the 'user' attribute.

[Output Only] User who requested the operation, for example: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om.

Parameters
[in]valueThe new value.

◆ set_zone()

void google_deploymentmanager_api::Operation::set_zone ( const StringPiece &  value)
inline

Change the 'zone' attribute.

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters
[in]valueThe new value.
The documentation for this class was generated from the following files: