Google Cloud Storage C++ Client  1.32.1
A C++ Client Library for Google Cloud Storage
Public Member Functions | Static Public Member Functions | Friends | List of all members
google::cloud::storage::v1::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
 

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 48 of file hmac_key_metadata.h.

Constructor & Destructor Documentation

◆ HmacKeyMetadata()

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

Member Function Documentation

◆ access_id()

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

Definition at line 52 of file hmac_key_metadata.h.

◆ etag()

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

Definition at line 53 of file hmac_key_metadata.h.

◆ id()

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

Definition at line 59 of file hmac_key_metadata.h.

◆ kind()

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

Definition at line 60 of file hmac_key_metadata.h.

◆ project_id()

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

Definition at line 62 of file hmac_key_metadata.h.

◆ service_account_email()

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

Definition at line 63 of file hmac_key_metadata.h.

◆ set_etag()

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

Definition at line 54 of file hmac_key_metadata.h.

◆ set_state()

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

Definition at line 67 of file hmac_key_metadata.h.

◆ state()

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

Definition at line 66 of file hmac_key_metadata.h.

◆ state_active()

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

Definition at line 76 of file hmac_key_metadata.h.

◆ state_deleted()

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

Definition at line 78 of file hmac_key_metadata.h.

◆ state_inactive()

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

Definition at line 77 of file hmac_key_metadata.h.

◆ time_created()

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

Definition at line 71 of file hmac_key_metadata.h.

◆ updated()

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

Definition at line 74 of file hmac_key_metadata.h.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 22 of file hmac_key_metadata.cc.