Google Cloud Key Management Service v1 API - Class EkmService.EkmServiceBase (3.15.0)

Version latest

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 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

[BindServiceMethod(typeof(EkmService), "BindService")]
public abstract class EkmService.EkmServiceBase

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

Base class for server-side implementations of EkmService

Inheritance

object > EkmService.EkmServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Methods

CreateEkmConnection(CreateEkmConnectionRequest, ServerCallContext)

public virtual Task<EkmConnection> CreateEkmConnection(CreateEkmConnectionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateEkmConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEkmConnection	The response to send back to the client (wrapped by a task).

GetEkmConfig(GetEkmConfigRequest, ServerCallContext)

public virtual Task<EkmConfig> GetEkmConfig(GetEkmConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetEkmConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEkmConfig	The response to send back to the client (wrapped by a task).

GetEkmConnection(GetEkmConnectionRequest, ServerCallContext)

public virtual Task<EkmConnection> GetEkmConnection(GetEkmConnectionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetEkmConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEkmConnection	The response to send back to the client (wrapped by a task).

ListEkmConnections(ListEkmConnectionsRequest, ServerCallContext)

public virtual Task<ListEkmConnectionsResponse> ListEkmConnections(ListEkmConnectionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListEkmConnectionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEkmConnectionsResponse	The response to send back to the client (wrapped by a task).

UpdateEkmConfig(UpdateEkmConfigRequest, ServerCallContext)

public virtual Task<EkmConfig> UpdateEkmConfig(UpdateEkmConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateEkmConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEkmConfig	The response to send back to the client (wrapped by a task).

UpdateEkmConnection(UpdateEkmConnectionRequest, ServerCallContext)

public virtual Task<EkmConnection> UpdateEkmConnection(UpdateEkmConnectionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateEkmConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEkmConnection	The response to send back to the client (wrapped by a task).

VerifyConnectivity(VerifyConnectivityRequest, ServerCallContext)

public virtual Task<VerifyConnectivityResponse> VerifyConnectivity(VerifyConnectivityRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskVerifyConnectivityResponse	The response to send back to the client (wrapped by a task).