Google Cloud Key Management Service v1 API - Class EkmServiceClientImpl (3.6.0) 

public sealed class EkmServiceClientImpl : EkmServiceClient

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class EkmServiceClientImpl.

EkmService client wrapper implementation, for convenient use.

Inheritance

object > EkmServiceClient > EkmServiceClientImpl

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Remarks

Google Cloud Key Management EKM Service

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

  • [EkmConnection][google.cloud.kms.v1.EkmConnection]

Constructors

EkmServiceClientImpl(EkmServiceClient, EkmServiceSettings, ILogger)

public EkmServiceClientImpl(EkmService.EkmServiceClient grpcClient, EkmServiceSettings settings, ILogger logger)

Constructs a client wrapper for the EkmService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientEkmServiceEkmServiceClient

The underlying gRPC client.

settingsEkmServiceSettings

The base EkmServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override EkmService.EkmServiceClient GrpcClient { get; }

The underlying gRPC EkmService client

Property Value
TypeDescription
EkmServiceEkmServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

Methods

CreateEkmConnection(CreateEkmConnectionRequest, CallSettings)

public override EkmConnection CreateEkmConnection(CreateEkmConnectionRequest request, CallSettings callSettings = null)

Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.

Parameters
NameDescription
requestCreateEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
EkmConnection

The RPC response.

Overrides

CreateEkmConnectionAsync(CreateEkmConnectionRequest, CallSettings)

public override Task<EkmConnection> CreateEkmConnectionAsync(CreateEkmConnectionRequest request, CallSettings callSettings = null)

Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.

Parameters
NameDescription
requestCreateEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEkmConnection

A Task containing the RPC response.

Overrides

GetEkmConfig(GetEkmConfigRequest, CallSettings)

public override EkmConfig GetEkmConfig(GetEkmConfigRequest request, CallSettings callSettings = null)

Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.

Parameters
NameDescription
requestGetEkmConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
EkmConfig

The RPC response.

Overrides

GetEkmConfigAsync(GetEkmConfigRequest, CallSettings)

public override Task<EkmConfig> GetEkmConfigAsync(GetEkmConfigRequest request, CallSettings callSettings = null)

Returns the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.

Parameters
NameDescription
requestGetEkmConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEkmConfig

A Task containing the RPC response.

Overrides

GetEkmConnection(GetEkmConnectionRequest, CallSettings)

public override EkmConnection GetEkmConnection(GetEkmConnectionRequest request, CallSettings callSettings = null)

Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].

Parameters
NameDescription
requestGetEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
EkmConnection

The RPC response.

Overrides

GetEkmConnectionAsync(GetEkmConnectionRequest, CallSettings)

public override Task<EkmConnection> GetEkmConnectionAsync(GetEkmConnectionRequest request, CallSettings callSettings = null)

Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].

Parameters
NameDescription
requestGetEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEkmConnection

A Task containing the RPC response.

Overrides

ListEkmConnections(ListEkmConnectionsRequest, CallSettings)

public override PagedEnumerable<ListEkmConnectionsResponse, EkmConnection> ListEkmConnections(ListEkmConnectionsRequest request, CallSettings callSettings = null)

Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].

Parameters
NameDescription
requestListEkmConnectionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEkmConnectionsResponseEkmConnection

A pageable sequence of EkmConnection resources.

Overrides

ListEkmConnectionsAsync(ListEkmConnectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEkmConnectionsResponse, EkmConnection> ListEkmConnectionsAsync(ListEkmConnectionsRequest request, CallSettings callSettings = null)

Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].

Parameters
NameDescription
requestListEkmConnectionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEkmConnectionsResponseEkmConnection

A pageable asynchronous sequence of EkmConnection resources.

Overrides

UpdateEkmConfig(UpdateEkmConfigRequest, CallSettings)

public override EkmConfig UpdateEkmConfig(UpdateEkmConfigRequest request, CallSettings callSettings = null)

Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.

Parameters
NameDescription
requestUpdateEkmConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
EkmConfig

The RPC response.

Overrides

UpdateEkmConfigAsync(UpdateEkmConfigRequest, CallSettings)

public override Task<EkmConfig> UpdateEkmConfigAsync(UpdateEkmConfigRequest request, CallSettings callSettings = null)

Updates the [EkmConfig][google.cloud.kms.v1.EkmConfig] singleton resource for a given project and location.

Parameters
NameDescription
requestUpdateEkmConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEkmConfig

A Task containing the RPC response.

Overrides

UpdateEkmConnection(UpdateEkmConnectionRequest, CallSettings)

public override EkmConnection UpdateEkmConnection(UpdateEkmConnectionRequest request, CallSettings callSettings = null)

Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.

Parameters
NameDescription
requestUpdateEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
EkmConnection

The RPC response.

Overrides

UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, CallSettings)

public override Task<EkmConnection> UpdateEkmConnectionAsync(UpdateEkmConnectionRequest request, CallSettings callSettings = null)

Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.

Parameters
NameDescription
requestUpdateEkmConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEkmConnection

A Task containing the RPC response.

Overrides

VerifyConnectivity(VerifyConnectivityRequest, CallSettings)

public override VerifyConnectivityResponse VerifyConnectivity(VerifyConnectivityRequest request, CallSettings callSettings = null)

Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.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
NameDescription
requestVerifyConnectivityRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
VerifyConnectivityResponse

The RPC response.

Overrides

VerifyConnectivityAsync(VerifyConnectivityRequest, CallSettings)

public override Task<VerifyConnectivityResponse> VerifyConnectivityAsync(VerifyConnectivityRequest request, CallSettings callSettings = null)

Verifies that Cloud KMS can successfully connect to the external key manager specified by an [EkmConnection][google.cloud.kms.v1.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
NameDescription
requestVerifyConnectivityRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskVerifyConnectivityResponse

A Task containing the RPC response.

Overrides