google_storage_api::HmacKey Class Reference

#include <hmac_key.h>

Inheritance diagram for google_storage_api::HmacKey:

Public Member Functions
	HmacKey (const Json::Value &storage)
	HmacKey (Json::Value *storage)
virtual	~HmacKey ()
const StringPiece	GetTypeName () const
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_metadata () const
void	clear_metadata ()
const HmacKeyMetadata	get_metadata () const
HmacKeyMetadata	mutable_metadata ()
bool	has_secret () const
void	clear_secret ()
const StringPiece	get_secret () const
void	set_secret (const StringPiece &value)

Static Public Member Functions
static HmacKey *	New ()

Detailed Description

JSON template to produce a JSON-style HMAC Key resource for Create responses.

Constructor & Destructor Documentation

HmacKey() [1/2]

google_storage_api::HmacKey::HmacKey ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

HmacKey() [2/2]

google_storage_api::HmacKey::HmacKey ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~HmacKey()

google_storage_api::HmacKey::~HmacKey ( )

virtual

Standard destructor.

Member Function Documentation

clear_kind()

void google_storage_api::HmacKey::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_metadata()

void google_storage_api::HmacKey::clear_metadata ( )

inline

Clears the 'metadata' attribute.

clear_secret()

void google_storage_api::HmacKey::clear_secret ( )

inline

Clears the 'secret' attribute.

get_kind()

const StringPiece google_storage_api::HmacKey::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_metadata()

const HmacKeyMetadata google_storage_api::HmacKey::get_metadata

(

)

const

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

get_secret()

const StringPiece google_storage_api::HmacKey::get_secret ( ) const

inline

Get the value of the 'secret' attribute.

GetTypeName()

const StringPiece google_storage_api::HmacKey::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_storage_api::HmacKey

has_kind()

bool google_storage_api::HmacKey::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_metadata()

bool google_storage_api::HmacKey::has_metadata ( ) const

inline

Determine if the 'metadata' attribute was set.

Returns

true if the 'metadata' attribute was set.

has_secret()

bool google_storage_api::HmacKey::has_secret ( ) const

inline

Determine if the 'secret' attribute was set.

Returns

true if the 'secret' attribute was set.

mutable_metadata()

HmacKeyMetadata google_storage_api::HmacKey::mutable_metadata

(

)

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

Key metadata.

Returns

The result can be modified to change the attribute value.

New()

HmacKey * google_storage_api::HmacKey::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_kind()

void google_storage_api::HmacKey::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

The kind of item this is. For HMAC keys, this is always storage::hmacKey.

Parameters

[in]

value

The new value.

set_secret()

void google_storage_api::HmacKey::set_secret ( const StringPiece &  value )

inline

Change the 'secret' attribute.

HMAC secret key material.

Parameters

[in]

value

The new value.

---

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

• google/storage_api/hmac_key.h
• google/storage_api/hmac_key.cc