Class KmsKeyName (2.20.0)

Version 2.20.0

• 2.26.0-rc (latest)
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.1

This class identifies a Google Cloud KMS Key.

A KMS key is identified by its project_id, location, key_ring, and kms_key_name.

Note: This class makes no effort to validate the components of the key, It is the application's responsibility to provide a valid project id, location, key ring, and KMS key name. Passing invalid values will not be checked until the key is used in a RPC.

See https://cloud.google.com/kms/docs for more information on KMS.

Constructors

KmsKeyName(KmsKeyName const &)

Copy and move

Parameter
Name	Description
	KmsKeyName const &

KmsKeyName(KmsKeyName &&)

Copy and move

Parameter
Name	Description
	KmsKeyName &&

KmsKeyName(std::string const &, std::string const &, std::string const &, std::string const &)

Constructs a KmsKeyName object identified by the given project_id, location, key_ring, and kms_key_name.

Parameters
Name	Description
project_id	std::string const &
location	std::string const &
key_ring	std::string const &
kms_key_name	std::string const &

Operators

operator=(KmsKeyName const &)

Copy and move

Parameter
Name	Description
	KmsKeyName const &

Returns
Type	Description
KmsKeyName &

operator=(KmsKeyName &&)

Copy and move

Parameter
Name	Description
	KmsKeyName &&

Returns
Type	Description
KmsKeyName &

Functions

FullName() const

Returns the fully qualified KMS Key name as a string of the form: "projects/

Returns
Type	Description
std::string const &