Class KeyTrackingServiceClient (2.26.0)

Version 2.26.0

• 2.31.0-rc (latest)
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 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(KeyTrackingServiceClient const &)

Copy and move support

Parameter
Name	Description
	KeyTrackingServiceClient const &

KeyTrackingServiceClient(KeyTrackingServiceClient &&)

Copy and move support

Parameter
Name	Description
	KeyTrackingServiceClient &&

KeyTrackingServiceClient(std::shared_ptr< KeyTrackingServiceConnection >, Options)

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

Operators

operator=(KeyTrackingServiceClient const &)

Copy and move support

Parameter
Name	Description
	KeyTrackingServiceClient const &

Returns
Type	Description
KeyTrackingServiceClient &

operator=(KeyTrackingServiceClient &&)

Copy and move support

Parameter
Name	Description
	KeyTrackingServiceClient &&

Returns
Type	Description
KeyTrackingServiceClient &

Functions

GetProtectedResourcesSummary(std::string const &, Options)

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 >	the result of the RPC. The response message type (google.cloud.kms.inventory.v1.ProtectedResourcesSummary) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProtectedResourcesSummary(google::cloud::kms::inventory::v1::GetProtectedResourcesSummaryRequest const &, Options)

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 & 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.GetProtectedResourcesSummaryRequest. 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
StatusOr< google::cloud::kms::inventory::v1::ProtectedResourcesSummary >	the result of the RPC. The response message type (google.cloud.kms.inventory.v1.ProtectedResourcesSummary) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SearchProtectedResources(std::string const &, std::string const &, Options)

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 >	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.inventory.v1.ProtectedResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchProtectedResources(google::cloud::kms::inventory::v1::SearchProtectedResourcesRequest, Options)

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 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.SearchProtectedResourcesRequest. 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::inventory::v1::ProtectedResource >	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.inventory.v1.ProtectedResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.