google_deploymentmanager_api::DeploymentsStopRequest Class Reference

#include <deployments_stop_request.h>

Inheritance diagram for google_deploymentmanager_api::DeploymentsStopRequest:

Public Member Functions
	DeploymentsStopRequest (const Json::Value &storage)
	DeploymentsStopRequest (Json::Value *storage)
virtual	~DeploymentsStopRequest ()
const StringPiece	GetTypeName () const
bool	has_fingerprint () const
void	clear_fingerprint ()
const StringPiece	get_fingerprint () const
void	set_fingerprint (const StringPiece &value)

Static Public Member Functions
static DeploymentsStopRequest *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

DeploymentsStopRequest() [1/2]

google_deploymentmanager_api::DeploymentsStopRequest::DeploymentsStopRequest ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

DeploymentsStopRequest() [2/2]

google_deploymentmanager_api::DeploymentsStopRequest::DeploymentsStopRequest ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~DeploymentsStopRequest()

google_deploymentmanager_api::DeploymentsStopRequest::~DeploymentsStopRequest ( )

virtual

Standard destructor.

Member Function Documentation

clear_fingerprint()

void google_deploymentmanager_api::DeploymentsStopRequest::clear_fingerprint ( )

inline

Clears the 'fingerprint' attribute.

get_fingerprint()

const StringPiece google_deploymentmanager_api::DeploymentsStopRequest::get_fingerprint ( ) const

inline

Get the value of the 'fingerprint' attribute.

GetTypeName()

const StringPiece google_deploymentmanager_api::DeploymentsStopRequest::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_deploymentmanager_api::DeploymentsStopRequest

has_fingerprint()

bool google_deploymentmanager_api::DeploymentsStopRequest::has_fingerprint ( ) const

inline

Determine if the 'fingerprint' attribute was set.

Returns

true if the 'fingerprint' attribute was set.

New()

DeploymentsStopRequest * google_deploymentmanager_api::DeploymentsStopRequest::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_fingerprint()

void google_deploymentmanager_api::DeploymentsStopRequest::set_fingerprint ( const StringPiece &  value )

inline

Change the 'fingerprint' attribute.

Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).

The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.

Parameters

[in]

value

The new value.

---

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

• google/deploymentmanager_api/deployments_stop_request.h
• google/deploymentmanager_api/deployments_stop_request.cc