@google-cloud/tpu/build/src/v2/tpu_client.d.ts

tpu client for Node.js

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 v2
 * @class
 * @memberof v2
 */
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<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.get_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GetNode_async
     */
    getNode(request?: protos.google.cloud.tpu.v2.IGetNodeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.INode,
        protos.google.cloud.tpu.v2.IGetNodeRequest | undefined,
        {} | undefined
    ]>;
    getNode(request: protos.google.cloud.tpu.v2.IGetNodeRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IGetNodeRequest | null | undefined, {} | null | undefined>): void;
    getNode(request: protos.google.cloud.tpu.v2.IGetNodeRequest, callback: Callback<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IGetNodeRequest | null | undefined, {} | null | undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.get_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GetQueuedResource_async
     */
    getQueuedResource(request?: protos.google.cloud.tpu.v2.IGetQueuedResourceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IQueuedResource,
        protos.google.cloud.tpu.v2.IGetQueuedResourceRequest | undefined,
        {} | undefined
    ]>;
    getQueuedResource(request: protos.google.cloud.tpu.v2.IGetQueuedResourceRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IGetQueuedResourceRequest | null | undefined, {} | null | undefined>): void;
    getQueuedResource(request: protos.google.cloud.tpu.v2.IGetQueuedResourceRequest, callback: Callback<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IGetQueuedResourceRequest | null | undefined, {} | null | undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.generate_service_identity.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GenerateServiceIdentity_async
     */
    generateServiceIdentity(request?: protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IGenerateServiceIdentityResponse,
        protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest | undefined,
        {} | undefined
    ]>;
    generateServiceIdentity(request: protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.IGenerateServiceIdentityResponse, protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest | null | undefined, {} | null | undefined>): void;
    generateServiceIdentity(request: protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest, callback: Callback<protos.google.cloud.tpu.v2.IGenerateServiceIdentityResponse, protos.google.cloud.tpu.v2.IGenerateServiceIdentityRequest | null | undefined, {} | null | undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.get_accelerator_type.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GetAcceleratorType_async
     */
    getAcceleratorType(request?: protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IAcceleratorType,
        protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest | undefined,
        {} | undefined
    ]>;
    getAcceleratorType(request: protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.IAcceleratorType, protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>): void;
    getAcceleratorType(request: protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest, callback: Callback<protos.google.cloud.tpu.v2.IAcceleratorType, protos.google.cloud.tpu.v2.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.get_runtime_version.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GetRuntimeVersion_async
     */
    getRuntimeVersion(request?: protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IRuntimeVersion,
        protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest | undefined,
        {} | undefined
    ]>;
    getRuntimeVersion(request: protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.IRuntimeVersion, protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest | null | undefined, {} | null | undefined>): void;
    getRuntimeVersion(request: protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest, callback: Callback<protos.google.cloud.tpu.v2.IRuntimeVersion, protos.google.cloud.tpu.v2.IGetRuntimeVersionRequest | null | undefined, {} | null | undefined>): 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.v2.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 <caption>include:samples/generated/v2/tpu.get_guest_attributes.js</caption>
     * region_tag:tpu_v2_generated_Tpu_GetGuestAttributes_async
     */
    getGuestAttributes(request?: protos.google.cloud.tpu.v2.IGetGuestAttributesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IGetGuestAttributesResponse,
        protos.google.cloud.tpu.v2.IGetGuestAttributesRequest | undefined,
        {} | undefined
    ]>;
    getGuestAttributes(request: protos.google.cloud.tpu.v2.IGetGuestAttributesRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v2.IGetGuestAttributesResponse, protos.google.cloud.tpu.v2.IGetGuestAttributesRequest | null | undefined, {} | null | undefined>): void;
    getGuestAttributes(request: protos.google.cloud.tpu.v2.IGetGuestAttributesRequest, callback: Callback<protos.google.cloud.tpu.v2.IGetGuestAttributesResponse, protos.google.cloud.tpu.v2.IGetGuestAttributesRequest | null | undefined, {} | null | undefined>): 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.v2.Node} request.node
     *   Required. The node.
     * @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 <caption>include:samples/generated/v2/tpu.create_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_CreateNode_async
     */
    createNode(request?: protos.google.cloud.tpu.v2.ICreateNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createNode(request: protos.google.cloud.tpu.v2.ICreateNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createNode(request: protos.google.cloud.tpu.v2.ICreateNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.create_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_CreateNode_async
     */
    checkCreateNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.Node, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * Deletes 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 <caption>include:samples/generated/v2/tpu.delete_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_DeleteNode_async
     */
    deleteNode(request?: protos.google.cloud.tpu.v2.IDeleteNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteNode(request: protos.google.cloud.tpu.v2.IDeleteNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteNode(request: protos.google.cloud.tpu.v2.IDeleteNodeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.delete_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_DeleteNode_async
     */
    checkDeleteNodeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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 <caption>include:samples/generated/v2/tpu.stop_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_StopNode_async
     */
    stopNode(request?: protos.google.cloud.tpu.v2.IStopNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    stopNode(request: protos.google.cloud.tpu.v2.IStopNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    stopNode(request: protos.google.cloud.tpu.v2.IStopNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.stop_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_StopNode_async
     */
    checkStopNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.Node, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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 <caption>include:samples/generated/v2/tpu.start_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_StartNode_async
     */
    startNode(request?: protos.google.cloud.tpu.v2.IStartNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    startNode(request: protos.google.cloud.tpu.v2.IStartNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    startNode(request: protos.google.cloud.tpu.v2.IStartNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.start_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_StartNode_async
     */
    checkStartNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.Node, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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.v2.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 <caption>include:samples/generated/v2/tpu.update_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_UpdateNode_async
     */
    updateNode(request?: protos.google.cloud.tpu.v2.IUpdateNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateNode(request: protos.google.cloud.tpu.v2.IUpdateNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateNode(request: protos.google.cloud.tpu.v2.IUpdateNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.INode, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.update_node.js</caption>
     * region_tag:tpu_v2_generated_Tpu_UpdateNode_async
     */
    checkUpdateNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.Node, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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]
     *   Optional. The unqualified resource name. Should follow the
     *   `^[A-Za-z0-9_.~+%-]+$` regex format.
     * @param {google.cloud.tpu.v2.QueuedResource} request.queuedResource
     *   Required. The queued resource.
     * @param {string} [request.requestId]
     *   Optional. 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 <caption>include:samples/generated/v2/tpu.create_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_CreateQueuedResource_async
     */
    createQueuedResource(request?: protos.google.cloud.tpu.v2.ICreateQueuedResourceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createQueuedResource(request: protos.google.cloud.tpu.v2.ICreateQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createQueuedResource(request: protos.google.cloud.tpu.v2.ICreateQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.create_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_CreateQueuedResource_async
     */
    checkCreateQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.QueuedResource, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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]
     *   Optional. Idempotent request UUID.
     * @param {boolean} [request.force]
     *   Optional. 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 <caption>include:samples/generated/v2/tpu.delete_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_DeleteQueuedResource_async
     */
    deleteQueuedResource(request?: protos.google.cloud.tpu.v2.IDeleteQueuedResourceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteQueuedResource(request: protos.google.cloud.tpu.v2.IDeleteQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteQueuedResource(request: protos.google.cloud.tpu.v2.IDeleteQueuedResourceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.delete_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_DeleteQueuedResource_async
     */
    checkDeleteQueuedResourceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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 <caption>include:samples/generated/v2/tpu.reset_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_ResetQueuedResource_async
     */
    resetQueuedResource(request?: protos.google.cloud.tpu.v2.IResetQueuedResourceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    resetQueuedResource(request: protos.google.cloud.tpu.v2.IResetQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    resetQueuedResource(request: protos.google.cloud.tpu.v2.IResetQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2.IQueuedResource, protos.google.cloud.tpu.v2.IOperationMetadata>, 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 <caption>include:samples/generated/v2/tpu.reset_queued_resource.js</caption>
     * region_tag:tpu_v2_generated_Tpu_ResetQueuedResource_async
     */
    checkResetQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2.QueuedResource, protos.google.cloud.tpu.v2.OperationMetadata>>;
    /**
     * 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.v2.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.v2.IListNodesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.INode[],
        protos.google.cloud.tpu.v2.IListNodesRequest | null,
        protos.google.cloud.tpu.v2.IListNodesResponse
    ]>;
    listNodes(request: protos.google.cloud.tpu.v2.IListNodesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tpu.v2.IListNodesRequest, protos.google.cloud.tpu.v2.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v2.INode>): void;
    listNodes(request: protos.google.cloud.tpu.v2.IListNodesRequest, callback: PaginationCallback<protos.google.cloud.tpu.v2.IListNodesRequest, protos.google.cloud.tpu.v2.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v2.INode>): 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.v2.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.v2.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.v2.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 <caption>include:samples/generated/v2/tpu.list_nodes.js</caption>
     * region_tag:tpu_v2_generated_Tpu_ListNodes_async
     */
    listNodesAsync(request?: protos.google.cloud.tpu.v2.IListNodesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tpu.v2.INode>;
    /**
     * 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]
     *   Optional. The maximum number of items to return.
     * @param {string} [request.pageToken]
     *   Optional. 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.v2.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.v2.IListQueuedResourcesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v2.IQueuedResource[],
        protos.google.cloud.tpu.v2.IListQueuedResourcesRequest | null,
        protos.google.cloud.tpu.v2.IListQueuedResourcesResponse
    ]>;
    listQueuedResources(request: protos.google.cloud.tpu.v2.IListQueuedResourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tpu.v2.IListQueuedResourcesRequest, protos.google.cloud.tpu.v2.IListQueuedResourcesResponse | null | undefined, protos.google.cloud.tpu.v2.IQueuedResource>): void;
    listQueuedResources(request: protos.google.cloud.tpu.v2.IListQueuedResourcesRequest, callback: PaginationCallback<protos.google.cloud.tpu.v2.IListQueuedResourcesRequest, protos.google.cloud.tpu.v2.IListQueuedResourcesResponse | null | undefined, protos.google.cloud.tpu.v2.IQueuedResource>): 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]
     *   Optional. The maximum number of items to return.
     * @param {string} [request.pageToken]
     *   Optional. 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.v2.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.v2.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]
     *   Optional. The maximum number of items to return.
     * @param {string} [request.pageToken]
     *   Optional. 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.v2.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 <caption>include:samples/generated/v2/tpu.list_queued_resources.js</caption>
     * region_tag:tpu_v2_generated_Tpu_ListQueuedResources_async
     */
    listQueuedResourcesAsync(request?: protos.google.cloud.tpu.v2.IListQueuedResourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tpu.v2.IQueuedResource>;
    /**
     * 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.