Class KeyDashboardServiceClient (2.16.0)

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(KeyDashboardServiceClient const &)

Copy and move support

Parameter
Name Description
KeyDashboardServiceClient const &

KeyDashboardServiceClient(KeyDashboardServiceClient &&)

Copy and move support

Parameter
Name Description
KeyDashboardServiceClient &&

KeyDashboardServiceClient(std::shared_ptr< KeyDashboardServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< KeyDashboardServiceConnection >
opts Options

Operators

operator=(KeyDashboardServiceClient const &)

Copy and move support

Parameter
Name Description
KeyDashboardServiceClient const &
Returns
Type Description
KeyDashboardServiceClient &

operator=(KeyDashboardServiceClient &&)

Copy and move support

Parameter
Name Description
KeyDashboardServiceClient &&
Returns
Type Description
KeyDashboardServiceClient &

Functions

ListCryptoKeys(std::string const &, Options)

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 projects/*
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::kms::v1::CryptoKey >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.kms.v1.CryptoKey, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCryptoKeys(google::cloud::kms::inventory::v1::ListCryptoKeysRequest, Options)

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

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.kms.inventory.v1.ListCryptoKeysRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::kms::v1::CryptoKey >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.kms.v1.CryptoKey, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.