Google Cloud Key Management Service v1 API - Class HsmManagementClientImpl (3.21.0) 

public sealed class HsmManagementClientImpl : HsmManagementClient

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

HsmManagement client wrapper implementation, for convenient use.

Inheritance

object > HsmManagementClient > HsmManagementClientImpl

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Remarks

Google Cloud HSM Management Service

Provides interfaces for managing HSM instances.

Implements a REST model with the following objects:

  • [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]
  • [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal]

Constructors

HsmManagementClientImpl(HsmManagementClient, HsmManagementSettings, ILogger)

public HsmManagementClientImpl(HsmManagement.HsmManagementClient grpcClient, HsmManagementSettings settings, ILogger logger)

Constructs a client wrapper for the HsmManagement service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient HsmManagementHsmManagementClient

The underlying gRPC client.
settings HsmManagementSettings

The base HsmManagementSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateSingleTenantHsmInstanceOperationsClient

public override OperationsClient CreateSingleTenantHsmInstanceOperationsClient { get; }

The long-running operations client for CreateSingleTenantHsmInstance.

Property Value
Type Description
OperationsClient
Overrides

CreateSingleTenantHsmInstanceProposalOperationsClient

public override OperationsClient CreateSingleTenantHsmInstanceProposalOperationsClient { get; }

The long-running operations client for CreateSingleTenantHsmInstanceProposal.

Property Value
Type Description
OperationsClient
Overrides

ExecuteSingleTenantHsmInstanceProposalOperationsClient

public override OperationsClient ExecuteSingleTenantHsmInstanceProposalOperationsClient { get; }

The long-running operations client for ExecuteSingleTenantHsmInstanceProposal.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override HsmManagement.HsmManagementClient GrpcClient { get; }

The underlying gRPC HsmManagement client

Property Value
Type Description
HsmManagementHsmManagementClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

ApproveSingleTenantHsmInstanceProposal(ApproveSingleTenantHsmInstanceProposalRequest, CallSettings)

public override ApproveSingleTenantHsmInstanceProposalResponse ApproveSingleTenantHsmInstanceProposal(ApproveSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Approves a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The proposal must be in the [PENDING][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.PENDING] state.

Parameters
Name Description
request ApproveSingleTenantHsmInstanceProposalRequest

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
ApproveSingleTenantHsmInstanceProposalResponse

The RPC response.
Overrides

ApproveSingleTenantHsmInstanceProposalAsync(ApproveSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(ApproveSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Approves a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The proposal must be in the [PENDING][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.PENDING] state.

Parameters
Name Description
request ApproveSingleTenantHsmInstanceProposalRequest

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
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.
Overrides

CreateSingleTenantHsmInstance(CreateSingleTenantHsmInstanceRequest, CallSettings)

public override Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> CreateSingleTenantHsmInstance(CreateSingleTenantHsmInstanceRequest request, CallSettings callSettings = null)

Creates a new [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.

Parameters
Name Description
request CreateSingleTenantHsmInstanceRequest

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
OperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

The RPC response.
Overrides

CreateSingleTenantHsmInstanceAsync(CreateSingleTenantHsmInstanceRequest, CallSettings)

public override Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(CreateSingleTenantHsmInstanceRequest request, CallSettings callSettings = null)

Creates a new [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.

Parameters
Name Description
request CreateSingleTenantHsmInstanceRequest

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
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.
Overrides

CreateSingleTenantHsmInstanceProposal(CreateSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> CreateSingleTenantHsmInstanceProposal(CreateSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Creates a new [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].

Parameters
Name Description
request CreateSingleTenantHsmInstanceProposalRequest

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
OperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

The RPC response.
Overrides

CreateSingleTenantHsmInstanceProposalAsync(CreateSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(CreateSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Creates a new [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance].

Parameters
Name Description
request CreateSingleTenantHsmInstanceProposalRequest

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
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.
Overrides

DeleteSingleTenantHsmInstanceProposal(DeleteSingleTenantHsmInstanceProposalRequest, CallSettings)

public override void DeleteSingleTenantHsmInstanceProposal(DeleteSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Deletes a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

Parameters
Name Description
request DeleteSingleTenantHsmInstanceProposalRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteSingleTenantHsmInstanceProposalAsync(DeleteSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Task DeleteSingleTenantHsmInstanceProposalAsync(DeleteSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Deletes a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

Parameters
Name Description
request DeleteSingleTenantHsmInstanceProposalRequest

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
Task

A Task containing the RPC response.
Overrides

ExecuteSingleTenantHsmInstanceProposal(ExecuteSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> ExecuteSingleTenantHsmInstanceProposal(ExecuteSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Executes a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The proposal must be in the [APPROVED][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.APPROVED] state.

Parameters
Name Description
request ExecuteSingleTenantHsmInstanceProposalRequest

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
OperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

The RPC response.
Overrides

ExecuteSingleTenantHsmInstanceProposalAsync(ExecuteSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(ExecuteSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

Executes a [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] for a given [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance]. The proposal must be in the [APPROVED][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.APPROVED] state.

Parameters
Name Description
request ExecuteSingleTenantHsmInstanceProposalRequest

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
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.
Overrides

GetSingleTenantHsmInstance(GetSingleTenantHsmInstanceRequest, CallSettings)

public override SingleTenantHsmInstance GetSingleTenantHsmInstance(GetSingleTenantHsmInstanceRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSingleTenantHsmInstanceRequest

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
SingleTenantHsmInstance

The RPC response.
Overrides

GetSingleTenantHsmInstanceAsync(GetSingleTenantHsmInstanceRequest, CallSettings)

public override Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(GetSingleTenantHsmInstanceRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSingleTenantHsmInstanceRequest

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
TaskSingleTenantHsmInstance

A Task containing the RPC response.
Overrides

GetSingleTenantHsmInstanceProposal(GetSingleTenantHsmInstanceProposalRequest, CallSettings)

public override SingleTenantHsmInstanceProposal GetSingleTenantHsmInstanceProposal(GetSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSingleTenantHsmInstanceProposalRequest

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
SingleTenantHsmInstanceProposal

The RPC response.
Overrides

GetSingleTenantHsmInstanceProposalAsync(GetSingleTenantHsmInstanceProposalRequest, CallSettings)

public override Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(GetSingleTenantHsmInstanceProposalRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSingleTenantHsmInstanceProposalRequest

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
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.
Overrides

ListSingleTenantHsmInstanceProposals(ListSingleTenantHsmInstanceProposalsRequest, CallSettings)

public override PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposals(ListSingleTenantHsmInstanceProposalsRequest request, CallSettings callSettings = null)

Lists [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

Parameters
Name Description
request ListSingleTenantHsmInstanceProposalsRequest

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
PagedEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable sequence of SingleTenantHsmInstanceProposal resources.
Overrides

ListSingleTenantHsmInstanceProposalsAsync(ListSingleTenantHsmInstanceProposalsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposalsAsync(ListSingleTenantHsmInstanceProposalsRequest request, CallSettings callSettings = null)

Lists [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

Parameters
Name Description
request ListSingleTenantHsmInstanceProposalsRequest

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
PagedAsyncEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable asynchronous sequence of SingleTenantHsmInstanceProposal resources.
Overrides

ListSingleTenantHsmInstances(ListSingleTenantHsmInstancesRequest, CallSettings)

public override PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstances(ListSingleTenantHsmInstancesRequest request, CallSettings callSettings = null)

Lists [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance].

Parameters
Name Description
request ListSingleTenantHsmInstancesRequest

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
PagedEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable sequence of SingleTenantHsmInstance resources.
Overrides

ListSingleTenantHsmInstancesAsync(ListSingleTenantHsmInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstancesAsync(ListSingleTenantHsmInstancesRequest request, CallSettings callSettings = null)

Lists [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance].

Parameters
Name Description
request ListSingleTenantHsmInstancesRequest

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
PagedAsyncEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable asynchronous sequence of SingleTenantHsmInstance resources.
Overrides