Class v1.HsmManagementClient (5.3.0)

Google Cloud HSM Management Service

Provides interfaces for managing HSM instances.

Implements a REST model with the following objects: * * v1

Package

@google-cloud/kms

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of HsmManagementClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new HsmManagementClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

hsmManagementStub

hsmManagementStub?: Promise<{
        [name: string]: Function;
    }>;

iamClient

iamClient: IamClient;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

approveSingleTenantHsmInstanceProposal(request, options)

approveSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[
        protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse,
        protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | undefined,
        {} | undefined
    ]>;

Approves a for a given . The proposal must be in the state.

Parameters
Name Description
request IApproveSingleTenantHsmInstanceProposalRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ApproveSingleTenantHsmInstanceProposalResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  name google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name  of the
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to approve.
   */
  // const name = 'abc123'
  /**
   *  Required. The reply to
   *  QuorumParameters google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters 
   *  for approving the proposal.
   */
  // const quorumReply = {}
  /**
   *  Required. The reply to
   *  RequiredActionQuorumParameters google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters 
   *  for approving the proposal.
   */
  // const requiredActionQuorumReply = {}

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callApproveSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      name,
      quorumReply,
      requiredActionQuorumReply,
    };

    // Run request
    const response = await kmsClient.approveSingleTenantHsmInstanceProposal(request);
    console.log(response);
  }

  callApproveSingleTenantHsmInstanceProposal();

approveSingleTenantHsmInstanceProposal(request, options, callback)

approveSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback<protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApproveSingleTenantHsmInstanceProposalRequest
options CallOptions
callback Callback<protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

approveSingleTenantHsmInstanceProposal(request, callback)

approveSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, callback: Callback<protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IApproveSingleTenantHsmInstanceProposalRequest
callback Callback<protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

autokeyConfigPath(folder)

autokeyConfigPath(folder: string): string;

Return a fully-qualified autokeyConfig resource name string.

Parameter
Name Description
folder string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateSingleTenantHsmInstanceProgress(name)

checkCreateSingleTenantHsmInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.kms.v1.SingleTenantHsmInstance, protos.google.cloud.kms.v1.CreateSingleTenantHsmInstanceMetadata>>;

Check the status of the long running operation returned by createSingleTenantHsmInstance().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.kms.v1.SingleTenantHsmInstance, protos.google.cloud.kms.v1.CreateSingleTenantHsmInstanceMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location associated with the
   *  SingleTenantHsmInstance google.cloud.kms.v1.SingleTenantHsmInstance, in
   *  the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`.
   */
  // const singleTenantHsmInstanceId = 'abc123'
  /**
   *  Required. An
   *  SingleTenantHsmInstance google.cloud.kms.v1.SingleTenantHsmInstance  with
   *  initial field values.
   */
  // const singleTenantHsmInstance = {}

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callCreateSingleTenantHsmInstance() {
    // Construct request
    const request = {
      parent,
      singleTenantHsmInstance,
    };

    // Run request
    const [operation] = await kmsClient.createSingleTenantHsmInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSingleTenantHsmInstance();

checkCreateSingleTenantHsmInstanceProposalProgress(name)

checkCreateSingleTenantHsmInstanceProposalProgress(name: string): Promise<LROperation<protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.CreateSingleTenantHsmInstanceProposalMetadata>>;

Check the status of the long running operation returned by createSingleTenantHsmInstanceProposal().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.CreateSingleTenantHsmInstanceProposalMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  Optional. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`.
   */
  // const singleTenantHsmInstanceProposalId = 'abc123'
  /**
   *  Required. The
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to create.
   */
  // const singleTenantHsmInstanceProposal = {}

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callCreateSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      parent,
      singleTenantHsmInstanceProposal,
    };

    // Run request
    const [operation] = await kmsClient.createSingleTenantHsmInstanceProposal(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSingleTenantHsmInstanceProposal();

checkExecuteSingleTenantHsmInstanceProposalProgress(name)

checkExecuteSingleTenantHsmInstanceProposalProgress(name: string): Promise<LROperation<protos.google.cloud.kms.v1.ExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.ExecuteSingleTenantHsmInstanceProposalMetadata>>;

Check the status of the long running operation returned by executeSingleTenantHsmInstanceProposal().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.kms.v1.ExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.ExecuteSingleTenantHsmInstanceProposalMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  name google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name  of the
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to execute.
   */
  // const name = 'abc123'

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callExecuteSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await kmsClient.executeSingleTenantHsmInstanceProposal(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExecuteSingleTenantHsmInstanceProposal();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createSingleTenantHsmInstance(request, options)

createSingleTenantHsmInstance(request?: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new 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 ICreateSingleTenantHsmInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location associated with the
   *  SingleTenantHsmInstance google.cloud.kms.v1.SingleTenantHsmInstance, in
   *  the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`.
   */
  // const singleTenantHsmInstanceId = 'abc123'
  /**
   *  Required. An
   *  SingleTenantHsmInstance google.cloud.kms.v1.SingleTenantHsmInstance  with
   *  initial field values.
   */
  // const singleTenantHsmInstance = {}

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callCreateSingleTenantHsmInstance() {
    // Construct request
    const request = {
      parent,
      singleTenantHsmInstance,
    };

    // Run request
    const [operation] = await kmsClient.createSingleTenantHsmInstance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSingleTenantHsmInstance();

createSingleTenantHsmInstance(request, options, callback)

createSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSingleTenantHsmInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createSingleTenantHsmInstance(request, callback)

createSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, callback: Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSingleTenantHsmInstanceRequest
callback Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createSingleTenantHsmInstanceProposal(request, options)

createSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new for a given .

Parameters
Name Description
request ICreateSingleTenantHsmInstanceProposalRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  Optional. It must be unique within a location and match the regular
   *  expression `[a-zA-Z0-9_-]{1,63}`.
   */
  // const singleTenantHsmInstanceProposalId = 'abc123'
  /**
   *  Required. The
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to create.
   */
  // const singleTenantHsmInstanceProposal = {}

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callCreateSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      parent,
      singleTenantHsmInstanceProposal,
    };

    // Run request
    const [operation] = await kmsClient.createSingleTenantHsmInstanceProposal(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSingleTenantHsmInstanceProposal();

createSingleTenantHsmInstanceProposal(request, options, callback)

createSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSingleTenantHsmInstanceProposalRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createSingleTenantHsmInstanceProposal(request, callback)

createSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, callback: Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateSingleTenantHsmInstanceProposalRequest
callback Callback<LROperation<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

cryptoKeyPath(project, location, keyRing, cryptoKey)

cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string;

Return a fully-qualified cryptoKey resource name string.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
Returns
Type Description
string

{string} Resource name string.

cryptoKeyVersionPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)

cryptoKeyVersionPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;

Return a fully-qualified cryptoKeyVersion resource name string.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
cryptoKeyVersion string
Returns
Type Description
string

{string} Resource name string.

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteSingleTenantHsmInstanceProposal(request, options)

deleteSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | undefined,
        {} | undefined
    ]>;

Deletes a .

Parameters
Name Description
request IDeleteSingleTenantHsmInstanceProposalRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  name google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name  of the
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to delete.
   */
  // const name = 'abc123'

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callDeleteSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await kmsClient.deleteSingleTenantHsmInstanceProposal(request);
    console.log(response);
  }

  callDeleteSingleTenantHsmInstanceProposal();

deleteSingleTenantHsmInstanceProposal(request, options, callback)

deleteSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteSingleTenantHsmInstanceProposalRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteSingleTenantHsmInstanceProposal(request, callback)

deleteSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteSingleTenantHsmInstanceProposalRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

ekmConfigPath(project, location)

ekmConfigPath(project: string, location: string): string;

Return a fully-qualified ekmConfig resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

ekmConnectionPath(project, location, ekmConnection)

ekmConnectionPath(project: string, location: string, ekmConnection: string): string;

Return a fully-qualified ekmConnection resource name string.

Parameters
Name Description
project string
location string
ekmConnection string
Returns
Type Description
string

{string} Resource name string.

executeSingleTenantHsmInstanceProposal(request, options)

executeSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Executes a for a given . The proposal must be in the state.

Parameters
Name Description
request IExecuteSingleTenantHsmInstanceProposalRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  name google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name  of the
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to execute.
   */
  // const name = 'abc123'

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callExecuteSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await kmsClient.executeSingleTenantHsmInstanceProposal(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExecuteSingleTenantHsmInstanceProposal();

executeSingleTenantHsmInstanceProposal(request, options, callback)

executeSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExecuteSingleTenantHsmInstanceProposalRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

executeSingleTenantHsmInstanceProposal(request, callback)

executeSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, callback: Callback<LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IExecuteSingleTenantHsmInstanceProposalRequest
callback Callback<LROperation<protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalResponse, protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, options, callback)

getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request IamProtos.google.iam.v1.GetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getSingleTenantHsmInstance(request, options)

getSingleTenantHsmInstance(request?: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.kms.v1.ISingleTenantHsmInstance,
        protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | undefined,
        {} | undefined
    ]>;

Returns metadata for a given .

Parameters
Name Description
request IGetSingleTenantHsmInstanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name google.cloud.kms.v1.SingleTenantHsmInstance.name  of
   *  the SingleTenantHsmInstance google.cloud.kms.v1.SingleTenantHsmInstance 
   *  to get.
   */
  // const name = 'abc123'

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callGetSingleTenantHsmInstance() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await kmsClient.getSingleTenantHsmInstance(request);
    console.log(response);
  }

  callGetSingleTenantHsmInstance();

getSingleTenantHsmInstance(request, options, callback)

getSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSingleTenantHsmInstanceRequest
options CallOptions
callback Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getSingleTenantHsmInstance(request, callback)

getSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, callback: Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSingleTenantHsmInstanceRequest
callback Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstance, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getSingleTenantHsmInstanceProposal(request, options)

getSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[
        protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal,
        protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | undefined,
        {} | undefined
    ]>;

Returns metadata for a given .

Parameters
Name Description
request IGetSingleTenantHsmInstanceProposalRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The
   *  name google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name  of the
   *  SingleTenantHsmInstanceProposal google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to get.
   */
  // const name = 'abc123'

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callGetSingleTenantHsmInstanceProposal() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await kmsClient.getSingleTenantHsmInstanceProposal(request);
    console.log(response);
  }

  callGetSingleTenantHsmInstanceProposal();

getSingleTenantHsmInstanceProposal(request, options, callback)

getSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSingleTenantHsmInstanceProposalRequest
options CallOptions
callback Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getSingleTenantHsmInstanceProposal(request, callback)

getSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, callback: Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetSingleTenantHsmInstanceProposalRequest
callback Callback<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal, protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

importJobPath(project, location, keyRing, importJob)

importJobPath(project: string, location: string, keyRing: string, importJob: string): string;

Return a fully-qualified importJob resource name string.

Parameters
Name Description
project string
location string
keyRing string
importJob string
Returns
Type Description
string

{string} Resource name string.

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

keyHandlePath(project, location, keyHandle)

keyHandlePath(project: string, location: string, keyHandle: string): string;

Return a fully-qualified keyHandle resource name string.

Parameters
Name Description
project string
location string
keyHandle string
Returns
Type Description
string

{string} Resource name string.

keyRingPath(project, location, keyRing)

keyRingPath(project: string, location: string, keyRing: string): string;

Return a fully-qualified keyRing resource name string.

Parameters
Name Description
project string
location string
keyRing string
Returns
Type Description
string

{string} Resource name string.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listSingleTenantHsmInstanceProposals(request, options)

listSingleTenantHsmInstanceProposals(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal[],
        protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest | null,
        protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse
    ]>;

Lists .

Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal[], protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest | null, protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listSingleTenantHsmInstanceProposalsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSingleTenantHsmInstanceProposals(request, options, callback)

listSingleTenantHsmInstanceProposals(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>): void;
Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>
Returns
Type Description
void

listSingleTenantHsmInstanceProposals(request, callback)

listSingleTenantHsmInstanceProposals(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, callback: PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>): void;
Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest
callback PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>
Returns
Type Description
void

listSingleTenantHsmInstanceProposalsAsync(request, options)

listSingleTenantHsmInstanceProposalsAsync(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>;

Equivalent to listSingleTenantHsmInstanceProposals, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.kms.v1.ISingleTenantHsmInstanceProposal>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Optional limit on the number of
   *  SingleTenantHsmInstanceProposals google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  to include in the response. Further
   *  SingleTenantHsmInstanceProposals google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  can subsequently be obtained by including the
   *  ListSingleTenantHsmInstanceProposalsResponse.next_page_token google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token 
   *  in a subsequent request. If unspecified, the server will pick an
   *  appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. Optional pagination token, returned earlier via
   *  ListSingleTenantHsmInstanceProposalsResponse.next_page_token google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Only include resources that match the filter in the response. For
   *  more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specify how the results should be sorted. If not specified, the
   *  results will be sorted in the default order.  For more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If set to true,
   *  HsmManagement.ListSingleTenantHsmInstanceProposals google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstanceProposals 
   *  will also return
   *  SingleTenantHsmInstanceProposals google.cloud.kms.v1.SingleTenantHsmInstanceProposal 
   *  in DELETED state.
   */
  // const showDeleted = true

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callListSingleTenantHsmInstanceProposals() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = kmsClient.listSingleTenantHsmInstanceProposalsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListSingleTenantHsmInstanceProposals();

listSingleTenantHsmInstanceProposalsStream(request, options)

listSingleTenantHsmInstanceProposalsStream(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options?: CallOptions): Transform;

Equivalent to listSingleTenantHsmInstanceProposals, but returns a NodeJS Stream object.

Parameters
Name Description
request IListSingleTenantHsmInstanceProposalsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSingleTenantHsmInstanceProposalsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSingleTenantHsmInstances(request, options)

listSingleTenantHsmInstances(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.kms.v1.ISingleTenantHsmInstance[],
        protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest | null,
        protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse
    ]>;

Lists .

Parameters
Name Description
request IListSingleTenantHsmInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.kms.v1.ISingleTenantHsmInstance[], protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest | null, protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listSingleTenantHsmInstancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSingleTenantHsmInstances(request, options, callback)

listSingleTenantHsmInstances(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstance>): void;
Parameters
Name Description
request IListSingleTenantHsmInstancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstance>
Returns
Type Description
void

listSingleTenantHsmInstances(request, callback)

listSingleTenantHsmInstances(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, callback: PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstance>): void;
Parameters
Name Description
request IListSingleTenantHsmInstancesRequest
callback PaginationCallback<protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesResponse | null | undefined, protos.google.cloud.kms.v1.ISingleTenantHsmInstance>
Returns
Type Description
void

listSingleTenantHsmInstancesAsync(request, options)

listSingleTenantHsmInstancesAsync(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.kms.v1.ISingleTenantHsmInstance>;

Equivalent to listSingleTenantHsmInstances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListSingleTenantHsmInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.kms.v1.ISingleTenantHsmInstance>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the location associated with the
   *  SingleTenantHsmInstances google.cloud.kms.v1.SingleTenantHsmInstance  to
   *  list, in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. Optional limit on the number of
   *  SingleTenantHsmInstances google.cloud.kms.v1.SingleTenantHsmInstance  to
   *  include in the response. Further
   *  SingleTenantHsmInstances google.cloud.kms.v1.SingleTenantHsmInstance  can
   *  subsequently be
   *  obtained by including the
   *  ListSingleTenantHsmInstancesResponse.next_page_token google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token 
   *  in a subsequent request. If unspecified, the server will pick an
   *  appropriate default.
   */
  // const pageSize = 1234
  /**
   *  Optional. Optional pagination token, returned earlier via
   *  ListSingleTenantHsmInstancesResponse.next_page_token google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Only include resources that match the filter in the response. For
   *  more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const filter = 'abc123'
  /**
   *  Optional. Specify how the results should be sorted. If not specified, the
   *  results will be sorted in the default order.  For more information, see
   *  Sorting and filtering list
   *  results (https://cloud.google.com/kms/docs/sorting-and-filtering).
   */
  // const orderBy = 'abc123'
  /**
   *  Optional. If set to true,
   *  HsmManagement.ListSingleTenantHsmInstances google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances 
   *  will also return
   *  SingleTenantHsmInstances google.cloud.kms.v1.SingleTenantHsmInstance  in
   *  DELETED state.
   */
  // const showDeleted = true

  // Imports the Kms library
  const {HsmManagementClient} = require('@google-cloud/kms').v1;

  // Instantiates a client
  const kmsClient = new HsmManagementClient();

  async function callListSingleTenantHsmInstances() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = kmsClient.listSingleTenantHsmInstancesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListSingleTenantHsmInstances();

listSingleTenantHsmInstancesStream(request, options)

listSingleTenantHsmInstancesStream(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options?: CallOptions): Transform;

Equivalent to listSingleTenantHsmInstances, but returns a NodeJS Stream object.

Parameters
Name Description
request IListSingleTenantHsmInstancesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSingleTenantHsmInstancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the crypto_key from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key.

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the crypto_key from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key.

matchCryptoKeyFromPublicKeyName(publicKeyName)

matchCryptoKeyFromPublicKeyName(publicKeyName: string): string | number;

Parse the crypto_key from PublicKey resource.

Parameter
Name Description
publicKeyName string

A fully-qualified path representing PublicKey resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key.

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the crypto_key_version from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key_version.

matchCryptoKeyVersionFromPublicKeyName(publicKeyName)

matchCryptoKeyVersionFromPublicKeyName(publicKeyName: string): string | number;

Parse the crypto_key_version from PublicKey resource.

Parameter
Name Description
publicKeyName string

A fully-qualified path representing PublicKey resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key_version.

matchEkmConnectionFromEkmConnectionName(ekmConnectionName)

matchEkmConnectionFromEkmConnectionName(ekmConnectionName: string): string | number;

Parse the ekm_connection from EkmConnection resource.

Parameter
Name Description
ekmConnectionName string

A fully-qualified path representing EkmConnection resource.

Returns
Type Description
string | number

{string} A string representing the ekm_connection.

matchFolderFromAutokeyConfigName(autokeyConfigName)

matchFolderFromAutokeyConfigName(autokeyConfigName: string): string | number;

Parse the folder from AutokeyConfig resource.

Parameter
Name Description
autokeyConfigName string

A fully-qualified path representing AutokeyConfig resource.

Returns
Type Description
string | number

{string} A string representing the folder.

matchImportJobFromImportJobName(importJobName)

matchImportJobFromImportJobName(importJobName: string): string | number;

Parse the import_job from ImportJob resource.

Parameter
Name Description
importJobName string

A fully-qualified path representing ImportJob resource.

Returns
Type Description
string | number

{string} A string representing the import_job.

matchKeyHandleFromKeyHandleName(keyHandleName)

matchKeyHandleFromKeyHandleName(keyHandleName: string): string | number;

Parse the key_handle from KeyHandle resource.

Parameter
Name Description
keyHandleName string

A fully-qualified path representing KeyHandle resource.

Returns
Type Description
string | number

{string} A string representing the key_handle.

matchKeyRingFromCryptoKeyName(cryptoKeyName)

matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the key_ring from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the key_ring from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchKeyRingFromImportJobName(importJobName)

matchKeyRingFromImportJobName(importJobName: string): string | number;

Parse the key_ring from ImportJob resource.

Parameter
Name Description
importJobName string

A fully-qualified path representing ImportJob resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchKeyRingFromKeyRingName(keyRingName)

matchKeyRingFromKeyRingName(keyRingName: string): string | number;

Parse the key_ring from KeyRing resource.

Parameter
Name Description
keyRingName string

A fully-qualified path representing KeyRing resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchKeyRingFromPublicKeyName(publicKeyName)

matchKeyRingFromPublicKeyName(publicKeyName: string): string | number;

Parse the key_ring from PublicKey resource.

Parameter
Name Description
publicKeyName string

A fully-qualified path representing PublicKey resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchLocationFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the location from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the location from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEkmConfigName(ekmConfigName)

matchLocationFromEkmConfigName(ekmConfigName: string): string | number;

Parse the location from EkmConfig resource.

Parameter
Name Description
ekmConfigName string

A fully-qualified path representing EkmConfig resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEkmConnectionName(ekmConnectionName)

matchLocationFromEkmConnectionName(ekmConnectionName: string): string | number;

Parse the location from EkmConnection resource.

Parameter
Name Description
ekmConnectionName string

A fully-qualified path representing EkmConnection resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromImportJobName(importJobName)

matchLocationFromImportJobName(importJobName: string): string | number;

Parse the location from ImportJob resource.

Parameter
Name Description
importJobName string

A fully-qualified path representing ImportJob resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromKeyHandleName(keyHandleName)

matchLocationFromKeyHandleName(keyHandleName: string): string | number;

Parse the location from KeyHandle resource.

Parameter
Name Description
keyHandleName string

A fully-qualified path representing KeyHandle resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromKeyRingName(keyRingName)

matchLocationFromKeyRingName(keyRingName: string): string | number;

Parse the location from KeyRing resource.

Parameter
Name Description
keyRingName string

A fully-qualified path representing KeyRing resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromPublicKeyName(publicKeyName)

matchLocationFromPublicKeyName(publicKeyName: string): string | number;

Parse the location from PublicKey resource.

Parameter
Name Description
publicKeyName string

A fully-qualified path representing PublicKey resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName)

matchLocationFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number;

Parse the location from SingleTenantHsmInstance resource.

Parameter
Name Description
singleTenantHsmInstanceName string

A fully-qualified path representing SingleTenantHsmInstance resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName)

matchLocationFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number;

Parse the location from SingleTenantHsmInstanceProposal resource.

Parameter
Name Description
singleTenantHsmInstanceProposalName string

A fully-qualified path representing SingleTenantHsmInstanceProposal resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromCryptoKeyName(cryptoKeyName)

matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the project from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the project from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEkmConfigName(ekmConfigName)

matchProjectFromEkmConfigName(ekmConfigName: string): string | number;

Parse the project from EkmConfig resource.

Parameter
Name Description
ekmConfigName string

A fully-qualified path representing EkmConfig resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEkmConnectionName(ekmConnectionName)

matchProjectFromEkmConnectionName(ekmConnectionName: string): string | number;

Parse the project from EkmConnection resource.

Parameter
Name Description
ekmConnectionName string

A fully-qualified path representing EkmConnection resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromImportJobName(importJobName)

matchProjectFromImportJobName(importJobName: string): string | number;

Parse the project from ImportJob resource.

Parameter
Name Description
importJobName string

A fully-qualified path representing ImportJob resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromKeyHandleName(keyHandleName)

matchProjectFromKeyHandleName(keyHandleName: string): string | number;

Parse the project from KeyHandle resource.

Parameter
Name Description
keyHandleName string

A fully-qualified path representing KeyHandle resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromKeyRingName(keyRingName)

matchProjectFromKeyRingName(keyRingName: string): string | number;

Parse the project from KeyRing resource.

Parameter
Name Description
keyRingName string

A fully-qualified path representing KeyRing resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromPublicKeyName(publicKeyName)

matchProjectFromPublicKeyName(publicKeyName: string): string | number;

Parse the project from PublicKey resource.

Parameter
Name Description
publicKeyName string

A fully-qualified path representing PublicKey resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName)

matchProjectFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number;

Parse the project from SingleTenantHsmInstance resource.

Parameter
Name Description
singleTenantHsmInstanceName string

A fully-qualified path representing SingleTenantHsmInstance resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName)

matchProjectFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number;

Parse the project from SingleTenantHsmInstanceProposal resource.

Parameter
Name Description
singleTenantHsmInstanceProposalName string

A fully-qualified path representing SingleTenantHsmInstanceProposal resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProposalFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName)

matchProposalFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number;

Parse the proposal from SingleTenantHsmInstanceProposal resource.

Parameter
Name Description
singleTenantHsmInstanceProposalName string

A fully-qualified path representing SingleTenantHsmInstanceProposal resource.

Returns
Type Description
string | number

{string} A string representing the proposal.

matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName)

matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number;

Parse the single_tenant_hsm_instance from SingleTenantHsmInstance resource.

Parameter
Name Description
singleTenantHsmInstanceName string

A fully-qualified path representing SingleTenantHsmInstance resource.

Returns
Type Description
string | number

{string} A string representing the single_tenant_hsm_instance.

matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName)

matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number;

Parse the single_tenant_hsm_instance from SingleTenantHsmInstanceProposal resource.

Parameter
Name Description
singleTenantHsmInstanceProposalName string

A fully-qualified path representing SingleTenantHsmInstanceProposal resource.

Returns
Type Description
string | number

{string} A string representing the single_tenant_hsm_instance.

publicKeyPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)

publicKeyPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;

Return a fully-qualified publicKey resource name string.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
cryptoKeyVersion string
Returns
Type Description
string

{string} Resource name string.

setIamPolicy(request, options, callback)

setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.SetIamPolicyRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.Policy]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

singleTenantHsmInstancePath(project, location, singleTenantHsmInstance)

singleTenantHsmInstancePath(project: string, location: string, singleTenantHsmInstance: string): string;

Return a fully-qualified singleTenantHsmInstance resource name string.

Parameters
Name Description
project string
location string
singleTenantHsmInstance string
Returns
Type Description
string

{string} Resource name string.

singleTenantHsmInstanceProposalPath(project, location, singleTenantHsmInstance, proposal)

singleTenantHsmInstanceProposalPath(project: string, location: string, singleTenantHsmInstance: string, proposal: string): string;

Return a fully-qualified singleTenantHsmInstanceProposal resource name string.

Parameters
Name Description
project string
location string
singleTenantHsmInstance string
proposal string
Returns
Type Description
string

{string} Resource name string.

testIamPermissions(request, options, callback)

testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters
Name Description
request IamProtos.google.iam.v1.TestIamPermissionsRequest

The request object that will be sent.

options CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing .

Returns
Type Description
Promise<[google.iam.v1.TestIamPermissionsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.