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.
Namespace
Google.Cloud.Kms.V1Assembly
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 |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
LocationsClient
public override LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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 | |
---|---|
Name | Description |
request |
VerifyConnectivityRequest 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 |
VerifyConnectivityResponse |
The RPC response. |
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 | |
---|---|
Name | Description |
request |
VerifyConnectivityRequest 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 |
TaskVerifyConnectivityResponse |
A Task containing the RPC response. |