import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Manages TPU nodes and other resources * * TPU API v2alpha1 * @class * @memberof v2alpha1 */ export declare class TpuClient { 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; }; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; tpuStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of TpuClient. * * @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 TpuClient({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; /** * Gets the details of a node. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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.tpu.v2alpha1.Node|Node}. * 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/v2alpha1/tpu.get_node.js * region_tag:tpu_v2alpha1_generated_Tpu_GetNode_async */ getNode(request?: protos.google.cloud.tpu.v2alpha1.IGetNodeRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IGetNodeRequest | undefined, {} | undefined ]>; getNode(request: protos.google.cloud.tpu.v2alpha1.IGetNodeRequest, options: CallOptions, callback: Callback): void; getNode(request: protos.google.cloud.tpu.v2alpha1.IGetNodeRequest, callback: Callback): void; /** * Gets details of a queued resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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.tpu.v2alpha1.QueuedResource|QueuedResource}. * 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/v2alpha1/tpu.get_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_GetQueuedResource_async */ getQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest | undefined, {} | undefined ]>; getQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest, options: CallOptions, callback: Callback): void; getQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest, callback: Callback): void; /** * Generates the Cloud TPU service identity for the project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @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.tpu.v2alpha1.GenerateServiceIdentityResponse|GenerateServiceIdentityResponse}. * 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/v2alpha1/tpu.generate_service_identity.js * region_tag:tpu_v2alpha1_generated_Tpu_GenerateServiceIdentity_async */ generateServiceIdentity(request?: protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityResponse, protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest | undefined, {} | undefined ]>; generateServiceIdentity(request: protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest, options: CallOptions, callback: Callback): void; generateServiceIdentity(request: protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest, callback: Callback): void; /** * Gets AcceleratorType. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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.tpu.v2alpha1.AcceleratorType|AcceleratorType}. * 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/v2alpha1/tpu.get_accelerator_type.js * region_tag:tpu_v2alpha1_generated_Tpu_GetAcceleratorType_async */ getAcceleratorType(request?: protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IAcceleratorType, protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest | undefined, {} | undefined ]>; getAcceleratorType(request: protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest, options: CallOptions, callback: Callback): void; getAcceleratorType(request: protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest, callback: Callback): void; /** * Gets a runtime version. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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.tpu.v2alpha1.RuntimeVersion|RuntimeVersion}. * 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/v2alpha1/tpu.get_runtime_version.js * region_tag:tpu_v2alpha1_generated_Tpu_GetRuntimeVersion_async */ getRuntimeVersion(request?: protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IRuntimeVersion, protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest | undefined, {} | undefined ]>; getRuntimeVersion(request: protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest, options: CallOptions, callback: Callback): void; getRuntimeVersion(request: protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest, callback: Callback): void; /** * Retrieves the guest attributes for the node. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @param {string} request.queryPath * The guest attributes path to be queried. * @param {string[]} request.workerIds * The 0-based worker ID. If it is empty, all workers' GuestAttributes will be * returned. * @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.tpu.v2alpha1.GetGuestAttributesResponse|GetGuestAttributesResponse}. * 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/v2alpha1/tpu.get_guest_attributes.js * region_tag:tpu_v2alpha1_generated_Tpu_GetGuestAttributes_async */ getGuestAttributes(request?: protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesResponse, protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest | undefined, {} | undefined ]>; getGuestAttributes(request: protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest, options: CallOptions, callback: Callback): void; getGuestAttributes(request: protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest, callback: Callback): void; /** * Creates a node. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {string} request.nodeId * The unqualified resource name. * @param {google.cloud.tpu.v2alpha1.Node} request.node * Required. The node. * @param {string} request.requestId * Idempotent request UUID. * @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/v2alpha1/tpu.create_node.js * region_tag:tpu_v2alpha1_generated_Tpu_CreateNode_async */ createNode(request?: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createNode(request: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createNode(request: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createNode()`. * @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/v2alpha1/tpu.create_node.js * region_tag:tpu_v2alpha1_generated_Tpu_CreateNode_async */ checkCreateNodeProgress(name: string): Promise>; /** * Deletes a node. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @param {string} request.requestId * Idempotent request UUID. * @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/v2alpha1/tpu.delete_node.js * region_tag:tpu_v2alpha1_generated_Tpu_DeleteNode_async */ deleteNode(request?: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteNode(request: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteNode(request: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteNode()`. * @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/v2alpha1/tpu.delete_node.js * region_tag:tpu_v2alpha1_generated_Tpu_DeleteNode_async */ checkDeleteNodeProgress(name: string): Promise>; /** * Stops a node. This operation is only available with single TPU nodes. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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/v2alpha1/tpu.stop_node.js * region_tag:tpu_v2alpha1_generated_Tpu_StopNode_async */ stopNode(request?: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; stopNode(request: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; stopNode(request: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `stopNode()`. * @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/v2alpha1/tpu.stop_node.js * region_tag:tpu_v2alpha1_generated_Tpu_StopNode_async */ checkStopNodeProgress(name: string): Promise>; /** * Starts a node. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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/v2alpha1/tpu.start_node.js * region_tag:tpu_v2alpha1_generated_Tpu_StartNode_async */ startNode(request?: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; startNode(request: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; startNode(request: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `startNode()`. * @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/v2alpha1/tpu.start_node.js * region_tag:tpu_v2alpha1_generated_Tpu_StartNode_async */ checkStartNodeProgress(name: string): Promise>; /** * Updates the configurations of a node. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} request.updateMask * Required. Mask of fields from {@link protos.Tpu.Node|Node} to update. * Supported fields: [description, tags, labels, metadata, * network_config.enable_external_ips]. * @param {google.cloud.tpu.v2alpha1.Node} request.node * Required. The node. Only fields specified in update_mask are updated. * @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/v2alpha1/tpu.update_node.js * region_tag:tpu_v2alpha1_generated_Tpu_UpdateNode_async */ updateNode(request?: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateNode(request: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateNode(request: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateNode()`. * @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/v2alpha1/tpu.update_node.js * region_tag:tpu_v2alpha1_generated_Tpu_UpdateNode_async */ checkUpdateNodeProgress(name: string): Promise>; /** * Perform manual maintenance on a node. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @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/v2alpha1/tpu.perform_maintenance.js * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenance_async */ performMaintenance(request?: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; performMaintenance(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; performMaintenance(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `performMaintenance()`. * @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/v2alpha1/tpu.perform_maintenance.js * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenance_async */ checkPerformMaintenanceProgress(name: string): Promise>; /** * Creates a QueuedResource TPU instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {string} request.queuedResourceId * The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` * regex format. * @param {google.cloud.tpu.v2alpha1.QueuedResource} request.queuedResource * Required. The queued resource. * @param {string} request.requestId * Idempotent request UUID. * @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/v2alpha1/tpu.create_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async */ createQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createQueuedResource(request: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createQueuedResource(request: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createQueuedResource()`. * @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/v2alpha1/tpu.create_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async */ checkCreateQueuedResourceProgress(name: string): Promise>; /** * Deletes a QueuedResource TPU instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @param {string} request.requestId * Idempotent request UUID. * @param {boolean} request.force * If set to true, all running nodes belonging to this queued resource will * be deleted first and then the queued resource will be deleted. * Otherwise (i.e. force=false), the queued resource will only be deleted if * its nodes have already been deleted or the queued resource is in the * ACCEPTED, FAILED, or SUSPENDED 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 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/v2alpha1/tpu.delete_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async */ deleteQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteQueuedResource()`. * @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/v2alpha1/tpu.delete_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async */ checkDeleteQueuedResourceProgress(name: string): Promise>; /** * Resets a QueuedResource TPU instance * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the queued resource. * @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/v2alpha1/tpu.reset_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_ResetQueuedResource_async */ resetQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; resetQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; resetQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `resetQueuedResource()`. * @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/v2alpha1/tpu.reset_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_ResetQueuedResource_async */ checkResetQueuedResourceProgress(name: string): Promise>; /** * Perform manual maintenance on specific nodes of a QueuedResource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the QueuedResource which holds the nodes to perform * maintenance on. * @param {string[]} request.nodeNames * The names of the nodes to perform maintenance on. * @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/v2alpha1/tpu.perform_maintenance_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenanceQueuedResource_async */ performMaintenanceQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; performMaintenanceQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; performMaintenanceQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `performMaintenanceQueuedResource()`. * @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/v2alpha1/tpu.perform_maintenance_queued_resource.js * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenanceQueuedResource_async */ checkPerformMaintenanceQueuedResourceProgress(name: string): Promise>; /** * Simulates a maintenance event. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name. * @param {string[]} request.workerIds * The 0-based worker ID. If it is empty, worker ID 0 will be selected for * maintenance event simulation. A maintenance event will only be fired on the * first specified worker ID. Future implementations may support firing on * multiple workers. * @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/v2alpha1/tpu.simulate_maintenance_event.js * region_tag:tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async */ simulateMaintenanceEvent(request?: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; simulateMaintenanceEvent(request: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; simulateMaintenanceEvent(request: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `simulateMaintenanceEvent()`. * @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/v2alpha1/tpu.simulate_maintenance_event.js * region_tag:tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async */ checkSimulateMaintenanceEventProgress(name: string): Promise>; /** * Lists nodes. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Node|Node}. * 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 `listNodesAsync()` * 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. */ listNodes(request?: protos.google.cloud.tpu.v2alpha1.IListNodesRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.INode[], protos.google.cloud.tpu.v2alpha1.IListNodesRequest | null, protos.google.cloud.tpu.v2alpha1.IListNodesResponse ]>; listNodes(request: protos.google.cloud.tpu.v2alpha1.IListNodesRequest, options: CallOptions, callback: PaginationCallback): void; listNodes(request: protos.google.cloud.tpu.v2alpha1.IListNodesRequest, callback: PaginationCallback): void; /** * Equivalent to `listNodes`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Node|Node} 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 `listNodesAsync()` * 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. */ listNodesStream(request?: protos.google.cloud.tpu.v2alpha1.IListNodesRequest, options?: CallOptions): Transform; /** * Equivalent to `listNodes`, 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 parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Node|Node}. 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/v2alpha1/tpu.list_nodes.js * region_tag:tpu_v2alpha1_generated_Tpu_ListNodes_async */ listNodesAsync(request?: protos.google.cloud.tpu.v2alpha1.IListNodesRequest, options?: CallOptions): AsyncIterable; /** * Lists queued resources. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.QueuedResource|QueuedResource}. * 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 `listQueuedResourcesAsync()` * 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. */ listQueuedResources(request?: protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IQueuedResource[], protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest | null, protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesResponse ]>; listQueuedResources(request: protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, options: CallOptions, callback: PaginationCallback): void; listQueuedResources(request: protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, callback: PaginationCallback): void; /** * Equivalent to `listQueuedResources`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.QueuedResource|QueuedResource} 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 `listQueuedResourcesAsync()` * 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. */ listQueuedResourcesStream(request?: protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, options?: CallOptions): Transform; /** * Equivalent to `listQueuedResources`, 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 parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.QueuedResource|QueuedResource}. 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/v2alpha1/tpu.list_queued_resources.js * region_tag:tpu_v2alpha1_generated_Tpu_ListQueuedResources_async */ listQueuedResourcesAsync(request?: protos.google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, options?: CallOptions): AsyncIterable; /** * Lists accelerator types supported by this API. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.AcceleratorType|AcceleratorType}. * 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 `listAcceleratorTypesAsync()` * 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. */ listAcceleratorTypes(request?: protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IAcceleratorType[], protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest | null, protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesResponse ]>; listAcceleratorTypes(request: protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, options: CallOptions, callback: PaginationCallback): void; listAcceleratorTypes(request: protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, callback: PaginationCallback): void; /** * Equivalent to `listAcceleratorTypes`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.AcceleratorType|AcceleratorType} 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 `listAcceleratorTypesAsync()` * 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. */ listAcceleratorTypesStream(request?: protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, options?: CallOptions): Transform; /** * Equivalent to `listAcceleratorTypes`, 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 parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.AcceleratorType|AcceleratorType}. 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/v2alpha1/tpu.list_accelerator_types.js * region_tag:tpu_v2alpha1_generated_Tpu_ListAcceleratorTypes_async */ listAcceleratorTypesAsync(request?: protos.google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, options?: CallOptions): AsyncIterable; /** * Lists runtime versions supported by this API. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.RuntimeVersion|RuntimeVersion}. * 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 `listRuntimeVersionsAsync()` * 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. */ listRuntimeVersions(request?: protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IRuntimeVersion[], protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest | null, protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsResponse ]>; listRuntimeVersions(request: protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, options: CallOptions, callback: PaginationCallback): void; listRuntimeVersions(request: protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, callback: PaginationCallback): void; /** * Equivalent to `listRuntimeVersions`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.RuntimeVersion|RuntimeVersion} 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 `listRuntimeVersionsAsync()` * 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. */ listRuntimeVersionsStream(request?: protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, options?: CallOptions): Transform; /** * Equivalent to `listRuntimeVersions`, 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 parent resource name. * @param {number} request.pageSize * The maximum number of items to return. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @param {string} request.filter * List filter. * @param {string} request.orderBy * Sort results. * @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.tpu.v2alpha1.RuntimeVersion|RuntimeVersion}. 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/v2alpha1/tpu.list_runtime_versions.js * region_tag:tpu_v2alpha1_generated_Tpu_ListRuntimeVersions_async */ listRuntimeVersionsAsync(request?: protos.google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, options?: CallOptions): AsyncIterable; /** * Retrieves the reservations for the given project in the given location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent for reservations. * @param {number} request.pageSize * The maximum number of items to return. Defaults to 0 if not specified, * which means no limit. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Reservation|Reservation}. * 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 `listReservationsAsync()` * 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. */ listReservations(request?: protos.google.cloud.tpu.v2alpha1.IListReservationsRequest, options?: CallOptions): Promise<[ protos.google.cloud.tpu.v2alpha1.IReservation[], protos.google.cloud.tpu.v2alpha1.IListReservationsRequest | null, protos.google.cloud.tpu.v2alpha1.IListReservationsResponse ]>; listReservations(request: protos.google.cloud.tpu.v2alpha1.IListReservationsRequest, options: CallOptions, callback: PaginationCallback): void; listReservations(request: protos.google.cloud.tpu.v2alpha1.IListReservationsRequest, callback: PaginationCallback): void; /** * Equivalent to `listReservations`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent for reservations. * @param {number} request.pageSize * The maximum number of items to return. Defaults to 0 if not specified, * which means no limit. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Reservation|Reservation} 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 `listReservationsAsync()` * 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. */ listReservationsStream(request?: protos.google.cloud.tpu.v2alpha1.IListReservationsRequest, options?: CallOptions): Transform; /** * Equivalent to `listReservations`, 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 parent for reservations. * @param {number} request.pageSize * The maximum number of items to return. Defaults to 0 if not specified, * which means no limit. * @param {string} request.pageToken * The next_page_token value returned from a previous List request, if any. * @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.tpu.v2alpha1.Reservation|Reservation}. 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/v2alpha1/tpu.list_reservations.js * region_tag:tpu_v2alpha1_generated_Tpu_ListReservations_async */ listReservationsAsync(request?: protos.google.cloud.tpu.v2alpha1.IListReservationsRequest, options?: CallOptions): AsyncIterable; /** * 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 acceleratorType resource name string. * * @param {string} project * @param {string} location * @param {string} accelerator_type * @returns {string} Resource name string. */ acceleratorTypePath(project: string, location: string, acceleratorType: string): string; /** * Parse the project from AcceleratorType resource. * * @param {string} acceleratorTypeName * A fully-qualified path representing AcceleratorType resource. * @returns {string} A string representing the project. */ matchProjectFromAcceleratorTypeName(acceleratorTypeName: string): string | number; /** * Parse the location from AcceleratorType resource. * * @param {string} acceleratorTypeName * A fully-qualified path representing AcceleratorType resource. * @returns {string} A string representing the location. */ matchLocationFromAcceleratorTypeName(acceleratorTypeName: string): string | number; /** * Parse the accelerator_type from AcceleratorType resource. * * @param {string} acceleratorTypeName * A fully-qualified path representing AcceleratorType resource. * @returns {string} A string representing the accelerator_type. */ matchAcceleratorTypeFromAcceleratorTypeName(acceleratorTypeName: 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 node resource name string. * * @param {string} project * @param {string} location * @param {string} node * @returns {string} Resource name string. */ nodePath(project: string, location: string, node: string): string; /** * Parse the project from Node resource. * * @param {string} nodeName * A fully-qualified path representing Node resource. * @returns {string} A string representing the project. */ matchProjectFromNodeName(nodeName: string): string | number; /** * Parse the location from Node resource. * * @param {string} nodeName * A fully-qualified path representing Node resource. * @returns {string} A string representing the location. */ matchLocationFromNodeName(nodeName: string): string | number; /** * Parse the node from Node resource. * * @param {string} nodeName * A fully-qualified path representing Node resource. * @returns {string} A string representing the node. */ matchNodeFromNodeName(nodeName: string): string | number; /** * Return a fully-qualified project resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectPath(project: string): string; /** * Parse the project from Project resource. * * @param {string} projectName * A fully-qualified path representing Project resource. * @returns {string} A string representing the project. */ matchProjectFromProjectName(projectName: string): string | number; /** * Return a fully-qualified queuedResource resource name string. * * @param {string} project * @param {string} location * @param {string} queued_resource * @returns {string} Resource name string. */ queuedResourcePath(project: string, location: string, queuedResource: string): string; /** * Parse the project from QueuedResource resource. * * @param {string} queuedResourceName * A fully-qualified path representing QueuedResource resource. * @returns {string} A string representing the project. */ matchProjectFromQueuedResourceName(queuedResourceName: string): string | number; /** * Parse the location from QueuedResource resource. * * @param {string} queuedResourceName * A fully-qualified path representing QueuedResource resource. * @returns {string} A string representing the location. */ matchLocationFromQueuedResourceName(queuedResourceName: string): string | number; /** * Parse the queued_resource from QueuedResource resource. * * @param {string} queuedResourceName * A fully-qualified path representing QueuedResource resource. * @returns {string} A string representing the queued_resource. */ matchQueuedResourceFromQueuedResourceName(queuedResourceName: string): string | number; /** * Return a fully-qualified reservation resource name string. * * @param {string} project * @param {string} location * @param {string} reservation * @returns {string} Resource name string. */ reservationPath(project: string, location: string, reservation: string): string; /** * Parse the project from Reservation resource. * * @param {string} reservationName * A fully-qualified path representing Reservation resource. * @returns {string} A string representing the project. */ matchProjectFromReservationName(reservationName: string): string | number; /** * Parse the location from Reservation resource. * * @param {string} reservationName * A fully-qualified path representing Reservation resource. * @returns {string} A string representing the location. */ matchLocationFromReservationName(reservationName: string): string | number; /** * Parse the reservation from Reservation resource. * * @param {string} reservationName * A fully-qualified path representing Reservation resource. * @returns {string} A string representing the reservation. */ matchReservationFromReservationName(reservationName: string): string | number; /** * Return a fully-qualified runtimeVersion resource name string. * * @param {string} project * @param {string} location * @param {string} runtime_version * @returns {string} Resource name string. */ runtimeVersionPath(project: string, location: string, runtimeVersion: string): string; /** * Parse the project from RuntimeVersion resource. * * @param {string} runtimeVersionName * A fully-qualified path representing RuntimeVersion resource. * @returns {string} A string representing the project. */ matchProjectFromRuntimeVersionName(runtimeVersionName: string): string | number; /** * Parse the location from RuntimeVersion resource. * * @param {string} runtimeVersionName * A fully-qualified path representing RuntimeVersion resource. * @returns {string} A string representing the location. */ matchLocationFromRuntimeVersionName(runtimeVersionName: string): string | number; /** * Parse the runtime_version from RuntimeVersion resource. * * @param {string} runtimeVersionName * A fully-qualified path representing RuntimeVersion resource. * @returns {string} A string representing the runtime_version. */ matchRuntimeVersionFromRuntimeVersionName(runtimeVersionName: 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; }