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

Represents a Tpu

Inheritance

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

Package

@google-cloud/tpu

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Tpu service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Tpu;

Creates new Tpu service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Tpu

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

createNode(request, callback)

public createNode(request: google.cloud.tpu.v2alpha1.ICreateNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.CreateNodeCallback): void;

Calls CreateNode.

Parameters
Name Description
request ICreateNodeRequest

CreateNodeRequest message or plain object
callback CreateNodeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createNode(request)

public createNode(request: google.cloud.tpu.v2alpha1.ICreateNodeRequest): Promise<google.longrunning.Operation>;

Calls CreateNode.

Parameter
Name Description
request ICreateNodeRequest

CreateNodeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createQueuedResource(request, callback)

public createQueuedResource(request: google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResourceCallback): void;

Calls CreateQueuedResource.

Parameters
Name Description
request ICreateQueuedResourceRequest

CreateQueuedResourceRequest message or plain object
callback CreateQueuedResourceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createQueuedResource(request)

public createQueuedResource(request: google.cloud.tpu.v2alpha1.ICreateQueuedResourceRequest): Promise<google.longrunning.Operation>;

Calls CreateQueuedResource.

Parameter
Name Description
request ICreateQueuedResourceRequest

CreateQueuedResourceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteNode(request, callback)

public deleteNode(request: google.cloud.tpu.v2alpha1.IDeleteNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.DeleteNodeCallback): void;

Calls DeleteNode.

Parameters
Name Description
request IDeleteNodeRequest

DeleteNodeRequest message or plain object
callback DeleteNodeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteNode(request)

public deleteNode(request: google.cloud.tpu.v2alpha1.IDeleteNodeRequest): Promise<google.longrunning.Operation>;

Calls DeleteNode.

Parameter
Name Description
request IDeleteNodeRequest

DeleteNodeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteQueuedResource(request, callback)

public deleteQueuedResource(request: google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResourceCallback): void;

Calls DeleteQueuedResource.

Parameters
Name Description
request IDeleteQueuedResourceRequest

DeleteQueuedResourceRequest message or plain object
callback DeleteQueuedResourceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteQueuedResource(request)

public deleteQueuedResource(request: google.cloud.tpu.v2alpha1.IDeleteQueuedResourceRequest): Promise<google.longrunning.Operation>;

Calls DeleteQueuedResource.

Parameter
Name Description
request IDeleteQueuedResourceRequest

DeleteQueuedResourceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

generateServiceIdentity(request, callback)

public generateServiceIdentity(request: google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentityCallback): void;

Calls GenerateServiceIdentity.

Parameters
Name Description
request IGenerateServiceIdentityRequest

GenerateServiceIdentityRequest message or plain object
callback GenerateServiceIdentityCallback

Node-style callback called with the error, if any, and GenerateServiceIdentityResponse
Returns
Type Description
void

generateServiceIdentity(request)

public generateServiceIdentity(request: google.cloud.tpu.v2alpha1.IGenerateServiceIdentityRequest): Promise<google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse>;

Calls GenerateServiceIdentity.

Parameter
Name Description
request IGenerateServiceIdentityRequest

GenerateServiceIdentityRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse>

Promise

getAcceleratorType(request, callback)

public getAcceleratorType(request: google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorTypeCallback): void;

Calls GetAcceleratorType.

Parameters
Name Description
request IGetAcceleratorTypeRequest

GetAcceleratorTypeRequest message or plain object
callback GetAcceleratorTypeCallback

Node-style callback called with the error, if any, and AcceleratorType
Returns
Type Description
void

getAcceleratorType(request)

public getAcceleratorType(request: google.cloud.tpu.v2alpha1.IGetAcceleratorTypeRequest): Promise<google.cloud.tpu.v2alpha1.AcceleratorType>;

Calls GetAcceleratorType.

Parameter
Name Description
request IGetAcceleratorTypeRequest

GetAcceleratorTypeRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.AcceleratorType>

Promise

getGuestAttributes(request, callback)

public getGuestAttributes(request: google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributesCallback): void;

Calls GetGuestAttributes.

Parameters
Name Description
request IGetGuestAttributesRequest

GetGuestAttributesRequest message or plain object
callback GetGuestAttributesCallback

Node-style callback called with the error, if any, and GetGuestAttributesResponse
Returns
Type Description
void

getGuestAttributes(request)

public getGuestAttributes(request: google.cloud.tpu.v2alpha1.IGetGuestAttributesRequest): Promise<google.cloud.tpu.v2alpha1.GetGuestAttributesResponse>;

Calls GetGuestAttributes.

Parameter
Name Description
request IGetGuestAttributesRequest

GetGuestAttributesRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.GetGuestAttributesResponse>

Promise

getNode(request, callback)

public getNode(request: google.cloud.tpu.v2alpha1.IGetNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GetNodeCallback): void;

Calls GetNode.

Parameters
Name Description
request IGetNodeRequest

GetNodeRequest message or plain object
callback GetNodeCallback

Node-style callback called with the error, if any, and Node
Returns
Type Description
void

getNode(request)

public getNode(request: google.cloud.tpu.v2alpha1.IGetNodeRequest): Promise<google.cloud.tpu.v2alpha1.Node>;

Calls GetNode.

Parameter
Name Description
request IGetNodeRequest

GetNodeRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.Node>

Promise

getQueuedResource(request, callback)

public getQueuedResource(request: google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GetQueuedResourceCallback): void;

Calls GetQueuedResource.

Parameters
Name Description
request IGetQueuedResourceRequest

GetQueuedResourceRequest message or plain object
callback GetQueuedResourceCallback

Node-style callback called with the error, if any, and QueuedResource
Returns
Type Description
void

getQueuedResource(request)

public getQueuedResource(request: google.cloud.tpu.v2alpha1.IGetQueuedResourceRequest): Promise<google.cloud.tpu.v2alpha1.QueuedResource>;

Calls GetQueuedResource.

Parameter
Name Description
request IGetQueuedResourceRequest

GetQueuedResourceRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.QueuedResource>

Promise

getRuntimeVersion(request, callback)

public getRuntimeVersion(request: google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest, callback: google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersionCallback): void;

Calls GetRuntimeVersion.

Parameters
Name Description
request IGetRuntimeVersionRequest

GetRuntimeVersionRequest message or plain object
callback GetRuntimeVersionCallback

Node-style callback called with the error, if any, and RuntimeVersion
Returns
Type Description
void

getRuntimeVersion(request)

public getRuntimeVersion(request: google.cloud.tpu.v2alpha1.IGetRuntimeVersionRequest): Promise<google.cloud.tpu.v2alpha1.RuntimeVersion>;

Calls GetRuntimeVersion.

Parameter
Name Description
request IGetRuntimeVersionRequest

GetRuntimeVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.RuntimeVersion>

Promise

listAcceleratorTypes(request, callback)

public listAcceleratorTypes(request: google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypesCallback): void;

Calls ListAcceleratorTypes.

Parameters
Name Description
request IListAcceleratorTypesRequest

ListAcceleratorTypesRequest message or plain object
callback ListAcceleratorTypesCallback

Node-style callback called with the error, if any, and ListAcceleratorTypesResponse
Returns
Type Description
void

listAcceleratorTypes(request)

public listAcceleratorTypes(request: google.cloud.tpu.v2alpha1.IListAcceleratorTypesRequest): Promise<google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse>;

Calls ListAcceleratorTypes.

Parameter
Name Description
request IListAcceleratorTypesRequest

ListAcceleratorTypesRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse>

Promise

listNodes(request, callback)

public listNodes(request: google.cloud.tpu.v2alpha1.IListNodesRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ListNodesCallback): void;

Calls ListNodes.

Parameters
Name Description
request IListNodesRequest

ListNodesRequest message or plain object
callback ListNodesCallback

Node-style callback called with the error, if any, and ListNodesResponse
Returns
Type Description
void

listNodes(request)

public listNodes(request: google.cloud.tpu.v2alpha1.IListNodesRequest): Promise<google.cloud.tpu.v2alpha1.ListNodesResponse>;

Calls ListNodes.

Parameter
Name Description
request IListNodesRequest

ListNodesRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.ListNodesResponse>

Promise

listQueuedResources(request, callback)

public listQueuedResources(request: google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ListQueuedResourcesCallback): void;

Calls ListQueuedResources.

Parameters
Name Description
request IListQueuedResourcesRequest

ListQueuedResourcesRequest message or plain object
callback ListQueuedResourcesCallback

Node-style callback called with the error, if any, and ListQueuedResourcesResponse
Returns
Type Description
void

listQueuedResources(request)

public listQueuedResources(request: google.cloud.tpu.v2alpha1.IListQueuedResourcesRequest): Promise<google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse>;

Calls ListQueuedResources.

Parameter
Name Description
request IListQueuedResourcesRequest

ListQueuedResourcesRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse>

Promise

listReservations(request, callback)

public listReservations(request: google.cloud.tpu.v2alpha1.IListReservationsRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ListReservationsCallback): void;

Calls ListReservations.

Parameters
Name Description
request IListReservationsRequest

ListReservationsRequest message or plain object
callback ListReservationsCallback

Node-style callback called with the error, if any, and ListReservationsResponse
Returns
Type Description
void

listReservations(request)

public listReservations(request: google.cloud.tpu.v2alpha1.IListReservationsRequest): Promise<google.cloud.tpu.v2alpha1.ListReservationsResponse>;

Calls ListReservations.

Parameter
Name Description
request IListReservationsRequest

ListReservationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.ListReservationsResponse>

Promise

listRuntimeVersions(request, callback)

public listRuntimeVersions(request: google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersionsCallback): void;

Calls ListRuntimeVersions.

Parameters
Name Description
request IListRuntimeVersionsRequest

ListRuntimeVersionsRequest message or plain object
callback ListRuntimeVersionsCallback

Node-style callback called with the error, if any, and ListRuntimeVersionsResponse
Returns
Type Description
void

listRuntimeVersions(request)

public listRuntimeVersions(request: google.cloud.tpu.v2alpha1.IListRuntimeVersionsRequest): Promise<google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse>;

Calls ListRuntimeVersions.

Parameter
Name Description
request IListRuntimeVersionsRequest

ListRuntimeVersionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse>

Promise

performMaintenance(request, callback)

public performMaintenance(request: google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.PerformMaintenanceCallback): void;

Calls PerformMaintenance.

Parameters
Name Description
request IPerformMaintenanceRequest

PerformMaintenanceRequest message or plain object
callback PerformMaintenanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

performMaintenance(request)

public performMaintenance(request: google.cloud.tpu.v2alpha1.IPerformMaintenanceRequest): Promise<google.longrunning.Operation>;

Calls PerformMaintenance.

Parameter
Name Description
request IPerformMaintenanceRequest

PerformMaintenanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

performMaintenanceQueuedResource(request, callback)

public performMaintenanceQueuedResource(request: google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.PerformMaintenanceQueuedResourceCallback): void;

Calls PerformMaintenanceQueuedResource.

Parameters
Name Description
request IPerformMaintenanceQueuedResourceRequest

PerformMaintenanceQueuedResourceRequest message or plain object
callback PerformMaintenanceQueuedResourceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

performMaintenanceQueuedResource(request)

public performMaintenanceQueuedResource(request: google.cloud.tpu.v2alpha1.IPerformMaintenanceQueuedResourceRequest): Promise<google.longrunning.Operation>;

Calls PerformMaintenanceQueuedResource.

Parameter
Name Description
request IPerformMaintenanceQueuedResourceRequest

PerformMaintenanceQueuedResourceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

resetQueuedResource(request, callback)

public resetQueuedResource(request: google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest, callback: google.cloud.tpu.v2alpha1.Tpu.ResetQueuedResourceCallback): void;

Calls ResetQueuedResource.

Parameters
Name Description
request IResetQueuedResourceRequest

ResetQueuedResourceRequest message or plain object
callback ResetQueuedResourceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resetQueuedResource(request)

public resetQueuedResource(request: google.cloud.tpu.v2alpha1.IResetQueuedResourceRequest): Promise<google.longrunning.Operation>;

Calls ResetQueuedResource.

Parameter
Name Description
request IResetQueuedResourceRequest

ResetQueuedResourceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

simulateMaintenanceEvent(request, callback)

public simulateMaintenanceEvent(request: google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest, callback: google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEventCallback): void;

Calls SimulateMaintenanceEvent.

Parameters
Name Description
request ISimulateMaintenanceEventRequest

SimulateMaintenanceEventRequest message or plain object
callback SimulateMaintenanceEventCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

simulateMaintenanceEvent(request)

public simulateMaintenanceEvent(request: google.cloud.tpu.v2alpha1.ISimulateMaintenanceEventRequest): Promise<google.longrunning.Operation>;

Calls SimulateMaintenanceEvent.

Parameter
Name Description
request ISimulateMaintenanceEventRequest

SimulateMaintenanceEventRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

startNode(request, callback)

public startNode(request: google.cloud.tpu.v2alpha1.IStartNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.StartNodeCallback): void;

Calls StartNode.

Parameters
Name Description
request IStartNodeRequest

StartNodeRequest message or plain object
callback StartNodeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

startNode(request)

public startNode(request: google.cloud.tpu.v2alpha1.IStartNodeRequest): Promise<google.longrunning.Operation>;

Calls StartNode.

Parameter
Name Description
request IStartNodeRequest

StartNodeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

stopNode(request, callback)

public stopNode(request: google.cloud.tpu.v2alpha1.IStopNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.StopNodeCallback): void;

Calls StopNode.

Parameters
Name Description
request IStopNodeRequest

StopNodeRequest message or plain object
callback StopNodeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

stopNode(request)

public stopNode(request: google.cloud.tpu.v2alpha1.IStopNodeRequest): Promise<google.longrunning.Operation>;

Calls StopNode.

Parameter
Name Description
request IStopNodeRequest

StopNodeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateNode(request, callback)

public updateNode(request: google.cloud.tpu.v2alpha1.IUpdateNodeRequest, callback: google.cloud.tpu.v2alpha1.Tpu.UpdateNodeCallback): void;

Calls UpdateNode.

Parameters
Name Description
request IUpdateNodeRequest

UpdateNodeRequest message or plain object
callback UpdateNodeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateNode(request)

public updateNode(request: google.cloud.tpu.v2alpha1.IUpdateNodeRequest): Promise<google.longrunning.Operation>;

Calls UpdateNode.

Parameter
Name Description
request IUpdateNodeRequest

UpdateNodeRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise