Google Cloud Key Management Service v1 API - Class EkmService.EkmServiceClient (3.11.0)

Version latest

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public class EkmService.EkmServiceClient : ClientBase<EkmService.EkmServiceClient>

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

Client for EkmService

Inheritance

object > ClientBase > ClientBaseEkmServiceEkmServiceClient > EkmService.EkmServiceClient

Inherited Members

ClientBase<EkmService.EkmServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

EkmServiceClient()

protected EkmServiceClient()

Protected parameterless constructor to allow creation of test doubles.

EkmServiceClient(CallInvoker)

public EkmServiceClient(CallInvoker callInvoker)

Creates a new client for EkmService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EkmServiceClient(ChannelBase)

public EkmServiceClient(ChannelBase channel)

Creates a new client for EkmService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EkmServiceClient(ClientBaseConfiguration)

protected EkmServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateEkmConnection(CreateEkmConnectionRequest, CallOptions)

public virtual EkmConnection CreateEkmConnection(CreateEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EkmConnection	The response received from the server.

CreateEkmConnection(CreateEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConnection CreateEkmConnection(CreateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EkmConnection	The response received from the server.

CreateEkmConnectionAsync(CreateEkmConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConnection> CreateEkmConnectionAsync(CreateEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

CreateEkmConnectionAsync(CreateEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConnection> CreateEkmConnectionAsync(CreateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

GetEkmConfig(GetEkmConfigRequest, CallOptions)

public virtual EkmConfig GetEkmConfig(GetEkmConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEkmConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EkmConfig	The response received from the server.

GetEkmConfig(GetEkmConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConfig GetEkmConfig(GetEkmConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEkmConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EkmConfig	The response received from the server.

GetEkmConfigAsync(GetEkmConfigRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConfig> GetEkmConfigAsync(GetEkmConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEkmConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEkmConfig	The call object.

GetEkmConfigAsync(GetEkmConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConfig> GetEkmConfigAsync(GetEkmConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEkmConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEkmConfig	The call object.

GetEkmConnection(GetEkmConnectionRequest, CallOptions)

public virtual EkmConnection GetEkmConnection(GetEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EkmConnection	The response received from the server.

GetEkmConnection(GetEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConnection GetEkmConnection(GetEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EkmConnection	The response received from the server.

GetEkmConnectionAsync(GetEkmConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConnection> GetEkmConnectionAsync(GetEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

GetEkmConnectionAsync(GetEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConnection> GetEkmConnectionAsync(GetEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

ListEkmConnections(ListEkmConnectionsRequest, CallOptions)

public virtual ListEkmConnectionsResponse ListEkmConnections(ListEkmConnectionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEkmConnectionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEkmConnectionsResponse	The response received from the server.

ListEkmConnections(ListEkmConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEkmConnectionsResponse ListEkmConnections(ListEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEkmConnectionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEkmConnectionsResponse	The response received from the server.

ListEkmConnectionsAsync(ListEkmConnectionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEkmConnectionsResponse> ListEkmConnectionsAsync(ListEkmConnectionsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEkmConnectionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListEkmConnectionsResponse	The call object.

ListEkmConnectionsAsync(ListEkmConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEkmConnectionsResponse> ListEkmConnectionsAsync(ListEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEkmConnectionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListEkmConnectionsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override EkmService.EkmServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
EkmServiceEkmServiceClient

Overrides

ClientBase<EkmService.EkmServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateEkmConfig(UpdateEkmConfigRequest, CallOptions)

public virtual EkmConfig UpdateEkmConfig(UpdateEkmConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEkmConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EkmConfig	The response received from the server.

UpdateEkmConfig(UpdateEkmConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConfig UpdateEkmConfig(UpdateEkmConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEkmConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EkmConfig	The response received from the server.

UpdateEkmConfigAsync(UpdateEkmConfigRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConfig> UpdateEkmConfigAsync(UpdateEkmConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEkmConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEkmConfig	The call object.

UpdateEkmConfigAsync(UpdateEkmConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConfig> UpdateEkmConfigAsync(UpdateEkmConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEkmConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEkmConfig	The call object.

UpdateEkmConnection(UpdateEkmConnectionRequest, CallOptions)

public virtual EkmConnection UpdateEkmConnection(UpdateEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EkmConnection	The response received from the server.

UpdateEkmConnection(UpdateEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual EkmConnection UpdateEkmConnection(UpdateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EkmConnection	The response received from the server.

UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<EkmConnection> UpdateEkmConnectionAsync(UpdateEkmConnectionRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateEkmConnectionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EkmConnection> UpdateEkmConnectionAsync(UpdateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateEkmConnectionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEkmConnection	The call object.

VerifyConnectivity(VerifyConnectivityRequest, CallOptions)

public virtual VerifyConnectivityResponse VerifyConnectivity(VerifyConnectivityRequest request, CallOptions options)

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
Name	Description
request	VerifyConnectivityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
VerifyConnectivityResponse	The response received from the server.

VerifyConnectivity(VerifyConnectivityRequest, Metadata, DateTime?, CancellationToken)

public virtual VerifyConnectivityResponse VerifyConnectivity(VerifyConnectivityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	VerifyConnectivityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
VerifyConnectivityResponse	The response received from the server.

VerifyConnectivityAsync(VerifyConnectivityRequest, CallOptions)

public virtual AsyncUnaryCall<VerifyConnectivityResponse> VerifyConnectivityAsync(VerifyConnectivityRequest request, CallOptions options)

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
Name	Description
request	VerifyConnectivityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallVerifyConnectivityResponse	The call object.

VerifyConnectivityAsync(VerifyConnectivityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<VerifyConnectivityResponse> VerifyConnectivityAsync(VerifyConnectivityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
Name	Description
request	VerifyConnectivityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallVerifyConnectivityResponse	The call object.