UNPKG

@google-cloud/tpu

Version:
721 lines 96.3 kB
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<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.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 <caption>include:samples/generated/v2alpha1/tpu.get_node.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IGetNodeRequest | null | undefined, {} | null | undefined>): void; getNode(request: protos.google.cloud.tpu.v2alpha1.IGetNodeRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.get_queued_resource.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest | null | undefined, {} | null | undefined>): void; getQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.generate_service_identity.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityResponse, protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest | null | undefined, {} | null | undefined>): void; generateServiceIdentity(request: protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.IGenerateServiceIdentityResponse, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.get_accelerator_type.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.IAcceleratorType, protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>): void; getAcceleratorType(request: protos.google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.IAcceleratorType, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.get_runtime_version.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.IRuntimeVersion, protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest | null | undefined, {} | null | undefined>): void; getRuntimeVersion(request: protos.google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.IRuntimeVersion, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.get_guest_attributes.js</caption> * 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<protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesResponse, protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest | null | undefined, {} | null | undefined>): void; getGuestAttributes(request: protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest, callback: Callback<protos.google.cloud.tpu.v2alpha1.IGetGuestAttributesResponse, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.create_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_CreateNode_async */ createNode(request?: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createNode(request: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createNode(request: protos.google.cloud.tpu.v2alpha1.ICreateNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.create_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_CreateNode_async */ checkCreateNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.OperationMetadata>>; /** * 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 <caption>include:samples/generated/v2alpha1/tpu.delete_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_DeleteNode_async */ deleteNode(request?: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteNode(request: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteNode(request: protos.google.cloud.tpu.v2alpha1.IDeleteNodeRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.delete_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_DeleteNode_async */ checkDeleteNodeProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.stop_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_StopNode_async */ stopNode(request?: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; stopNode(request: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; stopNode(request: protos.google.cloud.tpu.v2alpha1.IStopNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.stop_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_StopNode_async */ checkStopNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.start_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_StartNode_async */ startNode(request?: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; startNode(request: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; startNode(request: protos.google.cloud.tpu.v2alpha1.IStartNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.start_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_StartNode_async */ checkStartNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.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.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 <caption>include:samples/generated/v2alpha1/tpu.update_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_UpdateNode_async */ updateNode(request?: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateNode(request: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateNode(request: protos.google.cloud.tpu.v2alpha1.IUpdateNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.update_node.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_UpdateNode_async */ checkUpdateNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.OperationMetadata>>; /** * 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 <caption>include:samples/generated/v2alpha1/tpu.perform_maintenance.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenance_async */ performMaintenance(request?: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; performMaintenance(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; performMaintenance(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, 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 <caption>include:samples/generated/v2alpha1/tpu.perform_maintenance.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenance_async */ checkPerformMaintenanceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.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 * 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 <caption>include:samples/generated/v2alpha1/tpu.create_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async */ createQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createQueuedResource(request: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createQueuedResource(request: protos.google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.create_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_CreateQueuedResource_async */ checkCreateQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.QueuedResource, protos.google.cloud.tpu.v2alpha1.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 * 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 <caption>include:samples/generated/v2alpha1/tpu.delete_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async */ deleteQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.delete_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_DeleteQueuedResource_async */ checkDeleteQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.QueuedResource, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.reset_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_ResetQueuedResource_async */ resetQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; resetQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; resetQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.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/v2alpha1/tpu.reset_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_ResetQueuedResource_async */ checkResetQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.QueuedResource, protos.google.cloud.tpu.v2alpha1.OperationMetadata>>; /** * 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 <caption>include:samples/generated/v2alpha1/tpu.perform_maintenance_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenanceQueuedResource_async */ performMaintenanceQueuedResource(request?: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; performMaintenanceQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; performMaintenanceQueuedResource(request: protos.google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.IQueuedResource, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, 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 <caption>include:samples/generated/v2alpha1/tpu.perform_maintenance_queued_resource.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_PerformMaintenanceQueuedResource_async */ checkPerformMaintenanceQueuedResourceProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.QueuedResource, protos.google.cloud.tpu.v2alpha1.OperationMetadata>>; /** * 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 <caption>include:samples/generated/v2alpha1/tpu.simulate_maintenance_event.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async */ simulateMaintenanceEvent(request?: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; simulateMaintenanceEvent(request: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; simulateMaintenanceEvent(request: protos.google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v2alpha1.INode, protos.google.cloud.tpu.v2alpha1.IOperationMetadata>, 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 <caption>include:samples/generated/v2alpha1/tpu.simulate_maintenance_event.js</caption> * region_tag:tpu_v2alpha1_generated_Tpu_SimulateMaintenanceEvent_async */ checkSimulateMaintenanceEventProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v2alpha1.Node, protos.google.cloud.tpu.v2alpha1.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 el