Class v1.TpuClient (1.0.5)

Manages TPU nodes and other resources

TPU API v1 v1

Package

@google-cloud/tpu!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of TpuClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

tpuStub

tpuStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

acceleratorTypePath(project, location, acceleratorType)

acceleratorTypePath(project: string, location: string, acceleratorType: string): string;

Return a fully-qualified acceleratorType resource name string.

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

{string} Resource name string.

checkCreateNodeProgress(name)

checkCreateNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteNodeProgress(name)

checkDeleteNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkReimageNodeProgress(name)

checkReimageNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkStartNodeProgress(name)

checkStartNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkStopNodeProgress(name)

checkStopNodeProgress(name: string): Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.tpu.v1.Node, protos.google.cloud.tpu.v1.OperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
Type Description
Promise<void>

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

createNode(request, options)

createNode(request?: protos.google.cloud.tpu.v1.ICreateNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.ICreateNodeRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createNode(request, options, callback)

createNode(request: protos.google.cloud.tpu.v1.ICreateNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.ICreateNodeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createNode(request, callback)

createNode(request: protos.google.cloud.tpu.v1.ICreateNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.ICreateNodeRequest
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteNode(request, options)

deleteNode(request?: protos.google.cloud.tpu.v1.IDeleteNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IDeleteNodeRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteNode(request, options, callback)

deleteNode(request: protos.google.cloud.tpu.v1.IDeleteNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IDeleteNodeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteNode(request, callback)

deleteNode(request: protos.google.cloud.tpu.v1.IDeleteNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IDeleteNodeRequest
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAcceleratorType(request, options)

getAcceleratorType(request?: protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.IAcceleratorType,
        protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.IAcceleratorType, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | undefined, {} | undefined ]>

getAcceleratorType(request, options, callback)

getAcceleratorType(request: protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v1.IAcceleratorType, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
options CallOptions
callback Callback<protos.google.cloud.tpu.v1.IAcceleratorType, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAcceleratorType(request, callback)

getAcceleratorType(request: protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest, callback: Callback<protos.google.cloud.tpu.v1.IAcceleratorType, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest
callback Callback<protos.google.cloud.tpu.v1.IAcceleratorType, protos.google.cloud.tpu.v1.IGetAcceleratorTypeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getNode(request, options)

getNode(request?: protos.google.cloud.tpu.v1.IGetNodeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.INode,
        protos.google.cloud.tpu.v1.IGetNodeRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetNodeRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IGetNodeRequest | undefined, {} | undefined ]>

getNode(request, options, callback)

getNode(request: protos.google.cloud.tpu.v1.IGetNodeRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IGetNodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetNodeRequest
options CallOptions
callback Callback<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IGetNodeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getNode(request, callback)

getNode(request: protos.google.cloud.tpu.v1.IGetNodeRequest, callback: Callback<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IGetNodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetNodeRequest
callback Callback<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IGetNodeRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

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

getProjectId(callback)

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

getTensorFlowVersion(request, options)

getTensorFlowVersion(request?: protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.ITensorFlowVersion,
        protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.ITensorFlowVersion, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | undefined, {} | undefined ]>

getTensorFlowVersion(request, options, callback)

getTensorFlowVersion(request: protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.tpu.v1.ITensorFlowVersion, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
options CallOptions
callback Callback<protos.google.cloud.tpu.v1.ITensorFlowVersion, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getTensorFlowVersion(request, callback)

getTensorFlowVersion(request: protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest, callback: Callback<protos.google.cloud.tpu.v1.ITensorFlowVersion, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest
callback Callback<protos.google.cloud.tpu.v1.ITensorFlowVersion, protos.google.cloud.tpu.v1.IGetTensorFlowVersionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

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

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

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

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

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

listAcceleratorTypes(request, options)

listAcceleratorTypes(request?: protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.IAcceleratorType[],
        protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest | null,
        protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.IAcceleratorType[], protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest | null, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse ]>

listAcceleratorTypes(request, options, callback)

listAcceleratorTypes(request: protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse | null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse | null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType>
Returns
Type Description
void

listAcceleratorTypes(request, callback)

listAcceleratorTypes(request: protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse | null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest
callback PaginationCallback<protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, protos.google.cloud.tpu.v1.IListAcceleratorTypesResponse | null | undefined, protos.google.cloud.tpu.v1.IAcceleratorType>
Returns
Type Description
void

listAcceleratorTypesAsync(request, options)

listAcceleratorTypesAsync(request?: protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tpu.v1.IAcceleratorType>;

Equivalent to listAcceleratorTypes, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.tpu.v1.IAcceleratorType>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [AcceleratorType]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAcceleratorTypesStream(request, options)

listAcceleratorTypesStream(request?: protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListAcceleratorTypesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [AcceleratorType] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAcceleratorTypesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNodes(request, options)

listNodes(request?: protos.google.cloud.tpu.v1.IListNodesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.INode[],
        protos.google.cloud.tpu.v1.IListNodesRequest | null,
        protos.google.cloud.tpu.v1.IListNodesResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListNodesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.INode[], protos.google.cloud.tpu.v1.IListNodesRequest | null, protos.google.cloud.tpu.v1.IListNodesResponse ]>

listNodes(request, options, callback)

listNodes(request: protos.google.cloud.tpu.v1.IListNodesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListNodesRequest, protos.google.cloud.tpu.v1.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v1.INode>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListNodesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.tpu.v1.IListNodesRequest, protos.google.cloud.tpu.v1.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v1.INode>
Returns
Type Description
void

listNodes(request, callback)

listNodes(request: protos.google.cloud.tpu.v1.IListNodesRequest, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListNodesRequest, protos.google.cloud.tpu.v1.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v1.INode>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListNodesRequest
callback PaginationCallback<protos.google.cloud.tpu.v1.IListNodesRequest, protos.google.cloud.tpu.v1.IListNodesResponse | null | undefined, protos.google.cloud.tpu.v1.INode>
Returns
Type Description
void

listNodesAsync(request, options)

listNodesAsync(request?: protos.google.cloud.tpu.v1.IListNodesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tpu.v1.INode>;

Equivalent to listNodes, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListNodesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.tpu.v1.INode>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNodesStream(request, options)

listNodesStream(request?: protos.google.cloud.tpu.v1.IListNodesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListNodesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTensorFlowVersions(request, options)

listTensorFlowVersions(request?: protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.tpu.v1.ITensorFlowVersion[],
        protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest | null,
        protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.tpu.v1.ITensorFlowVersion[], protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest | null, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse ]>

listTensorFlowVersions(request, options, callback)

listTensorFlowVersions(request: protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse | null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse | null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion>
Returns
Type Description
void

listTensorFlowVersions(request, callback)

listTensorFlowVersions(request: protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, callback: PaginationCallback<protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse | null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest
callback PaginationCallback<protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, protos.google.cloud.tpu.v1.IListTensorFlowVersionsResponse | null | undefined, protos.google.cloud.tpu.v1.ITensorFlowVersion>
Returns
Type Description
void

listTensorFlowVersionsAsync(request, options)

listTensorFlowVersionsAsync(request?: protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.tpu.v1.ITensorFlowVersion>;

Equivalent to listTensorFlowVersions, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.tpu.v1.ITensorFlowVersion>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [TensorFlowVersion]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listTensorFlowVersionsStream(request, options)

listTensorFlowVersionsStream(request?: protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.tpu.v1.IListTensorFlowVersionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [TensorFlowVersion] 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 listTensorFlowVersionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchAcceleratorTypeFromAcceleratorTypeName(acceleratorTypeName)

matchAcceleratorTypeFromAcceleratorTypeName(acceleratorTypeName: string): string | number;

Parse the accelerator_type from AcceleratorType resource.

Parameter
Name Description
acceleratorTypeName string

A fully-qualified path representing AcceleratorType resource.
Returns
Type Description
string | number

{string} A string representing the accelerator_type.

matchLocationFromAcceleratorTypeName(acceleratorTypeName)

matchLocationFromAcceleratorTypeName(acceleratorTypeName: string): string | number;

Parse the location from AcceleratorType resource.

Parameter
Name Description
acceleratorTypeName string

A fully-qualified path representing AcceleratorType resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromNodeName(nodeName)

matchLocationFromNodeName(nodeName: string): string | number;

Parse the location from Node resource.

Parameter
Name Description
nodeName string

A fully-qualified path representing Node resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromTensorFlowVersionName(tensorFlowVersionName)

matchLocationFromTensorFlowVersionName(tensorFlowVersionName: string): string | number;

Parse the location from TensorFlowVersion resource.

Parameter
Name Description
tensorFlowVersionName string

A fully-qualified path representing TensorFlowVersion resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchNodeFromNodeName(nodeName)

matchNodeFromNodeName(nodeName: string): string | number;

Parse the node from Node resource.

Parameter
Name Description
nodeName string

A fully-qualified path representing Node resource.
Returns
Type Description
string | number

{string} A string representing the node.

matchProjectFromAcceleratorTypeName(acceleratorTypeName)

matchProjectFromAcceleratorTypeName(acceleratorTypeName: string): string | number;

Parse the project from AcceleratorType resource.

Parameter
Name Description
acceleratorTypeName string

A fully-qualified path representing AcceleratorType resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromNodeName(nodeName)

matchProjectFromNodeName(nodeName: string): string | number;

Parse the project from Node resource.

Parameter
Name Description
nodeName string

A fully-qualified path representing Node resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromTensorFlowVersionName(tensorFlowVersionName)

matchProjectFromTensorFlowVersionName(tensorFlowVersionName: string): string | number;

Parse the project from TensorFlowVersion resource.

Parameter
Name Description
tensorFlowVersionName string

A fully-qualified path representing TensorFlowVersion resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchTensorFlowVersionFromTensorFlowVersionName(tensorFlowVersionName)

matchTensorFlowVersionFromTensorFlowVersionName(tensorFlowVersionName: string): string | number;

Parse the tensor_flow_version from TensorFlowVersion resource.

Parameter
Name Description
tensorFlowVersionName string

A fully-qualified path representing TensorFlowVersion resource.
Returns
Type Description
string | number

{string} A string representing the tensor_flow_version.

nodePath(project, location, node)

nodePath(project: string, location: string, node: string): string;

Return a fully-qualified node resource name string.

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

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

reimageNode(request, options)

reimageNode(request?: protos.google.cloud.tpu.v1.IReimageNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IReimageNodeRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

reimageNode(request, options, callback)

reimageNode(request: protos.google.cloud.tpu.v1.IReimageNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IReimageNodeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

reimageNode(request, callback)

reimageNode(request: protos.google.cloud.tpu.v1.IReimageNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IReimageNodeRequest
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

startNode(request, options)

startNode(request?: protos.google.cloud.tpu.v1.IStartNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStartNodeRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

startNode(request, options, callback)

startNode(request: protos.google.cloud.tpu.v1.IStartNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStartNodeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

startNode(request, callback)

startNode(request: protos.google.cloud.tpu.v1.IStartNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStartNodeRequest
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

stopNode(request, options)

stopNode(request?: protos.google.cloud.tpu.v1.IStopNodeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStopNodeRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

stopNode(request, options, callback)

stopNode(request: protos.google.cloud.tpu.v1.IStopNodeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStopNodeRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

stopNode(request, callback)

stopNode(request: protos.google.cloud.tpu.v1.IStopNodeRequest, callback: Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.tpu.v1.IStopNodeRequest
callback Callback<LROperation<protos.google.cloud.tpu.v1.INode, protos.google.cloud.tpu.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

tensorFlowVersionPath(project, location, tensorFlowVersion)

tensorFlowVersionPath(project: string, location: string, tensorFlowVersion: string): string;

Return a fully-qualified tensorFlowVersion resource name string.

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

{string} Resource name string.