Google Cloud Key Management Service v1 API - Class EkmServiceClientImpl (3.4.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

Inherited Members

EkmServiceClient.DefaultEndpoint

EkmServiceClient.DefaultScopes

EkmServiceClient.ServiceMetadata

EkmServiceClient.CreateAsync(CancellationToken)

EkmServiceClient.Create()

EkmServiceClient.ShutdownDefaultChannelsAsync()

EkmServiceClient.ListEkmConnections(string, string, int?, CallSettings)

EkmServiceClient.ListEkmConnectionsAsync(string, string, int?, CallSettings)

EkmServiceClient.ListEkmConnections(LocationName, string, int?, CallSettings)

EkmServiceClient.ListEkmConnectionsAsync(LocationName, string, int?, CallSettings)

EkmServiceClient.GetEkmConnectionAsync(GetEkmConnectionRequest, CancellationToken)

EkmServiceClient.GetEkmConnection(string, CallSettings)

EkmServiceClient.GetEkmConnectionAsync(string, CallSettings)

EkmServiceClient.GetEkmConnectionAsync(string, CancellationToken)

EkmServiceClient.GetEkmConnection(EkmConnectionName, CallSettings)

EkmServiceClient.GetEkmConnectionAsync(EkmConnectionName, CallSettings)

EkmServiceClient.GetEkmConnectionAsync(EkmConnectionName, CancellationToken)

EkmServiceClient.CreateEkmConnectionAsync(CreateEkmConnectionRequest, CancellationToken)

EkmServiceClient.CreateEkmConnection(string, string, EkmConnection, CallSettings)

EkmServiceClient.CreateEkmConnectionAsync(string, string, EkmConnection, CallSettings)

EkmServiceClient.CreateEkmConnectionAsync(string, string, EkmConnection, CancellationToken)

EkmServiceClient.CreateEkmConnection(LocationName, string, EkmConnection, CallSettings)

EkmServiceClient.CreateEkmConnectionAsync(LocationName, string, EkmConnection, CallSettings)

EkmServiceClient.CreateEkmConnectionAsync(LocationName, string, EkmConnection, CancellationToken)

EkmServiceClient.UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, CancellationToken)

EkmServiceClient.UpdateEkmConnection(EkmConnection, FieldMask, CallSettings)

EkmServiceClient.UpdateEkmConnectionAsync(EkmConnection, FieldMask, CallSettings)

EkmServiceClient.UpdateEkmConnectionAsync(EkmConnection, FieldMask, CancellationToken)

EkmServiceClient.GetEkmConfigAsync(GetEkmConfigRequest, CancellationToken)

EkmServiceClient.GetEkmConfig(string, CallSettings)

EkmServiceClient.GetEkmConfigAsync(string, CallSettings)

EkmServiceClient.GetEkmConfigAsync(string, CancellationToken)

EkmServiceClient.GetEkmConfig(EkmConfigName, CallSettings)

EkmServiceClient.GetEkmConfigAsync(EkmConfigName, CallSettings)

EkmServiceClient.GetEkmConfigAsync(EkmConfigName, CancellationToken)

EkmServiceClient.UpdateEkmConfigAsync(UpdateEkmConfigRequest, CancellationToken)

EkmServiceClient.UpdateEkmConfig(EkmConfig, FieldMask, CallSettings)

EkmServiceClient.UpdateEkmConfigAsync(EkmConfig, FieldMask, CallSettings)

EkmServiceClient.UpdateEkmConfigAsync(EkmConfig, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.KmsV1

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
Name	Description
`grpcClient`	`EkmServiceEkmServiceClient` The underlying gRPC client.
`settings`	`EkmServiceSettings` The base EkmServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override EkmService.EkmServiceClient GrpcClient { get; }

The underlying gRPC EkmService client

Property Value
Type	Description
`EkmServiceEkmServiceClient`

Overrides

EkmServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

EkmServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

EkmServiceClient.LocationsClient

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
Name	Description
`request`	`CreateEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`EkmConnection`	The RPC response.

Overrides

EkmServiceClient.CreateEkmConnection(CreateEkmConnectionRequest, CallSettings)

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
Name	Description
`request`	`CreateEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEkmConnection`	A Task containing the RPC response.

Overrides

EkmServiceClient.CreateEkmConnectionAsync(CreateEkmConnectionRequest, CallSettings)

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
Name	Description
`request`	`GetEkmConfigRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`EkmConfig`	The RPC response.

Overrides

EkmServiceClient.GetEkmConfig(GetEkmConfigRequest, CallSettings)

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
Name	Description
`request`	`GetEkmConfigRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEkmConfig`	A Task containing the RPC response.

Overrides

EkmServiceClient.GetEkmConfigAsync(GetEkmConfigRequest, CallSettings)

GetEkmConnection(GetEkmConnectionRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`GetEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`EkmConnection`	The RPC response.

Overrides

EkmServiceClient.GetEkmConnection(GetEkmConnectionRequest, CallSettings)

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
Name	Description
`request`	`GetEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEkmConnection`	A Task containing the RPC response.

Overrides

EkmServiceClient.GetEkmConnectionAsync(GetEkmConnectionRequest, CallSettings)

ListEkmConnections(ListEkmConnectionsRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`ListEkmConnectionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableListEkmConnectionsResponseEkmConnection`	A pageable sequence of EkmConnection resources.

Overrides

EkmServiceClient.ListEkmConnections(ListEkmConnectionsRequest, CallSettings)

ListEkmConnectionsAsync(ListEkmConnectionsRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`ListEkmConnectionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableListEkmConnectionsResponseEkmConnection`	A pageable asynchronous sequence of EkmConnection resources.

Overrides

EkmServiceClient.ListEkmConnectionsAsync(ListEkmConnectionsRequest, CallSettings)

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
Name	Description
`request`	`UpdateEkmConfigRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`EkmConfig`	The RPC response.

Overrides

EkmServiceClient.UpdateEkmConfig(UpdateEkmConfigRequest, CallSettings)

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
Name	Description
`request`	`UpdateEkmConfigRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEkmConfig`	A Task containing the RPC response.

Overrides

EkmServiceClient.UpdateEkmConfigAsync(UpdateEkmConfigRequest, CallSettings)

UpdateEkmConnection(UpdateEkmConnectionRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`UpdateEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`EkmConnection`	The RPC response.

Overrides

EkmServiceClient.UpdateEkmConnection(UpdateEkmConnectionRequest, CallSettings)

UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, CallSettings)

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

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

Parameters
Name	Description
`request`	`UpdateEkmConnectionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskEkmConnection`	A Task containing the RPC response.

Overrides

EkmServiceClient.UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, CallSettings)