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

public abstract class HsmManagementClient

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

HsmManagement client wrapper, for convenient use.

Inheritance

object > HsmManagementClient

Derived Types

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]

Properties

CreateSingleTenantHsmInstanceOperationsClient

public virtual OperationsClient CreateSingleTenantHsmInstanceOperationsClient { get; }

The long-running operations client for CreateSingleTenantHsmInstance.

Property Value
Type Description
OperationsClient

CreateSingleTenantHsmInstanceProposalOperationsClient

public virtual OperationsClient CreateSingleTenantHsmInstanceProposalOperationsClient { get; }

The long-running operations client for CreateSingleTenantHsmInstanceProposal.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the HsmManagement service, which is a host of "cloudkms.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default HsmManagement scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

ExecuteSingleTenantHsmInstanceProposalOperationsClient

public virtual OperationsClient ExecuteSingleTenantHsmInstanceProposalOperationsClient { get; }

The long-running operations client for ExecuteSingleTenantHsmInstanceProposal.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual HsmManagement.HsmManagementClient GrpcClient { get; }

The underlying gRPC HsmManagement client

Property Value
Type Description
HsmManagementHsmManagementClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

ApproveSingleTenantHsmInstanceProposal(ApproveSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
ApproveSingleTenantHsmInstanceProposalRequest request = new ApproveSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
    QuorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply(),
};
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = hsmManagementClient.ApproveSingleTenantHsmInstanceProposal(request);

ApproveSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName, QuorumReply, CallSettings)

public virtual ApproveSingleTenantHsmInstanceProposalResponse ApproveSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, 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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ApproveSingleTenantHsmInstanceProposalResponse

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = hsmManagementClient.ApproveSingleTenantHsmInstanceProposal(name, quorumReply);

ApproveSingleTenantHsmInstanceProposal(string, QuorumReply, CallSettings)

public virtual ApproveSingleTenantHsmInstanceProposalResponse ApproveSingleTenantHsmInstanceProposal(string name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, 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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
ApproveSingleTenantHsmInstanceProposalResponse

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = hsmManagementClient.ApproveSingleTenantHsmInstanceProposal(name, quorumReply);

ApproveSingleTenantHsmInstanceProposalAsync(ApproveSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ApproveSingleTenantHsmInstanceProposalRequest request = new ApproveSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
    QuorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply(),
};
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(request);

ApproveSingleTenantHsmInstanceProposalAsync(ApproveSingleTenantHsmInstanceProposalRequest, CancellationToken)

public virtual Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(ApproveSingleTenantHsmInstanceProposalRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ApproveSingleTenantHsmInstanceProposalRequest request = new ApproveSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
    QuorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply(),
};
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(request);

ApproveSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, QuorumReply, CallSettings)

public virtual Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, 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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(name, quorumReply);

ApproveSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, QuorumReply, CancellationToken)

public virtual Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, CancellationToken cancellationToken)

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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(name, quorumReply);

ApproveSingleTenantHsmInstanceProposalAsync(string, QuorumReply, CallSettings)

public virtual Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(string name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, 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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(name, quorumReply);

ApproveSingleTenantHsmInstanceProposalAsync(string, QuorumReply, CancellationToken)

public virtual Task<ApproveSingleTenantHsmInstanceProposalResponse> ApproveSingleTenantHsmInstanceProposalAsync(string name, ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply, CancellationToken cancellationToken)

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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to approve.

quorumReply ApproveSingleTenantHsmInstanceProposalRequestTypesQuorumReply

Required. The reply to [QuorumParameters][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters] for approving the proposal.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskApproveSingleTenantHsmInstanceProposalResponse

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply quorumReply = new ApproveSingleTenantHsmInstanceProposalRequest.Types.QuorumReply();
// Make the request
ApproveSingleTenantHsmInstanceProposalResponse response = await hsmManagementClient.ApproveSingleTenantHsmInstanceProposalAsync(name, quorumReply);

Create()

public static HsmManagementClient Create()

Synchronously creates a HsmManagementClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use HsmManagementClientBuilder.

Returns
Type Description
HsmManagementClient

The created HsmManagementClient.

CreateAsync(CancellationToken)

public static Task<HsmManagementClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a HsmManagementClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use HsmManagementClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskHsmManagementClient

The task representing the created HsmManagementClient.

CreateSingleTenantHsmInstance(LocationName, SingleTenantHsmInstance, string, CallSettings)

public virtual Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> CreateSingleTenantHsmInstance(LocationName parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, 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
parent LocationName

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstance(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstance(CreateSingleTenantHsmInstanceRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceRequest request = new CreateSingleTenantHsmInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SingleTenantHsmInstanceId = "",
    SingleTenantHsmInstance = new SingleTenantHsmInstance(),
};
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstance(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstance(string, SingleTenantHsmInstance, string, CallSettings)

public virtual Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> CreateSingleTenantHsmInstance(string parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, 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
parent string

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstance(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstance(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(LocationName, SingleTenantHsmInstance, string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(LocationName parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, 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
parent LocationName

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(LocationName, SingleTenantHsmInstance, string, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(LocationName parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, CancellationToken cancellationToken)

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
parent LocationName

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(CreateSingleTenantHsmInstanceRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceRequest request = new CreateSingleTenantHsmInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SingleTenantHsmInstanceId = "",
    SingleTenantHsmInstance = new SingleTenantHsmInstance(),
};
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(CreateSingleTenantHsmInstanceRequest, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(CreateSingleTenantHsmInstanceRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceRequest request = new CreateSingleTenantHsmInstanceRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    SingleTenantHsmInstanceId = "",
    SingleTenantHsmInstance = new SingleTenantHsmInstance(),
};
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(string, SingleTenantHsmInstance, string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(string parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, 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
parent string

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceAsync(string, SingleTenantHsmInstance, string, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> CreateSingleTenantHsmInstanceAsync(string parent, SingleTenantHsmInstance singleTenantHsmInstance, string singleTenantHsmInstanceId, CancellationToken cancellationToken)

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
parent string

Required. The resource name of the location associated with the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance], in the format projects/*/locations/*.

singleTenantHsmInstance SingleTenantHsmInstance

Required. An [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] with initial field values.

singleTenantHsmInstanceId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
SingleTenantHsmInstance singleTenantHsmInstance = new SingleTenantHsmInstance();
string singleTenantHsmInstanceId = "";
// Make the request
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceAsync(parent, singleTenantHsmInstance, singleTenantHsmInstanceId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstance result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstance retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposal(CreateSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceProposalRequest request = new CreateSingleTenantHsmInstanceProposalRequest
{
    ParentAsSingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
    SingleTenantHsmInstanceProposalId = "",
    SingleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal(),
};
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstanceProposal(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceName, SingleTenantHsmInstanceProposal, string, CallSettings)

public virtual Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> CreateSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceName parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CallSettings callSettings = null)

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

Parameters
Name Description
parent SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceName parent = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstanceProposal(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposal(string, SingleTenantHsmInstanceProposal, string, CallSettings)

public virtual Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> CreateSingleTenantHsmInstanceProposal(string parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.CreateSingleTenantHsmInstanceProposal(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(CreateSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceProposalRequest request = new CreateSingleTenantHsmInstanceProposalRequest
{
    ParentAsSingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
    SingleTenantHsmInstanceProposalId = "",
    SingleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal(),
};
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(CreateSingleTenantHsmInstanceProposalRequest, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(CreateSingleTenantHsmInstanceProposalRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
CreateSingleTenantHsmInstanceProposalRequest request = new CreateSingleTenantHsmInstanceProposalRequest
{
    ParentAsSingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
    SingleTenantHsmInstanceProposalId = "",
    SingleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal(),
};
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(request);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceName, SingleTenantHsmInstanceProposal, string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceName parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CallSettings callSettings = null)

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

Parameters
Name Description
parent SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceName parent = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceName, SingleTenantHsmInstanceProposal, string, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceName parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CancellationToken cancellationToken)

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

Parameters
Name Description
parent SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceName parent = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(string, SingleTenantHsmInstanceProposal, string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(string parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

CreateSingleTenantHsmInstanceProposalAsync(string, SingleTenantHsmInstanceProposal, string, CancellationToken)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> CreateSingleTenantHsmInstanceProposalAsync(string parent, SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal, string singleTenantHsmInstanceProposalId, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal].

singleTenantHsmInstanceProposal SingleTenantHsmInstanceProposal

Required. The [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to create.

singleTenantHsmInstanceProposalId string

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
SingleTenantHsmInstanceProposal singleTenantHsmInstanceProposal = new SingleTenantHsmInstanceProposal();
string singleTenantHsmInstanceProposalId = "";
// Make the request
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.CreateSingleTenantHsmInstanceProposalAsync(parent, singleTenantHsmInstanceProposal, singleTenantHsmInstanceProposalId);

// Poll until the returned long-running operation is complete
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
SingleTenantHsmInstanceProposal result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceCreateSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    SingleTenantHsmInstanceProposal retrievedResult = retrievedResponse.Result;
}

DeleteSingleTenantHsmInstanceProposal(DeleteSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
DeleteSingleTenantHsmInstanceProposalRequest request = new DeleteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
hsmManagementClient.DeleteSingleTenantHsmInstanceProposal(request);

DeleteSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual void DeleteSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
hsmManagementClient.DeleteSingleTenantHsmInstanceProposal(name);

DeleteSingleTenantHsmInstanceProposal(string, CallSettings)

public virtual void DeleteSingleTenantHsmInstanceProposal(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
hsmManagementClient.DeleteSingleTenantHsmInstanceProposal(name);

DeleteSingleTenantHsmInstanceProposalAsync(DeleteSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
DeleteSingleTenantHsmInstanceProposalRequest request = new DeleteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(request);

DeleteSingleTenantHsmInstanceProposalAsync(DeleteSingleTenantHsmInstanceProposalRequest, CancellationToken)

public virtual Task DeleteSingleTenantHsmInstanceProposalAsync(DeleteSingleTenantHsmInstanceProposalRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
DeleteSingleTenantHsmInstanceProposalRequest request = new DeleteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(request);

DeleteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual Task DeleteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(name);

DeleteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CancellationToken)

public virtual Task DeleteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(name);

DeleteSingleTenantHsmInstanceProposalAsync(string, CallSettings)

public virtual Task DeleteSingleTenantHsmInstanceProposalAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(name);

DeleteSingleTenantHsmInstanceProposalAsync(string, CancellationToken)

public virtual Task DeleteSingleTenantHsmInstanceProposalAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to delete.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
await hsmManagementClient.DeleteSingleTenantHsmInstanceProposalAsync(name);

ExecuteSingleTenantHsmInstanceProposal(ExecuteSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
ExecuteSingleTenantHsmInstanceProposalRequest request = new ExecuteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.ExecuteSingleTenantHsmInstanceProposal(request);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> ExecuteSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName name, 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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.ExecuteSingleTenantHsmInstanceProposal(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposal(string, CallSettings)

public virtual Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> ExecuteSingleTenantHsmInstanceProposal(string name, 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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = hsmManagementClient.ExecuteSingleTenantHsmInstanceProposal(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposal(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(ExecuteSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ExecuteSingleTenantHsmInstanceProposalRequest request = new ExecuteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(ExecuteSingleTenantHsmInstanceProposalRequest, CancellationToken)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(ExecuteSingleTenantHsmInstanceProposalRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ExecuteSingleTenantHsmInstanceProposalRequest request = new ExecuteSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(request);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, 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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CancellationToken)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, CancellationToken cancellationToken)

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
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(string, CallSettings)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(string name, 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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

ExecuteSingleTenantHsmInstanceProposalAsync(string, CancellationToken)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> ExecuteSingleTenantHsmInstanceProposalAsync(string name, CancellationToken cancellationToken)

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
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to execute.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> response = await hsmManagementClient.ExecuteSingleTenantHsmInstanceProposalAsync(name);

// Poll until the returned long-running operation is complete
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ExecuteSingleTenantHsmInstanceProposalResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> retrievedResponse = await hsmManagementClient.PollOnceExecuteSingleTenantHsmInstanceProposalAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ExecuteSingleTenantHsmInstanceProposalResponse retrievedResult = retrievedResponse.Result;
}

GetSingleTenantHsmInstance(GetSingleTenantHsmInstanceRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
GetSingleTenantHsmInstanceRequest request = new GetSingleTenantHsmInstanceRequest
{
    SingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
};
// Make the request
SingleTenantHsmInstance response = hsmManagementClient.GetSingleTenantHsmInstance(request);

GetSingleTenantHsmInstance(SingleTenantHsmInstanceName, CallSettings)

public virtual SingleTenantHsmInstance GetSingleTenantHsmInstance(SingleTenantHsmInstanceName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SingleTenantHsmInstance

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceName name = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
// Make the request
SingleTenantHsmInstance response = hsmManagementClient.GetSingleTenantHsmInstance(name);

GetSingleTenantHsmInstance(string, CallSettings)

public virtual SingleTenantHsmInstance GetSingleTenantHsmInstance(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SingleTenantHsmInstance

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
// Make the request
SingleTenantHsmInstance response = hsmManagementClient.GetSingleTenantHsmInstance(name);

GetSingleTenantHsmInstanceAsync(GetSingleTenantHsmInstanceRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
GetSingleTenantHsmInstanceRequest request = new GetSingleTenantHsmInstanceRequest
{
    SingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
};
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(request);

GetSingleTenantHsmInstanceAsync(GetSingleTenantHsmInstanceRequest, CancellationToken)

public virtual Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(GetSingleTenantHsmInstanceRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstance

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
GetSingleTenantHsmInstanceRequest request = new GetSingleTenantHsmInstanceRequest
{
    SingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
};
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(request);

GetSingleTenantHsmInstanceAsync(SingleTenantHsmInstanceName, CallSettings)

public virtual Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(SingleTenantHsmInstanceName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSingleTenantHsmInstance

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceName name = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(name);

GetSingleTenantHsmInstanceAsync(SingleTenantHsmInstanceName, CancellationToken)

public virtual Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(SingleTenantHsmInstanceName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name SingleTenantHsmInstanceName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstance

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceName name = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(name);

GetSingleTenantHsmInstanceAsync(string, CallSettings)

public virtual Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSingleTenantHsmInstance

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(name);

GetSingleTenantHsmInstanceAsync(string, CancellationToken)

public virtual Task<SingleTenantHsmInstance> GetSingleTenantHsmInstanceAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstance.name] of the [SingleTenantHsmInstance][google.cloud.kms.v1.SingleTenantHsmInstance] to get.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstance

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
// Make the request
SingleTenantHsmInstance response = await hsmManagementClient.GetSingleTenantHsmInstanceAsync(name);

GetSingleTenantHsmInstanceProposal(GetSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
GetSingleTenantHsmInstanceProposalRequest request = new GetSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
SingleTenantHsmInstanceProposal response = hsmManagementClient.GetSingleTenantHsmInstanceProposal(request);

GetSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual SingleTenantHsmInstanceProposal GetSingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposalName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SingleTenantHsmInstanceProposal

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
SingleTenantHsmInstanceProposal response = hsmManagementClient.GetSingleTenantHsmInstanceProposal(name);

GetSingleTenantHsmInstanceProposal(string, CallSettings)

public virtual SingleTenantHsmInstanceProposal GetSingleTenantHsmInstanceProposal(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
SingleTenantHsmInstanceProposal

The RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
SingleTenantHsmInstanceProposal response = hsmManagementClient.GetSingleTenantHsmInstanceProposal(name);

GetSingleTenantHsmInstanceProposalAsync(GetSingleTenantHsmInstanceProposalRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
GetSingleTenantHsmInstanceProposalRequest request = new GetSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(request);

GetSingleTenantHsmInstanceProposalAsync(GetSingleTenantHsmInstanceProposalRequest, CancellationToken)

public virtual Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(GetSingleTenantHsmInstanceProposalRequest request, CancellationToken cancellationToken)

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
GetSingleTenantHsmInstanceProposalRequest request = new GetSingleTenantHsmInstanceProposalRequest
{
    SingleTenantHsmInstanceProposalName = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]"),
};
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(request);

GetSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CallSettings)

public virtual Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, CallSettings callSettings = null)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(name);

GetSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName, CancellationToken)

public virtual Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(SingleTenantHsmInstanceProposalName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name SingleTenantHsmInstanceProposalName

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceProposalName name = SingleTenantHsmInstanceProposalName.FromProjectLocationSingleTenantHsmInstanceProposal("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]", "[PROPOSAL]");
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(name);

GetSingleTenantHsmInstanceProposalAsync(string, CallSettings)

public virtual Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(name);

GetSingleTenantHsmInstanceProposalAsync(string, CancellationToken)

public virtual Task<SingleTenantHsmInstanceProposal> GetSingleTenantHsmInstanceProposalAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name string

Required. The [name][google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name] of the [SingleTenantHsmInstanceProposal][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to get.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskSingleTenantHsmInstanceProposal

A Task containing the RPC response.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]/proposals/[PROPOSAL]";
// Make the request
SingleTenantHsmInstanceProposal response = await hsmManagementClient.GetSingleTenantHsmInstanceProposalAsync(name);

ListSingleTenantHsmInstanceProposals(ListSingleTenantHsmInstanceProposalsRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
ListSingleTenantHsmInstanceProposalsRequest request = new ListSingleTenantHsmInstanceProposalsRequest
{
    ParentAsSingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposals(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstanceProposals(SingleTenantHsmInstanceName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposals(SingleTenantHsmInstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent SingleTenantHsmInstanceName

Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable sequence of SingleTenantHsmInstanceProposal resources.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
SingleTenantHsmInstanceName parent = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
// Make the request
PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposals(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstanceProposals(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposals(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable sequence of SingleTenantHsmInstanceProposal resources.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
// Make the request
PagedEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposals(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstanceProposalsAsync(ListSingleTenantHsmInstanceProposalsRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ListSingleTenantHsmInstanceProposalsRequest request = new ListSingleTenantHsmInstanceProposalsRequest
{
    ParentAsSingleTenantHsmInstanceName = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposalsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstanceProposalsAsync(SingleTenantHsmInstanceName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposalsAsync(SingleTenantHsmInstanceName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent SingleTenantHsmInstanceName

Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable asynchronous sequence of SingleTenantHsmInstanceProposal resources.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
SingleTenantHsmInstanceName parent = SingleTenantHsmInstanceName.FromProjectLocationSingleTenantHsmInstance("[PROJECT]", "[LOCATION]", "[SINGLE_TENANT_HSM_INSTANCE]");
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposalsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstanceProposalsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> ListSingleTenantHsmInstanceProposalsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The resource name of the single tenant HSM instance associated with the [SingleTenantHsmInstanceProposals][google.cloud.kms.v1.SingleTenantHsmInstanceProposal] to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSingleTenantHsmInstanceProposalsResponseSingleTenantHsmInstanceProposal

A pageable asynchronous sequence of SingleTenantHsmInstanceProposal resources.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/singleTenantHsmInstances/[SINGLE_TENANT_HSM_INSTANCE]";
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstanceProposalsResponse, SingleTenantHsmInstanceProposal> response = hsmManagementClient.ListSingleTenantHsmInstanceProposalsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstanceProposal item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstanceProposalsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstanceProposal item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstanceProposal> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstanceProposal item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstances(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstances(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

Required. The resource name of the location associated with the [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to list, in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable sequence of SingleTenantHsmInstance resources.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstances(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstances(ListSingleTenantHsmInstancesRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
ListSingleTenantHsmInstancesRequest request = new ListSingleTenantHsmInstancesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstances(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstances(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstances(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The resource name of the location associated with the [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to list, in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable sequence of SingleTenantHsmInstance resources.

Example
// Create client
HsmManagementClient hsmManagementClient = HsmManagementClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstances(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstancesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstancesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

Required. The resource name of the location associated with the [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to list, in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable asynchronous sequence of SingleTenantHsmInstance resources.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstancesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstancesAsync(ListSingleTenantHsmInstancesRequest, CallSettings)

public virtual 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.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
ListSingleTenantHsmInstancesRequest request = new ListSingleTenantHsmInstancesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    ShowDeleted = false,
};
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstancesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListSingleTenantHsmInstancesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> ListSingleTenantHsmInstancesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The resource name of the location associated with the [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance] to list, in the format projects/*/locations/*.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListSingleTenantHsmInstancesResponseSingleTenantHsmInstance

A pageable asynchronous sequence of SingleTenantHsmInstance resources.

Example
// Create client
HsmManagementClient hsmManagementClient = await HsmManagementClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListSingleTenantHsmInstancesResponse, SingleTenantHsmInstance> response = hsmManagementClient.ListSingleTenantHsmInstancesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (SingleTenantHsmInstance item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListSingleTenantHsmInstancesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (SingleTenantHsmInstance item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<SingleTenantHsmInstance> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (SingleTenantHsmInstance item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateSingleTenantHsmInstance(string, CallSettings)

public virtual Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata> PollOnceCreateSingleTenantHsmInstance(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateSingleTenantHsmInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

The result of polling the operation.

PollOnceCreateSingleTenantHsmInstanceAsync(string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstance, CreateSingleTenantHsmInstanceMetadata>> PollOnceCreateSingleTenantHsmInstanceAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateSingleTenantHsmInstance.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceCreateSingleTenantHsmInstanceMetadata

A task representing the result of polling the operation.

PollOnceCreateSingleTenantHsmInstanceProposal(string, CallSettings)

public virtual Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata> PollOnceCreateSingleTenantHsmInstanceProposal(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateSingleTenantHsmInstanceProposal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

The result of polling the operation.

PollOnceCreateSingleTenantHsmInstanceProposalAsync(string, CallSettings)

public virtual Task<Operation<SingleTenantHsmInstanceProposal, CreateSingleTenantHsmInstanceProposalMetadata>> PollOnceCreateSingleTenantHsmInstanceProposalAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateSingleTenantHsmInstanceProposal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationSingleTenantHsmInstanceProposalCreateSingleTenantHsmInstanceProposalMetadata

A task representing the result of polling the operation.

PollOnceExecuteSingleTenantHsmInstanceProposal(string, CallSettings)

public virtual Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata> PollOnceExecuteSingleTenantHsmInstanceProposal(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExecuteSingleTenantHsmInstanceProposal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

The result of polling the operation.

PollOnceExecuteSingleTenantHsmInstanceProposalAsync(string, CallSettings)

public virtual Task<Operation<ExecuteSingleTenantHsmInstanceProposalResponse, ExecuteSingleTenantHsmInstanceProposalMetadata>> PollOnceExecuteSingleTenantHsmInstanceProposalAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExecuteSingleTenantHsmInstanceProposal.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationExecuteSingleTenantHsmInstanceProposalResponseExecuteSingleTenantHsmInstanceProposalMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.