Google Cloud Storage C++ Client  2.7.0
A C++ Client Library for Google Cloud Storage
Public Member Functions | Static Public Member Functions | Friends | List of all members
google::cloud::storage::HmacKeyMetadata Class Reference

Represents the metadata for a Google Cloud Storage HmacKeyResource. More...

#include <google/cloud/storage/hmac_key_metadata.h>

Public Member Functions

 HmacKeyMetadata ()=default
 
std::string const & access_id () const
 
std::string const & etag () const
 
HmacKeyMetadataset_etag (std::string v)
 
std::string const & id () const
 
std::string const & kind () const
 
std::string const & project_id () const
 
std::string const & service_account_email () const
 
std::string const & state () const
 
HmacKeyMetadataset_state (std::string v)
 
std::chrono::system_clock::time_point time_created () const
 
std::chrono::system_clock::time_point updated () const
 
Testing modifiers.

The following attributes cannot be changed when updating, creating, or patching an HmacKeyMetadata resource.

However, it is useful to change them in tests, e.g., when mocking the results from the C++ client library.

HmacKeyMetadataset_access_id (std::string v)
 
HmacKeyMetadataset_id (std::string v)
 
HmacKeyMetadataset_kind (std::string v)
 
HmacKeyMetadataset_project_id (std::string v)
 
HmacKeyMetadataset_service_account_email (std::string v)
 
HmacKeyMetadataset_time_created (std::chrono::system_clock::time_point v)
 
HmacKeyMetadataset_updated (std::chrono::system_clock::time_point v)
 

Static Public Member Functions

static std::string state_active ()
 
static std::string state_inactive ()
 
static std::string state_deleted ()
 

Friends

std::ostream & operator<< (std::ostream &os, HmacKeyMetadata const &rhs)
 

Detailed Description

Represents the metadata for a Google Cloud Storage HmacKeyResource.

HMAC keys allow applications to authenticate with Google Cloud Storage using HMAC authentication. Applications can create a limited number of HMAC keys associated with a service account. The application can use the HMAC keys to authenticate with GCS. GCS will use the service account permissions to determine if the request is authorized.

See also
https://cloud.google.com/storage/docs/authentication/hmackeys for general information on HMAC keys.
https://cloud.google.com/storage/ for general information on Google Cloud Storage.

Definition at line 45 of file hmac_key_metadata.h.

Constructor & Destructor Documentation

◆ HmacKeyMetadata()

google::cloud::storage::HmacKeyMetadata::HmacKeyMetadata ( )
default

Member Function Documentation

◆ access_id()

std::string const& google::cloud::storage::HmacKeyMetadata::access_id ( ) const
inline

Definition at line 49 of file hmac_key_metadata.h.

◆ etag()

std::string const& google::cloud::storage::HmacKeyMetadata::etag ( ) const
inline

Definition at line 50 of file hmac_key_metadata.h.

◆ id()

std::string const& google::cloud::storage::HmacKeyMetadata::id ( ) const
inline

Definition at line 56 of file hmac_key_metadata.h.

◆ kind()

std::string const& google::cloud::storage::HmacKeyMetadata::kind ( ) const
inline

Definition at line 57 of file hmac_key_metadata.h.

◆ project_id()

std::string const& google::cloud::storage::HmacKeyMetadata::project_id ( ) const
inline

Definition at line 59 of file hmac_key_metadata.h.

◆ service_account_email()

std::string const& google::cloud::storage::HmacKeyMetadata::service_account_email ( ) const
inline

Definition at line 60 of file hmac_key_metadata.h.

◆ set_access_id()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_access_id ( std::string  v)
inline

Definition at line 85 of file hmac_key_metadata.h.

◆ set_etag()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_etag ( std::string  v)
inline

Definition at line 51 of file hmac_key_metadata.h.

◆ set_id()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_id ( std::string  v)
inline

Definition at line 89 of file hmac_key_metadata.h.

◆ set_kind()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_kind ( std::string  v)
inline

Definition at line 94 of file hmac_key_metadata.h.

◆ set_project_id()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_project_id ( std::string  v)
inline

Definition at line 98 of file hmac_key_metadata.h.

◆ set_service_account_email()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_service_account_email ( std::string  v)
inline

Definition at line 102 of file hmac_key_metadata.h.

◆ set_state()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_state ( std::string  v)
inline

Definition at line 64 of file hmac_key_metadata.h.

◆ set_time_created()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_time_created ( std::chrono::system_clock::time_point  v)
inline

Definition at line 106 of file hmac_key_metadata.h.

◆ set_updated()

HmacKeyMetadata& google::cloud::storage::HmacKeyMetadata::set_updated ( std::chrono::system_clock::time_point  v)
inline

Definition at line 110 of file hmac_key_metadata.h.

◆ state()

std::string const& google::cloud::storage::HmacKeyMetadata::state ( ) const
inline

Definition at line 63 of file hmac_key_metadata.h.

◆ state_active()

static std::string google::cloud::storage::HmacKeyMetadata::state_active ( )
inlinestatic

Definition at line 73 of file hmac_key_metadata.h.

◆ state_deleted()

static std::string google::cloud::storage::HmacKeyMetadata::state_deleted ( )
inlinestatic

Definition at line 75 of file hmac_key_metadata.h.

◆ state_inactive()

static std::string google::cloud::storage::HmacKeyMetadata::state_inactive ( )
inlinestatic

Definition at line 74 of file hmac_key_metadata.h.

◆ time_created()

std::chrono::system_clock::time_point google::cloud::storage::HmacKeyMetadata::time_created ( ) const
inline

Definition at line 68 of file hmac_key_metadata.h.

◆ updated()

std::chrono::system_clock::time_point google::cloud::storage::HmacKeyMetadata::updated ( ) const
inline

Definition at line 71 of file hmac_key_metadata.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
HmacKeyMetadata const &  rhs 
)
friend