Class TpuGrpc.TpuFutureStub (2.53.0)

public static final class TpuGrpc.TpuFutureStub extends AbstractFutureStub<TpuGrpc.TpuFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Tpu.

Manages TPU nodes and other resources TPU API v2alpha1

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > TpuGrpc.TpuFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected TpuGrpc.TpuFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`TpuGrpc.TpuFutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createNode(CreateNodeRequest request)

public ListenableFuture<Operation> createNode(CreateNodeRequest request)

Creates a node.

Parameter
Name	Description
`request`	`CreateNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createQueuedResource(CreateQueuedResourceRequest request)

public ListenableFuture<Operation> createQueuedResource(CreateQueuedResourceRequest request)

Creates a QueuedResource TPU instance.

Parameter
Name	Description
`request`	`CreateQueuedResourceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteNode(DeleteNodeRequest request)

public ListenableFuture<Operation> deleteNode(DeleteNodeRequest request)

Deletes a node.

Parameter
Name	Description
`request`	`DeleteNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteQueuedResource(DeleteQueuedResourceRequest request)

public ListenableFuture<Operation> deleteQueuedResource(DeleteQueuedResourceRequest request)

Deletes a QueuedResource TPU instance.

Parameter
Name	Description
`request`	`DeleteQueuedResourceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

generateServiceIdentity(GenerateServiceIdentityRequest request)

public ListenableFuture<GenerateServiceIdentityResponse> generateServiceIdentity(GenerateServiceIdentityRequest request)

Generates the Cloud TPU service identity for the project.

Parameter
Name	Description
`request`	`GenerateServiceIdentityRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<GenerateServiceIdentityResponse>`

getAcceleratorType(GetAcceleratorTypeRequest request)

public ListenableFuture<AcceleratorType> getAcceleratorType(GetAcceleratorTypeRequest request)

Gets AcceleratorType.

Parameter
Name	Description
`request`	`GetAcceleratorTypeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<AcceleratorType>`

getGuestAttributes(GetGuestAttributesRequest request)

public ListenableFuture<GetGuestAttributesResponse> getGuestAttributes(GetGuestAttributesRequest request)

Retrieves the guest attributes for the node.

Parameter
Name	Description
`request`	`GetGuestAttributesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<GetGuestAttributesResponse>`

getNode(GetNodeRequest request)

public ListenableFuture<Node> getNode(GetNodeRequest request)

Gets the details of a node.

Parameter
Name	Description
`request`	`GetNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Node>`

getQueuedResource(GetQueuedResourceRequest request)

public ListenableFuture<QueuedResource> getQueuedResource(GetQueuedResourceRequest request)

Gets details of a queued resource.

Parameter
Name	Description
`request`	`GetQueuedResourceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<QueuedResource>`

getRuntimeVersion(GetRuntimeVersionRequest request)

public ListenableFuture<RuntimeVersion> getRuntimeVersion(GetRuntimeVersionRequest request)

Gets a runtime version.

Parameter
Name	Description
`request`	`GetRuntimeVersionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<RuntimeVersion>`

listAcceleratorTypes(ListAcceleratorTypesRequest request)

public ListenableFuture<ListAcceleratorTypesResponse> listAcceleratorTypes(ListAcceleratorTypesRequest request)

Lists accelerator types supported by this API.

Parameter
Name	Description
`request`	`ListAcceleratorTypesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListAcceleratorTypesResponse>`

listNodes(ListNodesRequest request)

public ListenableFuture<ListNodesResponse> listNodes(ListNodesRequest request)

Lists nodes.

Parameter
Name	Description
`request`	`ListNodesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListNodesResponse>`

listQueuedResources(ListQueuedResourcesRequest request)

public ListenableFuture<ListQueuedResourcesResponse> listQueuedResources(ListQueuedResourcesRequest request)

Lists queued resources.

Parameter
Name	Description
`request`	`ListQueuedResourcesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListQueuedResourcesResponse>`

listRuntimeVersions(ListRuntimeVersionsRequest request)

public ListenableFuture<ListRuntimeVersionsResponse> listRuntimeVersions(ListRuntimeVersionsRequest request)

Lists runtime versions supported by this API.

Parameter
Name	Description
`request`	`ListRuntimeVersionsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListRuntimeVersionsResponse>`

resetQueuedResource(ResetQueuedResourceRequest request)

public ListenableFuture<Operation> resetQueuedResource(ResetQueuedResourceRequest request)

Resets a QueuedResource TPU instance

Parameter
Name	Description
`request`	`ResetQueuedResourceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

simulateMaintenanceEvent(SimulateMaintenanceEventRequest request)

public ListenableFuture<Operation> simulateMaintenanceEvent(SimulateMaintenanceEventRequest request)

Simulates a maintenance event.

Parameter
Name	Description
`request`	`SimulateMaintenanceEventRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

startNode(StartNodeRequest request)

public ListenableFuture<Operation> startNode(StartNodeRequest request)

Starts a node.

Parameter
Name	Description
`request`	`StartNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

stopNode(StopNodeRequest request)

public ListenableFuture<Operation> stopNode(StopNodeRequest request)

Stops a node. This operation is only available with single TPU nodes.

Parameter
Name	Description
`request`	`StopNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateNode(UpdateNodeRequest request)

public ListenableFuture<Operation> updateNode(UpdateNodeRequest request)

Updates the configurations of a node.

Parameter
Name	Description
`request`	`UpdateNodeRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`