Class google::cloud::kms_inventory_v1::KeyTrackingServiceClient (2.10.1)

Version 2.10.1

• 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

Returns information about the resources in an org that are protected by a given Cloud KMS key via CMEK.

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

KeyTrackingServiceClient

Parameter
Name	Description
	KeyTrackingServiceClient const &

KeyTrackingServiceClient

Parameter
Name	Description
	KeyTrackingServiceClient &&

KeyTrackingServiceClient

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

~KeyTrackingServiceClient

Operators

operator=

Parameter
Name	Description
	KeyTrackingServiceClient const &

Returns
Type	Description
KeyTrackingServiceClient &

operator=

Parameter
Name	Description
	KeyTrackingServiceClient &&

Returns
Type	Description
KeyTrackingServiceClient &

Functions

GetProtectedResourcesSummary

Returns aggregate information about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey].

Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Parameters
Name	Description
name	std::string const & Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::kms::inventory::v1::ProtectedResourcesSummary >	[`google::cloud::kms::inventory::v1::ProtectedResourcesSummary`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/inventory/v1/key_tracking_service.proto#L79)

GetProtectedResourcesSummary

Returns aggregate information about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey].

Only resources within the same Cloud organization as the key will be returned. The project that holds the key must be part of an organization in order for this call to succeed.

Parameters
Name	Description
request	google::cloud::kms::inventory::v1::GetProtectedResourcesSummaryRequest const & google::cloud::kms::inventory::v1::GetProtectedResourcesSummaryRequest
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::kms::inventory::v1::ProtectedResourcesSummary >	[`google::cloud::kms::inventory::v1::ProtectedResourcesSummary`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/inventory/v1/key_tracking_service.proto#L79)

SearchProtectedResources

Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.

Parameters
Name	Description
scope	std::string const & Required. Resource name of the organization. Example: organizations/123
crypto_key	std::string const & Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey].
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::kms::inventory::v1::ProtectedResource >	[`google::cloud::kms::inventory::v1::ProtectedResource`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/inventory/v1/key_tracking_service.proto#L156)

SearchProtectedResources

Returns metadata about the resources protected by the given Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.

Parameters
Name	Description
request	google::cloud::kms::inventory::v1::SearchProtectedResourcesRequest google::cloud::kms::inventory::v1::SearchProtectedResourcesRequest
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::kms::inventory::v1::ProtectedResource >	[`google::cloud::kms::inventory::v1::ProtectedResource`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/inventory/v1/key_tracking_service.proto#L156)