Class EkmServiceClient (2.34.0-rc)

Google Cloud Key Management EKM Service.

Manages external cryptographic keys and operations using those keys. Implements a REST model with the following objects:

EkmConnection

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

EkmServiceClient(EkmServiceClient const &)

Copy and move support

Parameter
Name	Description
	`EkmServiceClient const &`

EkmServiceClient(EkmServiceClient &&)

Copy and move support

Parameter
Name	Description
	`EkmServiceClient &&`

EkmServiceClient(std::shared_ptr< EkmServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< EkmServiceConnection >`
`opts`	`Options`

Operators

operator=(EkmServiceClient const &)

Copy and move support

Parameter
Name	Description
	`EkmServiceClient const &`

Returns
Type	Description
`EkmServiceClient &`

operator=(EkmServiceClient &&)

Copy and move support

Parameter
Name	Description
	`EkmServiceClient &&`

Returns
Type	Description
`EkmServiceClient &`

Functions

ListEkmConnections(std::string const &, Options)

Lists EkmConnections.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the location associated with the EkmConnections to list, in the format `projects//locations/`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::kms::v1::EkmConnection >

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

ListEkmConnections(google::cloud::kms::v1::ListEkmConnectionsRequest, Options)

Lists EkmConnections.

Parameters
Name	Description
`request`	`google::cloud::kms::v1::ListEkmConnectionsRequest` 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.v1.ListEkmConnectionsRequest. 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::EkmConnection >

GetEkmConnection(std::string const &, Options)

Returns metadata for a given EkmConnection.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the EkmConnection to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::EkmConnection >`	the result of the RPC. The response message type (google.cloud.kms.v1.EkmConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEkmConnection(google::cloud::kms::v1::GetEkmConnectionRequest const &, Options)

Returns metadata for a given EkmConnection.

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

CreateEkmConnection(std::string const &, std::string const &, google::cloud::kms::v1::EkmConnection const &, Options)

Creates a new EkmConnection in a given Project and Location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the location associated with the EkmConnection, in the format `projects//locations/`.
`ekm_connection_id`	`std::string const &` Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
`ekm_connection`	`google::cloud::kms::v1::EkmConnection const &` Required. An EkmConnection with initial field values.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::EkmConnection >`	the result of the RPC. The response message type (google.cloud.kms.v1.EkmConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEkmConnection(google::cloud::kms::v1::CreateEkmConnectionRequest const &, Options)

Creates a new EkmConnection in a given Project and Location.

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

UpdateEkmConnection(google::cloud::kms::v1::EkmConnection const &, google::protobuf::FieldMask const &, Options)

Updates an EkmConnection's metadata.

Parameters
Name	Description
`ekm_connection`	`google::cloud::kms::v1::EkmConnection const &` Required. EkmConnection with updated values.
`update_mask`	`google::protobuf::FieldMask const &` Required. List of fields to be updated in this request.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::EkmConnection >`	the result of the RPC. The response message type (google.cloud.kms.v1.EkmConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEkmConnection(google::cloud::kms::v1::UpdateEkmConnectionRequest const &, Options)

Updates an EkmConnection's metadata.

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

GetEkmConfig(std::string const &, Options)

Returns the EkmConfig singleton resource for a given project and location.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the EkmConfig to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::EkmConfig >`	the result of the RPC. The response message type (google.cloud.kms.v1.EkmConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEkmConfig(google::cloud::kms::v1::GetEkmConfigRequest const &, Options)

Returns the EkmConfig singleton resource for a given project and location.

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

UpdateEkmConfig(google::cloud::kms::v1::EkmConfig const &, google::protobuf::FieldMask const &, Options)

Updates the EkmConfig singleton resource for a given project and location.

Parameters
Name	Description
`ekm_config`	`google::cloud::kms::v1::EkmConfig const &` Required. EkmConfig with updated values.
`update_mask`	`google::protobuf::FieldMask const &` Required. List of fields to be updated in this request.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::EkmConfig >`	the result of the RPC. The response message type (google.cloud.kms.v1.EkmConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEkmConfig(google::cloud::kms::v1::UpdateEkmConfigRequest const &, Options)

Updates the EkmConfig singleton resource for a given project and location.

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

VerifyConnectivity(std::string const &, Options)

Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection.

If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the EkmConnection to verify.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::kms::v1::VerifyConnectivityResponse >`	the result of the RPC. The response message type (google.cloud.kms.v1.VerifyConnectivityResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

VerifyConnectivity(google::cloud::kms::v1::VerifyConnectivityRequest const &, Options)

Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection.

If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.

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

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`google::cloud::location::ListLocationsRequest` 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.location.ListLocationsRequest. 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::location::Location >

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

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name	Description
`request`	`google::cloud::location::GetLocationRequest 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.location.GetLocationRequest. 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::location::Location >`	the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified resource.

Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest 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.iam.v1.SetIamPolicyRequest. 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::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the access control policy for a resource.

Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest 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.iam.v1.GetIamPolicyRequest. 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::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest 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.iam.v1.TestIamPermissionsRequest. 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::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation(std::string const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`name`	`std::string const &` The name of the operation resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetOperation(google::longrunning::GetOperationRequest const &, Options)

Gets the latest state of a long-running operation.

Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name	Description
`request`	`google::longrunning::GetOperationRequest 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.longrunning.GetOperationRequest. 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::longrunning::Operation >`	the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.