Class HmacKeyMetadata (2.28.0)

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.

See Also

https://cloud.google.com/storage/ for general information on Google Cloud Storage.

Constructors

HmacKeyMetadata()

Functions

set_access_id(std::string)

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.

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

set_id(std::string)

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.

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

set_kind(std::string)

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.

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

set_project_id(std::string)

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.

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

set_service_account_email(std::string)

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.

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

set_time_created(std::chrono::system_clock::time_point)

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.

Parameter
Name Description
v std::chrono::system_clock::time_point
Returns
Type Description
HmacKeyMetadata &

set_updated(std::chrono::system_clock::time_point)

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.

Parameter
Name Description
v std::chrono::system_clock::time_point
Returns
Type Description
HmacKeyMetadata &

access_id() const

Returns
Type Description
std::string const &

etag() const

Returns
Type Description
std::string const &

set_etag(std::string)

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

id() const

Returns
Type Description
std::string const &

kind() const

Returns
Type Description
std::string const &

project_id() const

Returns
Type Description
std::string const &

service_account_email() const

Returns
Type Description
std::string const &

state() const

Returns
Type Description
std::string const &

set_state(std::string)

Parameter
Name Description
v std::string
Returns
Type Description
HmacKeyMetadata &

time_created() const

Returns
Type Description
std::chrono::system_clock::time_point

updated() const

Returns
Type Description
std::chrono::system_clock::time_point

static state_active()

Returns
Type Description
std::string

static state_inactive()

Returns
Type Description
std::string

static state_deleted()

Returns
Type Description
std::string