Class google::cloud::kms_v1::EkmServiceClient (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

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

Parameter
Name	Description
	EkmServiceClient const &

EkmServiceClient

Parameter
Name	Description
	EkmServiceClient &&

EkmServiceClient

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

~EkmServiceClient

Operators

operator=

Parameter
Name	Description
	EkmServiceClient const &

Returns
Type	Description
EkmServiceClient &

operator=

Parameter
Name	Description
	EkmServiceClient &&

Returns
Type	Description
EkmServiceClient &

Functions

ListEkmConnections

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 >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

ListEkmConnections

Lists EkmConnections.

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

Returns
Type	Description
StreamRange< google::cloud::kms::v1::EkmConnection >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

GetEkmConnection

Returns metadata for a given EkmConnection.

Parameters
Name	Description
name	std::string const & Required. The [name][google.cloud.kms.v1.EkmConnection.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 >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

GetEkmConnection

Returns metadata for a given EkmConnection.

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

Returns
Type	Description
StatusOr< google::cloud::kms::v1::EkmConnection >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

CreateEkmConnection

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 >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

CreateEkmConnection

Creates a new EkmConnection in a given Project and Location.

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

Returns
Type	Description
StatusOr< google::cloud::kms::v1::EkmConnection >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

UpdateEkmConnection

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 >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

UpdateEkmConnection

Updates an EkmConnection's metadata.

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

Returns
Type	Description
StatusOr< google::cloud::kms::v1::EkmConnection >	[`google::cloud::kms::v1::EkmConnection`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L282)

GetEkmConfig

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

Parameters
Name	Description
name	std::string const & Required. The [name][google.cloud.kms.v1.EkmConfig.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 >	[`google::cloud::kms::v1::EkmConfig`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L401)

GetEkmConfig

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

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

Returns
Type	Description
StatusOr< google::cloud::kms::v1::EkmConfig >	[`google::cloud::kms::v1::EkmConfig`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L401)

UpdateEkmConfig

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 >	[`google::cloud::kms::v1::EkmConfig`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L401)

UpdateEkmConfig

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

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

Returns
Type	Description
StatusOr< google::cloud::kms::v1::EkmConfig >	[`google::cloud::kms::v1::EkmConfig`](https://github.com/googleapis/googleapis/blob/2da477b6a72168c65fdb4245530cfa702cc4b029/google/cloud/kms/v1/ekm_service.proto#L401)