import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, IamClient, IamProtos, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Google Cloud HSM Management Service * * Provides interfaces for managing HSM instances. * * Implements a REST model with the following objects: * * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance} * * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * @class * @memberof v1 */ export declare class HsmManagementClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; iamClient: IamClient; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; hsmManagementStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of HsmManagementClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: 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); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Returns metadata for a given * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance.name|name} of * the {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance} * to get. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.get_single_tenant_hsm_instance.js * region_tag:cloudkms_v1_generated_HsmManagement_GetSingleTenantHsmInstance_async */ 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 ]>; getSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, options: CallOptions, callback: Callback): void; getSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceRequest, callback: Callback): void; /** * Approves a * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * for a given * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. The * proposal must be in the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.PENDING|PENDING} * state. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name|name} of the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * to approve. * @param {google.cloud.kms.v1.ApproveSingleTenantHsmInstanceProposalRequest.QuorumReply} request.quorumReply * Required. The reply to * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.QuorumParameters|QuorumParameters} * for approving the proposal. * @param {google.cloud.kms.v1.ApproveSingleTenantHsmInstanceProposalRequest.RequiredActionQuorumReply} request.requiredActionQuorumReply * Required. The reply to * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.RequiredActionQuorumParameters|RequiredActionQuorumParameters} * for approving the proposal. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.kms.v1.ApproveSingleTenantHsmInstanceProposalResponse|ApproveSingleTenantHsmInstanceProposalResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.approve_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_ApproveSingleTenantHsmInstanceProposal_async */ 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 ]>; approveSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback): void; approveSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IApproveSingleTenantHsmInstanceProposalRequest, callback: Callback): void; /** * Returns metadata for a given * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name|name} of the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * to get. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.get_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_GetSingleTenantHsmInstanceProposal_async */ 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 ]>; getSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback): void; getSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IGetSingleTenantHsmInstanceProposalRequest, callback: Callback): void; /** * Deletes a * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name|name} of the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * to delete. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.delete_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_DeleteSingleTenantHsmInstanceProposal_async */ deleteSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest | undefined), {} | undefined ]>; deleteSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback): void; deleteSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IDeleteSingleTenantHsmInstanceProposalRequest, callback: Callback): void; /** * Creates a new * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|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. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the location associated with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}, in * the format `projects/* /locations/*`. * @param {string} [request.singleTenantHsmInstanceId] * Optional. It must be unique within a location and match the regular * expression `[a-zA-Z0-9_-]{1,63}`. * @param {google.cloud.kms.v1.SingleTenantHsmInstance} request.singleTenantHsmInstance * Required. An * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance} with * initial field values. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.create_single_tenant_hsm_instance.js * region_tag:cloudkms_v1_generated_HsmManagement_CreateSingleTenantHsmInstance_async */ createSingleTenantHsmInstance(request?: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createSingleTenantHsmInstance(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createSingleTenantHsmInstance()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.create_single_tenant_hsm_instance.js * region_tag:cloudkms_v1_generated_HsmManagement_CreateSingleTenantHsmInstance_async */ checkCreateSingleTenantHsmInstanceProgress(name: string): Promise>; /** * Creates a new * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * for a given * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance.name|name} of * the {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance} * associated with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals}. * @param {string} [request.singleTenantHsmInstanceProposalId] * Optional. It must be unique within a location and match the regular * expression `[a-zA-Z0-9_-]{1,63}`. * @param {google.cloud.kms.v1.SingleTenantHsmInstanceProposal} request.singleTenantHsmInstanceProposal * Required. The * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * to create. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.create_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_CreateSingleTenantHsmInstanceProposal_async */ createSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.ICreateSingleTenantHsmInstanceProposalRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createSingleTenantHsmInstanceProposal()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.create_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_CreateSingleTenantHsmInstanceProposal_async */ checkCreateSingleTenantHsmInstanceProposalProgress(name: string): Promise>; /** * Executes a * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * for a given * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. The * proposal must be in the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.State.APPROVED|APPROVED} * state. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal.name|name} of the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} * to execute. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.execute_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_ExecuteSingleTenantHsmInstanceProposal_async */ executeSingleTenantHsmInstanceProposal(request?: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; executeSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; executeSingleTenantHsmInstanceProposal(request: protos.google.cloud.kms.v1.IExecuteSingleTenantHsmInstanceProposalRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `executeSingleTenantHsmInstanceProposal()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.execute_single_tenant_hsm_instance_proposal.js * region_tag:cloudkms_v1_generated_HsmManagement_ExecuteSingleTenantHsmInstanceProposal_async */ checkExecuteSingleTenantHsmInstanceProposalProgress(name: string): Promise>; /** * Lists * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances}. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the location associated with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * list, in the format `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} can * subsequently be * obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances|HsmManagement.ListSingleTenantHsmInstances} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} in * DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. * 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ 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 ]>; listSingleTenantHsmInstances(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options: CallOptions, callback: PaginationCallback): void; listSingleTenantHsmInstances(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, callback: PaginationCallback): void; /** * Equivalent to `listSingleTenantHsmInstances`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the location associated with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * list, in the format `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} can * subsequently be * obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances|HsmManagement.ListSingleTenantHsmInstances} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} in * DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance} 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSingleTenantHsmInstancesStream(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options?: CallOptions): Transform; /** * Equivalent to `listSingleTenantHsmInstances`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the location associated with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * list, in the format `projects/* /locations/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} to * include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} can * subsequently be * obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse.next_page_token|ListSingleTenantHsmInstancesResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances|HsmManagement.ListSingleTenantHsmInstances} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstances} in * DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstance|SingleTenantHsmInstance}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.list_single_tenant_hsm_instances.js * region_tag:cloudkms_v1_generated_HsmManagement_ListSingleTenantHsmInstances_async */ listSingleTenantHsmInstancesAsync(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstancesRequest, options?: CallOptions): AsyncIterable; /** * Lists * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals}. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the single tenant HSM instance associated * with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to list, in the format `projects/* /locations/* /singleTenantHsmInstances/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * can subsequently be obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstanceProposals|HsmManagement.ListSingleTenantHsmInstanceProposals} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * in DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal}. * 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ 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 ]>; listSingleTenantHsmInstanceProposals(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options: CallOptions, callback: PaginationCallback): void; listSingleTenantHsmInstanceProposals(request: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, callback: PaginationCallback): void; /** * Equivalent to `listSingleTenantHsmInstanceProposals`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the single tenant HSM instance associated * with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to list, in the format `projects/* /locations/* /singleTenantHsmInstances/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * can subsequently be obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstanceProposals|HsmManagement.ListSingleTenantHsmInstanceProposals} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * in DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal} 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listSingleTenantHsmInstanceProposalsStream(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options?: CallOptions): Transform; /** * Equivalent to `listSingleTenantHsmInstanceProposals`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the single tenant HSM instance associated * with the * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to list, in the format `projects/* /locations/* /singleTenantHsmInstances/*`. * @param {number} [request.pageSize] * Optional. Optional limit on the number of * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * to include in the response. Further * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * can subsequently be obtained by including the * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token} * in a subsequent request. If unspecified, the server will pick an * appropriate default. * @param {string} [request.pageToken] * Optional. Optional pagination token, returned earlier via * {@link protos.google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsResponse.next_page_token|ListSingleTenantHsmInstanceProposalsResponse.next_page_token}. * @param {string} [request.filter] * 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). * @param {string} [request.orderBy] * 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). * @param {boolean} [request.showDeleted] * Optional. If set to true, * {@link protos.google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstanceProposals|HsmManagement.ListSingleTenantHsmInstanceProposals} * will also return * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposals} * in DELETED state. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.kms.v1.SingleTenantHsmInstanceProposal|SingleTenantHsmInstanceProposal}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/hsm_management.list_single_tenant_hsm_instance_proposals.js * region_tag:cloudkms_v1_generated_HsmManagement_ListSingleTenantHsmInstanceProposals_async */ listSingleTenantHsmInstanceProposalsAsync(request?: protos.google.cloud.kms.v1.IListSingleTenantHsmInstanceProposalsRequest, options?: CallOptions): AsyncIterable; /** * Gets the access control policy for a resource. Returns an empty policy * if the resource exists and does not have a policy set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {Object} [request.options] * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. This field is only used by Cloud IAM. * * This object should have the same structure as {@link google.iam.v1.GetPolicyOptions | GetPolicyOptions}. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.Policy | Policy}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.Policy | Policy}. * The promise has a method named "cancel" which cancels the ongoing API call. */ getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. */ setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback, callback?: Callback): 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see {@link https://cloud.google.com/iam/docs/overview#permissions | IAM Overview }. * @param {Object} [options] * Optional parameters. You can override the default settings for this call, e.g, timeout, * retries, paginations, etc. See {@link https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html | gax.CallOptions} for the details. * @param {function(?Error, ?Object)} [callback] * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse | TestIamPermissionsResponse}. * The promise has a method named "cancel" which cancels the ongoing API call. * */ testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. * * @example * ``` * const client = longrunning.operationsClient(); * const name = ''; * const [response] = await client.getOperation({name}); * // doThingsWith(response) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * The maximum number of resources contained in the underlying API * response. If page streaming is performed per-resource, this * parameter does not affect the return value. If page streaming is * performed per-page, this determines the maximum number of * resources in a page. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 * {@link Operations.GetOperation} 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.cancelOperation({name: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.deleteOperation({name: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified cryptoKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @returns {string} Resource name string. */ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string; /** * Parse the project from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the location from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the key_ring from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the crypto_key from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Return a fully-qualified cryptoKeyVersion resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @param {string} crypto_key_version * @returns {string} Resource name string. */ cryptoKeyVersionPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string; /** * Parse the project from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the location from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the key_ring from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the crypto_key from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Parse the crypto_key_version from CryptoKeyVersion resource. * * @param {string} cryptoKeyVersionName * A fully-qualified path representing CryptoKeyVersion resource. * @returns {string} A string representing the crypto_key_version. */ matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number; /** * Return a fully-qualified ekmConfig resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ ekmConfigPath(project: string, location: string): string; /** * Parse the project from EkmConfig resource. * * @param {string} ekmConfigName * A fully-qualified path representing EkmConfig resource. * @returns {string} A string representing the project. */ matchProjectFromEkmConfigName(ekmConfigName: string): string | number; /** * Parse the location from EkmConfig resource. * * @param {string} ekmConfigName * A fully-qualified path representing EkmConfig resource. * @returns {string} A string representing the location. */ matchLocationFromEkmConfigName(ekmConfigName: string): string | number; /** * Return a fully-qualified ekmConnection resource name string. * * @param {string} project * @param {string} location * @param {string} ekm_connection * @returns {string} Resource name string. */ ekmConnectionPath(project: string, location: string, ekmConnection: string): string; /** * Parse the project from EkmConnection resource. * * @param {string} ekmConnectionName * A fully-qualified path representing EkmConnection resource. * @returns {string} A string representing the project. */ matchProjectFromEkmConnectionName(ekmConnectionName: string): string | number; /** * Parse the location from EkmConnection resource. * * @param {string} ekmConnectionName * A fully-qualified path representing EkmConnection resource. * @returns {string} A string representing the location. */ matchLocationFromEkmConnectionName(ekmConnectionName: string): string | number; /** * Parse the ekm_connection from EkmConnection resource. * * @param {string} ekmConnectionName * A fully-qualified path representing EkmConnection resource. * @returns {string} A string representing the ekm_connection. */ matchEkmConnectionFromEkmConnectionName(ekmConnectionName: string): string | number; /** * Return a fully-qualified folderAutokeyConfig resource name string. * * @param {string} folder * @returns {string} Resource name string. */ folderAutokeyConfigPath(folder: string): string; /** * Parse the folder from FolderAutokeyConfig resource. * * @param {string} folderAutokeyConfigName * A fully-qualified path representing folder_autokeyConfig resource. * @returns {string} A string representing the folder. */ matchFolderFromFolderAutokeyConfigName(folderAutokeyConfigName: string): string | number; /** * Return a fully-qualified importJob resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} import_job * @returns {string} Resource name string. */ importJobPath(project: string, location: string, keyRing: string, importJob: string): string; /** * Parse the project from ImportJob resource. * * @param {string} importJobName * A fully-qualified path representing ImportJob resource. * @returns {string} A string representing the project. */ matchProjectFromImportJobName(importJobName: string): string | number; /** * Parse the location from ImportJob resource. * * @param {string} importJobName * A fully-qualified path representing ImportJob resource. * @returns {string} A string representing the location. */ matchLocationFromImportJobName(importJobName: string): string | number; /** * Parse the key_ring from ImportJob resource. * * @param {string} importJobName * A fully-qualified path representing ImportJob resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromImportJobName(importJobName: string): string | number; /** * Parse the import_job from ImportJob resource. * * @param {string} importJobName * A fully-qualified path representing ImportJob resource. * @returns {string} A string representing the import_job. */ matchImportJobFromImportJobName(importJobName: string): string | number; /** * Return a fully-qualified keyHandle resource name string. * * @param {string} project * @param {string} location * @param {string} key_handle * @returns {string} Resource name string. */ keyHandlePath(project: string, location: string, keyHandle: string): string; /** * Parse the project from KeyHandle resource. * * @param {string} keyHandleName * A fully-qualified path representing KeyHandle resource. * @returns {string} A string representing the project. */ matchProjectFromKeyHandleName(keyHandleName: string): string | number; /** * Parse the location from KeyHandle resource. * * @param {string} keyHandleName * A fully-qualified path representing KeyHandle resource. * @returns {string} A string representing the location. */ matchLocationFromKeyHandleName(keyHandleName: string): string | number; /** * Parse the key_handle from KeyHandle resource. * * @param {string} keyHandleName * A fully-qualified path representing KeyHandle resource. * @returns {string} A string representing the key_handle. */ matchKeyHandleFromKeyHandleName(keyHandleName: string): string | number; /** * Return a fully-qualified keyRing resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @returns {string} Resource name string. */ keyRingPath(project: string, location: string, keyRing: string): string; /** * Parse the project from KeyRing resource. * * @param {string} keyRingName * A fully-qualified path representing KeyRing resource. * @returns {string} A string representing the project. */ matchProjectFromKeyRingName(keyRingName: string): string | number; /** * Parse the location from KeyRing resource. * * @param {string} keyRingName * A fully-qualified path representing KeyRing resource. * @returns {string} A string representing the location. */ matchLocationFromKeyRingName(keyRingName: string): string | number; /** * Parse the key_ring from KeyRing resource. * * @param {string} keyRingName * A fully-qualified path representing KeyRing resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromKeyRingName(keyRingName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: string): string | number; /** * Return a fully-qualified projectAutokeyConfig resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectAutokeyConfigPath(project: string): string; /** * Parse the project from ProjectAutokeyConfig resource. * * @param {string} projectAutokeyConfigName * A fully-qualified path representing project_autokeyConfig resource. * @returns {string} A string representing the project. */ matchProjectFromProjectAutokeyConfigName(projectAutokeyConfigName: string): string | number; /** * Return a fully-qualified publicKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @param {string} crypto_key_version * @returns {string} Resource name string. */ publicKeyPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string; /** * Parse the project from PublicKey resource. * * @param {string} publicKeyName * A fully-qualified path representing PublicKey resource. * @returns {string} A string representing the project. */ matchProjectFromPublicKeyName(publicKeyName: string): string | number; /** * Parse the location from PublicKey resource. * * @param {string} publicKeyName * A fully-qualified path representing PublicKey resource. * @returns {string} A string representing the location. */ matchLocationFromPublicKeyName(publicKeyName: string): string | number; /** * Parse the key_ring from PublicKey resource. * * @param {string} publicKeyName * A fully-qualified path representing PublicKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromPublicKeyName(publicKeyName: string): string | number; /** * Parse the crypto_key from PublicKey resource. * * @param {string} publicKeyName * A fully-qualified path representing PublicKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromPublicKeyName(publicKeyName: string): string | number; /** * Parse the crypto_key_version from PublicKey resource. * * @param {string} publicKeyName * A fully-qualified path representing PublicKey resource. * @returns {string} A string representing the crypto_key_version. */ matchCryptoKeyVersionFromPublicKeyName(publicKeyName: string): string | number; /** * Return a fully-qualified retiredResource resource name string. * * @param {string} project * @param {string} location * @param {string} retired_resource * @returns {string} Resource name string. */ retiredResourcePath(project: string, location: string, retiredResource: string): string; /** * Parse the project from RetiredResource resource. * * @param {string} retiredResourceName * A fully-qualified path representing RetiredResource resource. * @returns {string} A string representing the project. */ matchProjectFromRetiredResourceName(retiredResourceName: string): string | number; /** * Parse the location from RetiredResource resource. * * @param {string} retiredResourceName * A fully-qualified path representing RetiredResource resource. * @returns {string} A string representing the location. */ matchLocationFromRetiredResourceName(retiredResourceName: string): string | number; /** * Parse the retired_resource from RetiredResource resource. * * @param {string} retiredResourceName * A fully-qualified path representing RetiredResource resource. * @returns {string} A string representing the retired_resource. */ matchRetiredResourceFromRetiredResourceName(retiredResourceName: string): string | number; /** * Return a fully-qualified singleTenantHsmInstance resource name string. * * @param {string} project * @param {string} location * @param {string} single_tenant_hsm_instance * @returns {string} Resource name string. */ singleTenantHsmInstancePath(project: string, location: string, singleTenantHsmInstance: string): string; /** * Parse the project from SingleTenantHsmInstance resource. * * @param {string} singleTenantHsmInstanceName * A fully-qualified path representing SingleTenantHsmInstance resource. * @returns {string} A string representing the project. */ matchProjectFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number; /** * Parse the location from SingleTenantHsmInstance resource. * * @param {string} singleTenantHsmInstanceName * A fully-qualified path representing SingleTenantHsmInstance resource. * @returns {string} A string representing the location. */ matchLocationFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number; /** * Parse the single_tenant_hsm_instance from SingleTenantHsmInstance resource. * * @param {string} singleTenantHsmInstanceName * A fully-qualified path representing SingleTenantHsmInstance resource. * @returns {string} A string representing the single_tenant_hsm_instance. */ matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceName(singleTenantHsmInstanceName: string): string | number; /** * Return a fully-qualified singleTenantHsmInstanceProposal resource name string. * * @param {string} project * @param {string} location * @param {string} single_tenant_hsm_instance * @param {string} proposal * @returns {string} Resource name string. */ singleTenantHsmInstanceProposalPath(project: string, location: string, singleTenantHsmInstance: string, proposal: string): string; /** * Parse the project from SingleTenantHsmInstanceProposal resource. * * @param {string} singleTenantHsmInstanceProposalName * A fully-qualified path representing SingleTenantHsmInstanceProposal resource. * @returns {string} A string representing the project. */ matchProjectFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number; /** * Parse the location from SingleTenantHsmInstanceProposal resource. * * @param {string} singleTenantHsmInstanceProposalName * A fully-qualified path representing SingleTenantHsmInstanceProposal resource. * @returns {string} A string representing the location. */ matchLocationFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number; /** * Parse the single_tenant_hsm_instance from SingleTenantHsmInstanceProposal resource. * * @param {string} singleTenantHsmInstanceProposalName * A fully-qualified path representing SingleTenantHsmInstanceProposal resource. * @returns {string} A string representing the single_tenant_hsm_instance. */ matchSingleTenantHsmInstanceFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number; /** * Parse the proposal from SingleTenantHsmInstanceProposal resource. * * @param {string} singleTenantHsmInstanceProposalName * A fully-qualified path representing SingleTenantHsmInstanceProposal resource. * @returns {string} A string representing the proposal. */ matchProposalFromSingleTenantHsmInstanceProposalName(singleTenantHsmInstanceProposalName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }