Provides a cross-region view of all Cloud KMS keys in a given Cloud project.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
KeyDashboardServiceClient
| Parameter | |
|---|---|
| Name | Description |
|
KeyDashboardServiceClient const &
|
KeyDashboardServiceClient
| Parameter | |
|---|---|
| Name | Description |
|
KeyDashboardServiceClient &&
|
KeyDashboardServiceClient
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< KeyDashboardServiceConnection >
|
opts |
Options
|
~KeyDashboardServiceClient
Operators
operator=
| Parameter | |
|---|---|
| Name | Description |
|
KeyDashboardServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
KeyDashboardServiceClient & |
|
operator=
| Parameter | |
|---|---|
| Name | Description |
|
KeyDashboardServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
KeyDashboardServiceClient & |
|
Functions
ListCryptoKeys
Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The Google Cloud project for which to retrieve key metadata, in the format |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::kms::v1::CryptoKey > |
[`google::cloud::kms::v1::CryptoKey`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/resources.proto#L58) |
ListCryptoKeys
Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::kms::inventory::v1::ListCryptoKeysRequest
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::kms::v1::CryptoKey > |
[`google::cloud::kms::v1::CryptoKey`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/resources.proto#L58) |