Class protos.google.cloud.tpu.v2.Tpu (3.8.0)

Represents a Tpu

Inheritance

$protobuf.rpc.Service >protos.google.cloud.tpu.v2.Tpu

Package

@google-cloud/tpu

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl:$protobuf.RPCImpl,requestDelimited?:boolean,responseDelimited?:boolean);

Constructs a new Tpu service.

Parameters
NameDescription
rpcImpl$protobuf.RPCImpl

RPC implementation

requestDelimitedboolean

Whether requests are length-delimited

responseDelimitedboolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

publicstaticcreate(rpcImpl:$protobuf.RPCImpl,requestDelimited?:boolean,responseDelimited?:boolean):Tpu;

Creates new Tpu service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl$protobuf.RPCImpl

RPC implementation

requestDelimitedboolean

Whether requests are length-delimited

responseDelimitedboolean

Whether responses are length-delimited

Returns
TypeDescription
Tpu

RPC service. Useful where requests and/or responses are streamed.

createNode(request, callback)

publiccreateNode(request:google.cloud.tpu.v2.ICreateNodeRequest,callback:google.cloud.tpu.v2.Tpu.CreateNodeCallback):void;

Calls CreateNode.

Parameters
NameDescription
requestICreateNodeRequest

CreateNodeRequest message or plain object

callbackCreateNodeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createNode(request)

publiccreateNode(request:google.cloud.tpu.v2.ICreateNodeRequest):Promise<google.longrunning.Operation>;

Calls CreateNode.

Parameter
NameDescription
requestICreateNodeRequest

CreateNodeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

createQueuedResource(request, callback)

publiccreateQueuedResource(request:google.cloud.tpu.v2.ICreateQueuedResourceRequest,callback:google.cloud.tpu.v2.Tpu.CreateQueuedResourceCallback):void;

Calls CreateQueuedResource.

Parameters
NameDescription
requestICreateQueuedResourceRequest

CreateQueuedResourceRequest message or plain object

callbackCreateQueuedResourceCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

createQueuedResource(request)

publiccreateQueuedResource(request:google.cloud.tpu.v2.ICreateQueuedResourceRequest):Promise<google.longrunning.Operation>;

Calls CreateQueuedResource.

Parameter
NameDescription
requestICreateQueuedResourceRequest

CreateQueuedResourceRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteNode(request, callback)

publicdeleteNode(request:google.cloud.tpu.v2.IDeleteNodeRequest,callback:google.cloud.tpu.v2.Tpu.DeleteNodeCallback):void;

Calls DeleteNode.

Parameters
NameDescription
requestIDeleteNodeRequest

DeleteNodeRequest message or plain object

callbackDeleteNodeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteNode(request)

publicdeleteNode(request:google.cloud.tpu.v2.IDeleteNodeRequest):Promise<google.longrunning.Operation>;

Calls DeleteNode.

Parameter
NameDescription
requestIDeleteNodeRequest

DeleteNodeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

deleteQueuedResource(request, callback)

publicdeleteQueuedResource(request:google.cloud.tpu.v2.IDeleteQueuedResourceRequest,callback:google.cloud.tpu.v2.Tpu.DeleteQueuedResourceCallback):void;

Calls DeleteQueuedResource.

Parameters
NameDescription
requestIDeleteQueuedResourceRequest

DeleteQueuedResourceRequest message or plain object

callbackDeleteQueuedResourceCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

deleteQueuedResource(request)

publicdeleteQueuedResource(request:google.cloud.tpu.v2.IDeleteQueuedResourceRequest):Promise<google.longrunning.Operation>;

Calls DeleteQueuedResource.

Parameter
NameDescription
requestIDeleteQueuedResourceRequest

DeleteQueuedResourceRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

generateServiceIdentity(request, callback)

publicgenerateServiceIdentity(request:google.cloud.tpu.v2.IGenerateServiceIdentityRequest,callback:google.cloud.tpu.v2.Tpu.GenerateServiceIdentityCallback):void;

Calls GenerateServiceIdentity.

Parameters
NameDescription
requestIGenerateServiceIdentityRequest

GenerateServiceIdentityRequest message or plain object

callbackGenerateServiceIdentityCallback

Node-style callback called with the error, if any, and GenerateServiceIdentityResponse

Returns
TypeDescription
void

generateServiceIdentity(request)

publicgenerateServiceIdentity(request:google.cloud.tpu.v2.IGenerateServiceIdentityRequest):Promise<google.cloud.tpu.v2.GenerateServiceIdentityResponse>;

Calls GenerateServiceIdentity.

Parameter
NameDescription
requestIGenerateServiceIdentityRequest

GenerateServiceIdentityRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.GenerateServiceIdentityResponse>

Promise

getAcceleratorType(request, callback)

publicgetAcceleratorType(request:google.cloud.tpu.v2.IGetAcceleratorTypeRequest,callback:google.cloud.tpu.v2.Tpu.GetAcceleratorTypeCallback):void;

Calls GetAcceleratorType.

Parameters
NameDescription
requestIGetAcceleratorTypeRequest

GetAcceleratorTypeRequest message or plain object

callbackGetAcceleratorTypeCallback

Node-style callback called with the error, if any, and AcceleratorType

Returns
TypeDescription
void

getAcceleratorType(request)

publicgetAcceleratorType(request:google.cloud.tpu.v2.IGetAcceleratorTypeRequest):Promise<google.cloud.tpu.v2.AcceleratorType>;

Calls GetAcceleratorType.

Parameter
NameDescription
requestIGetAcceleratorTypeRequest

GetAcceleratorTypeRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.AcceleratorType>

Promise

getGuestAttributes(request, callback)

publicgetGuestAttributes(request:google.cloud.tpu.v2.IGetGuestAttributesRequest,callback:google.cloud.tpu.v2.Tpu.GetGuestAttributesCallback):void;

Calls GetGuestAttributes.

Parameters
NameDescription
requestIGetGuestAttributesRequest

GetGuestAttributesRequest message or plain object

callbackGetGuestAttributesCallback

Node-style callback called with the error, if any, and GetGuestAttributesResponse

Returns
TypeDescription
void

getGuestAttributes(request)

publicgetGuestAttributes(request:google.cloud.tpu.v2.IGetGuestAttributesRequest):Promise<google.cloud.tpu.v2.GetGuestAttributesResponse>;

Calls GetGuestAttributes.

Parameter
NameDescription
requestIGetGuestAttributesRequest

GetGuestAttributesRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.GetGuestAttributesResponse>

Promise

getNode(request, callback)

publicgetNode(request:google.cloud.tpu.v2.IGetNodeRequest,callback:google.cloud.tpu.v2.Tpu.GetNodeCallback):void;

Calls GetNode.

Parameters
NameDescription
requestIGetNodeRequest

GetNodeRequest message or plain object

callbackGetNodeCallback

Node-style callback called with the error, if any, and Node

Returns
TypeDescription
void

getNode(request)

publicgetNode(request:google.cloud.tpu.v2.IGetNodeRequest):Promise<google.cloud.tpu.v2.Node>;

Calls GetNode.

Parameter
NameDescription
requestIGetNodeRequest

GetNodeRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.Node>

Promise

getQueuedResource(request, callback)

publicgetQueuedResource(request:google.cloud.tpu.v2.IGetQueuedResourceRequest,callback:google.cloud.tpu.v2.Tpu.GetQueuedResourceCallback):void;

Calls GetQueuedResource.

Parameters
NameDescription
requestIGetQueuedResourceRequest

GetQueuedResourceRequest message or plain object

callbackGetQueuedResourceCallback

Node-style callback called with the error, if any, and QueuedResource

Returns
TypeDescription
void

getQueuedResource(request)

publicgetQueuedResource(request:google.cloud.tpu.v2.IGetQueuedResourceRequest):Promise<google.cloud.tpu.v2.QueuedResource>;

Calls GetQueuedResource.

Parameter
NameDescription
requestIGetQueuedResourceRequest

GetQueuedResourceRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.QueuedResource>

Promise

getRuntimeVersion(request, callback)

publicgetRuntimeVersion(request:google.cloud.tpu.v2.IGetRuntimeVersionRequest,callback:google.cloud.tpu.v2.Tpu.GetRuntimeVersionCallback):void;

Calls GetRuntimeVersion.

Parameters
NameDescription
requestIGetRuntimeVersionRequest

GetRuntimeVersionRequest message or plain object

callbackGetRuntimeVersionCallback

Node-style callback called with the error, if any, and RuntimeVersion

Returns
TypeDescription
void

getRuntimeVersion(request)

publicgetRuntimeVersion(request:google.cloud.tpu.v2.IGetRuntimeVersionRequest):Promise<google.cloud.tpu.v2.RuntimeVersion>;

Calls GetRuntimeVersion.

Parameter
NameDescription
requestIGetRuntimeVersionRequest

GetRuntimeVersionRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.RuntimeVersion>

Promise

listAcceleratorTypes(request, callback)

publiclistAcceleratorTypes(request:google.cloud.tpu.v2.IListAcceleratorTypesRequest,callback:google.cloud.tpu.v2.Tpu.ListAcceleratorTypesCallback):void;

Calls ListAcceleratorTypes.

Parameters
NameDescription
requestIListAcceleratorTypesRequest

ListAcceleratorTypesRequest message or plain object

callbackListAcceleratorTypesCallback

Node-style callback called with the error, if any, and ListAcceleratorTypesResponse

Returns
TypeDescription
void

listAcceleratorTypes(request)

publiclistAcceleratorTypes(request:google.cloud.tpu.v2.IListAcceleratorTypesRequest):Promise<google.cloud.tpu.v2.ListAcceleratorTypesResponse>;

Calls ListAcceleratorTypes.

Parameter
NameDescription
requestIListAcceleratorTypesRequest

ListAcceleratorTypesRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.ListAcceleratorTypesResponse>

Promise

listNodes(request, callback)

publiclistNodes(request:google.cloud.tpu.v2.IListNodesRequest,callback:google.cloud.tpu.v2.Tpu.ListNodesCallback):void;

Calls ListNodes.

Parameters
NameDescription
requestIListNodesRequest

ListNodesRequest message or plain object

callbackListNodesCallback

Node-style callback called with the error, if any, and ListNodesResponse

Returns
TypeDescription
void

listNodes(request)

publiclistNodes(request:google.cloud.tpu.v2.IListNodesRequest):Promise<google.cloud.tpu.v2.ListNodesResponse>;

Calls ListNodes.

Parameter
NameDescription
requestIListNodesRequest

ListNodesRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.ListNodesResponse>

Promise

listQueuedResources(request, callback)

publiclistQueuedResources(request:google.cloud.tpu.v2.IListQueuedResourcesRequest,callback:google.cloud.tpu.v2.Tpu.ListQueuedResourcesCallback):void;

Calls ListQueuedResources.

Parameters
NameDescription
requestIListQueuedResourcesRequest

ListQueuedResourcesRequest message or plain object

callbackListQueuedResourcesCallback

Node-style callback called with the error, if any, and ListQueuedResourcesResponse

Returns
TypeDescription
void

listQueuedResources(request)

publiclistQueuedResources(request:google.cloud.tpu.v2.IListQueuedResourcesRequest):Promise<google.cloud.tpu.v2.ListQueuedResourcesResponse>;

Calls ListQueuedResources.

Parameter
NameDescription
requestIListQueuedResourcesRequest

ListQueuedResourcesRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.ListQueuedResourcesResponse>

Promise

listRuntimeVersions(request, callback)

publiclistRuntimeVersions(request:google.cloud.tpu.v2.IListRuntimeVersionsRequest,callback:google.cloud.tpu.v2.Tpu.ListRuntimeVersionsCallback):void;

Calls ListRuntimeVersions.

Parameters
NameDescription
requestIListRuntimeVersionsRequest

ListRuntimeVersionsRequest message or plain object

callbackListRuntimeVersionsCallback

Node-style callback called with the error, if any, and ListRuntimeVersionsResponse

Returns
TypeDescription
void

listRuntimeVersions(request)

publiclistRuntimeVersions(request:google.cloud.tpu.v2.IListRuntimeVersionsRequest):Promise<google.cloud.tpu.v2.ListRuntimeVersionsResponse>;

Calls ListRuntimeVersions.

Parameter
NameDescription
requestIListRuntimeVersionsRequest

ListRuntimeVersionsRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.tpu.v2.ListRuntimeVersionsResponse>

Promise

resetQueuedResource(request, callback)

publicresetQueuedResource(request:google.cloud.tpu.v2.IResetQueuedResourceRequest,callback:google.cloud.tpu.v2.Tpu.ResetQueuedResourceCallback):void;

Calls ResetQueuedResource.

Parameters
NameDescription
requestIResetQueuedResourceRequest

ResetQueuedResourceRequest message or plain object

callbackResetQueuedResourceCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

resetQueuedResource(request)

publicresetQueuedResource(request:google.cloud.tpu.v2.IResetQueuedResourceRequest):Promise<google.longrunning.Operation>;

Calls ResetQueuedResource.

Parameter
NameDescription
requestIResetQueuedResourceRequest

ResetQueuedResourceRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

startNode(request, callback)

publicstartNode(request:google.cloud.tpu.v2.IStartNodeRequest,callback:google.cloud.tpu.v2.Tpu.StartNodeCallback):void;

Calls StartNode.

Parameters
NameDescription
requestIStartNodeRequest

StartNodeRequest message or plain object

callbackStartNodeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

startNode(request)

publicstartNode(request:google.cloud.tpu.v2.IStartNodeRequest):Promise<google.longrunning.Operation>;

Calls StartNode.

Parameter
NameDescription
requestIStartNodeRequest

StartNodeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

stopNode(request, callback)

publicstopNode(request:google.cloud.tpu.v2.IStopNodeRequest,callback:google.cloud.tpu.v2.Tpu.StopNodeCallback):void;

Calls StopNode.

Parameters
NameDescription
requestIStopNodeRequest

StopNodeRequest message or plain object

callbackStopNodeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

stopNode(request)

publicstopNode(request:google.cloud.tpu.v2.IStopNodeRequest):Promise<google.longrunning.Operation>;

Calls StopNode.

Parameter
NameDescription
requestIStopNodeRequest

StopNodeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

updateNode(request, callback)

publicupdateNode(request:google.cloud.tpu.v2.IUpdateNodeRequest,callback:google.cloud.tpu.v2.Tpu.UpdateNodeCallback):void;

Calls UpdateNode.

Parameters
NameDescription
requestIUpdateNodeRequest

UpdateNodeRequest message or plain object

callbackUpdateNodeCallback

Node-style callback called with the error, if any, and Operation

Returns
TypeDescription
void

updateNode(request)

publicupdateNode(request:google.cloud.tpu.v2.IUpdateNodeRequest):Promise<google.longrunning.Operation>;

Calls UpdateNode.

Parameter
NameDescription
requestIUpdateNodeRequest

UpdateNodeRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.