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
Parameter
Name
Description
KmsKeyName const &
KmsKeyName
Parameter
Name
Description
KmsKeyName &&
KmsKeyName
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=
Parameter
Name
Description
KmsKeyName const &
Returns
Type
Description
KmsKeyName &
operator=
Parameter
Name
Description
KmsKeyName &&
Returns
Type
Description
KmsKeyName &
Functions
FullName
Returns the fully qualified KMS Key name as a string of the form: "projects/
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis page details the \u003ccode\u003eKmsKeyName\u003c/code\u003e class, which is used to identify a Google Cloud KMS key using its \u003ccode\u003eproject_id\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003ekey_ring\u003c/code\u003e, and \u003ccode\u003ekms_key_name\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class does not validate the key's components, meaning it is the application's responsibility to provide valid values.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available is \u003ccode\u003e2.37.0-rc\u003c/code\u003e, with various prior versions, down to \u003ccode\u003e2.10.1\u003c/code\u003e, also being accessible.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eKmsKeyName\u003c/code\u003e objects can be constructed using specified \u003ccode\u003eproject_id\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003ekey_ring\u003c/code\u003e, and \u003ccode\u003ekms_key_name\u003c/code\u003e, or using move or copy semantics.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFullName\u003c/code\u003e function returns the fully qualified KMS Key name as a string.\u003c/p\u003e\n"]]],[],null,[]]
