public class 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 > ClientBase<EkmService.EkmServiceClient> > EkmService.EkmServiceClientNamespace
Google.Cloud.Kms.V1Assembly
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 |
CallInvokerThe callInvoker to use to make remote calls. |
EkmServiceClient(ChannelBase)
public EkmServiceClient(ChannelBase channel)Creates a new client for EkmService
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
EkmServiceClient(ClientBase.ClientBaseConfiguration)
protected EkmServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfigurationThe 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 |
CreateEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
EkmConnection |
The response received from the server. |
CreateEkmConnection(CreateEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual EkmConnection CreateEkmConnection(CreateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
CreateEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
The call object. |
CreateEkmConnectionAsync(CreateEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<EkmConnection> CreateEkmConnectionAsync(CreateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Creates a new [EkmConnection][google.cloud.kms.v1.EkmConnection] in a given Project and Location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
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 |
IAMPolicy.IAMPolicyClient |
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 |
Locations.LocationsClient |
A new Locations.LocationsClient for the same target as this client. |
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 |
GetEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
EkmConnection |
The response received from the server. |
GetEkmConnection(GetEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual EkmConnection GetEkmConnection(GetEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
| Parameters | |
|---|---|
| Name | Description |
request |
GetEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
The call object. |
GetEkmConnectionAsync(GetEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<EkmConnection> GetEkmConnectionAsync(GetEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Returns metadata for a given [EkmConnection][google.cloud.kms.v1.EkmConnection].
| Parameters | |
|---|---|
| Name | Description |
request |
GetEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
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 |
ListEkmConnectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListEkmConnectionsResponse |
The response received from the server. |
ListEkmConnections(ListEkmConnectionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListEkmConnectionsResponse ListEkmConnections(ListEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
| Parameters | |
|---|---|
| Name | Description |
request |
ListEkmConnectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListEkmConnectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListEkmConnectionsResponse> |
The call object. |
ListEkmConnectionsAsync(ListEkmConnectionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListEkmConnectionsResponse> ListEkmConnectionsAsync(ListEkmConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Lists [EkmConnections][google.cloud.kms.v1.EkmConnection].
| Parameters | |
|---|---|
| Name | Description |
request |
ListEkmConnectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListEkmConnectionsResponse> |
The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override EkmService.EkmServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
EkmService.EkmServiceClient |
|
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 |
UpdateEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
EkmConnection |
The response received from the server. |
UpdateEkmConnection(UpdateEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual EkmConnection UpdateEkmConnection(UpdateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
UpdateEkmConnectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
The call object. |
UpdateEkmConnectionAsync(UpdateEkmConnectionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<EkmConnection> UpdateEkmConnectionAsync(UpdateEkmConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))Updates an [EkmConnection][google.cloud.kms.v1.EkmConnection]'s metadata.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateEkmConnectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<EkmConnection> |
The call object. |