- 2.52.0 (latest)
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.2.6
public class TpuClient implements BackgroundResource
Service Description: Manages TPU nodes and other resources
TPU API v2
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
NodeName name = NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]");
Node response = tpuClient.getNode(name);
}
Note: close() needs to be called on the TpuClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of TpuSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TpuSettings tpuSettings =
TpuSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TpuClient tpuClient = TpuClient.create(tpuSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TpuSettings tpuSettings = TpuSettings.newBuilder().setEndpoint(myEndpoint).build();
TpuClient tpuClient = TpuClient.create(tpuSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TpuSettings tpuSettings = TpuSettings.newHttpJsonBuilder().build();
TpuClient tpuClient = TpuClient.create(tpuSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final TpuClient create()
Constructs an instance of TpuClient with default settings.
Returns | |
---|---|
Type | Description |
TpuClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(TpuSettings settings)
public static final TpuClient create(TpuSettings settings)
Constructs an instance of TpuClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | TpuSettings |
Returns | |
---|---|
Type | Description |
TpuClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(TpuStub stub)
public static final TpuClient create(TpuStub stub)
Constructs an instance of TpuClient, using the given stub for making calls. This is for advanced usage - prefer using create(TpuSettings).
Parameter | |
---|---|
Name | Description |
stub | TpuStub |
Returns | |
---|---|
Type | Description |
TpuClient |
Constructors
TpuClient(TpuSettings settings)
protected TpuClient(TpuSettings settings)
Constructs an instance of TpuClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | TpuSettings |
TpuClient(TpuStub stub)
protected TpuClient(TpuStub stub)
Parameter | |
---|---|
Name | Description |
stub | TpuStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createNodeAsync(CreateNodeRequest request)
public final OperationFuture<Node,OperationMetadata> createNodeAsync(CreateNodeRequest request)
Creates a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
CreateNodeRequest request =
CreateNodeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setNodeId("nodeId-1040171331")
.setNode(Node.newBuilder().build())
.build();
Node response = tpuClient.createNodeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | CreateNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
createNodeAsync(LocationName parent, Node node, String nodeId)
public final OperationFuture<Node,OperationMetadata> createNodeAsync(LocationName parent, Node node, String nodeId)
Creates a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Node node = Node.newBuilder().build();
String nodeId = "nodeId-1040171331";
Node response = tpuClient.createNodeAsync(parent, node, nodeId).get();
}
Parameters | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource name. |
node | Node Required. The node. |
nodeId | String The unqualified resource name. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
createNodeAsync(String parent, Node node, String nodeId)
public final OperationFuture<Node,OperationMetadata> createNodeAsync(String parent, Node node, String nodeId)
Creates a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Node node = Node.newBuilder().build();
String nodeId = "nodeId-1040171331";
Node response = tpuClient.createNodeAsync(parent, node, nodeId).get();
}
Parameters | |
---|---|
Name | Description |
parent | String Required. The parent resource name. |
node | Node Required. The node. |
nodeId | String The unqualified resource name. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
createNodeCallable()
public final UnaryCallable<CreateNodeRequest,Operation> createNodeCallable()
Creates a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
CreateNodeRequest request =
CreateNodeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setNodeId("nodeId-1040171331")
.setNode(Node.newBuilder().build())
.build();
ApiFuture<Operation> future = tpuClient.createNodeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateNodeRequest,Operation> |
createNodeOperationCallable()
public final OperationCallable<CreateNodeRequest,Node,OperationMetadata> createNodeOperationCallable()
Creates a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
CreateNodeRequest request =
CreateNodeRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setNodeId("nodeId-1040171331")
.setNode(Node.newBuilder().build())
.build();
OperationFuture<Node, OperationMetadata> future =
tpuClient.createNodeOperationCallable().futureCall(request);
// Do something.
Node response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateNodeRequest,Node,OperationMetadata> |
deleteNodeAsync(DeleteNodeRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteNodeAsync(DeleteNodeRequest request)
Deletes a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
DeleteNodeRequest request =
DeleteNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
tpuClient.deleteNodeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteNodeAsync(NodeName name)
public final OperationFuture<Empty,OperationMetadata> deleteNodeAsync(NodeName name)
Deletes a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
NodeName name = NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]");
tpuClient.deleteNodeAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | NodeName Required. The resource name. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteNodeAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteNodeAsync(String name)
Deletes a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String name = NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString();
tpuClient.deleteNodeAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteNodeCallable()
public final UnaryCallable<DeleteNodeRequest,Operation> deleteNodeCallable()
Deletes a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
DeleteNodeRequest request =
DeleteNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
ApiFuture<Operation> future = tpuClient.deleteNodeCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteNodeRequest,Operation> |
deleteNodeOperationCallable()
public final OperationCallable<DeleteNodeRequest,Empty,OperationMetadata> deleteNodeOperationCallable()
Deletes a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
DeleteNodeRequest request =
DeleteNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
tpuClient.deleteNodeOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteNodeRequest,Empty,OperationMetadata> |
generateServiceIdentity(GenerateServiceIdentityRequest request)
public final GenerateServiceIdentityResponse generateServiceIdentity(GenerateServiceIdentityRequest request)
Generates the Cloud TPU service identity for the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GenerateServiceIdentityRequest request =
GenerateServiceIdentityRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
GenerateServiceIdentityResponse response = tpuClient.generateServiceIdentity(request);
}
Parameter | |
---|---|
Name | Description |
request | GenerateServiceIdentityRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
GenerateServiceIdentityResponse |
generateServiceIdentityCallable()
public final UnaryCallable<GenerateServiceIdentityRequest,GenerateServiceIdentityResponse> generateServiceIdentityCallable()
Generates the Cloud TPU service identity for the project.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GenerateServiceIdentityRequest request =
GenerateServiceIdentityRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.build();
ApiFuture<GenerateServiceIdentityResponse> future =
tpuClient.generateServiceIdentityCallable().futureCall(request);
// Do something.
GenerateServiceIdentityResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GenerateServiceIdentityRequest,GenerateServiceIdentityResponse> |
getAcceleratorType(AcceleratorTypeName name)
public final AcceleratorType getAcceleratorType(AcceleratorTypeName name)
Gets AcceleratorType.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
AcceleratorTypeName name =
AcceleratorTypeName.of("[PROJECT]", "[LOCATION]", "[ACCELERATOR_TYPE]");
AcceleratorType response = tpuClient.getAcceleratorType(name);
}
Parameter | |
---|---|
Name | Description |
name | AcceleratorTypeName Required. The resource name. |
Returns | |
---|---|
Type | Description |
AcceleratorType |
getAcceleratorType(GetAcceleratorTypeRequest request)
public final AcceleratorType getAcceleratorType(GetAcceleratorTypeRequest request)
Gets AcceleratorType.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetAcceleratorTypeRequest request =
GetAcceleratorTypeRequest.newBuilder()
.setName(
AcceleratorTypeName.of("[PROJECT]", "[LOCATION]", "[ACCELERATOR_TYPE]")
.toString())
.build();
AcceleratorType response = tpuClient.getAcceleratorType(request);
}
Parameter | |
---|---|
Name | Description |
request | GetAcceleratorTypeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
AcceleratorType |
getAcceleratorType(String name)
public final AcceleratorType getAcceleratorType(String name)
Gets AcceleratorType.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String name =
AcceleratorTypeName.of("[PROJECT]", "[LOCATION]", "[ACCELERATOR_TYPE]").toString();
AcceleratorType response = tpuClient.getAcceleratorType(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name. |
Returns | |
---|---|
Type | Description |
AcceleratorType |
getAcceleratorTypeCallable()
public final UnaryCallable<GetAcceleratorTypeRequest,AcceleratorType> getAcceleratorTypeCallable()
Gets AcceleratorType.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetAcceleratorTypeRequest request =
GetAcceleratorTypeRequest.newBuilder()
.setName(
AcceleratorTypeName.of("[PROJECT]", "[LOCATION]", "[ACCELERATOR_TYPE]")
.toString())
.build();
ApiFuture<AcceleratorType> future =
tpuClient.getAcceleratorTypeCallable().futureCall(request);
// Do something.
AcceleratorType response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetAcceleratorTypeRequest,AcceleratorType> |
getGuestAttributes(GetGuestAttributesRequest request)
public final GetGuestAttributesResponse getGuestAttributes(GetGuestAttributesRequest request)
Retrieves the guest attributes for the node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetGuestAttributesRequest request =
GetGuestAttributesRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.setQueryPath("queryPath-1807004403")
.addAllWorkerIds(new ArrayList<String>())
.build();
GetGuestAttributesResponse response = tpuClient.getGuestAttributes(request);
}
Parameter | |
---|---|
Name | Description |
request | GetGuestAttributesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
GetGuestAttributesResponse |
getGuestAttributesCallable()
public final UnaryCallable<GetGuestAttributesRequest,GetGuestAttributesResponse> getGuestAttributesCallable()
Retrieves the guest attributes for the node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetGuestAttributesRequest request =
GetGuestAttributesRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.setQueryPath("queryPath-1807004403")
.addAllWorkerIds(new ArrayList<String>())
.build();
ApiFuture<GetGuestAttributesResponse> future =
tpuClient.getGuestAttributesCallable().futureCall(request);
// Do something.
GetGuestAttributesResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetGuestAttributesRequest,GetGuestAttributesResponse> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = tpuClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = tpuClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getNode(GetNodeRequest request)
public final Node getNode(GetNodeRequest request)
Gets the details of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetNodeRequest request =
GetNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
Node response = tpuClient.getNode(request);
}
Parameter | |
---|---|
Name | Description |
request | GetNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Node |
getNode(NodeName name)
public final Node getNode(NodeName name)
Gets the details of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
NodeName name = NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]");
Node response = tpuClient.getNode(name);
}
Parameter | |
---|---|
Name | Description |
name | NodeName Required. The resource name. |
Returns | |
---|---|
Type | Description |
Node |
getNode(String name)
public final Node getNode(String name)
Gets the details of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String name = NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString();
Node response = tpuClient.getNode(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name. |
Returns | |
---|---|
Type | Description |
Node |
getNodeCallable()
public final UnaryCallable<GetNodeRequest,Node> getNodeCallable()
Gets the details of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetNodeRequest request =
GetNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
ApiFuture<Node> future = tpuClient.getNodeCallable().futureCall(request);
// Do something.
Node response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetNodeRequest,Node> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getRuntimeVersion(GetRuntimeVersionRequest request)
public final RuntimeVersion getRuntimeVersion(GetRuntimeVersionRequest request)
Gets a runtime version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetRuntimeVersionRequest request =
GetRuntimeVersionRequest.newBuilder()
.setName(
RuntimeVersionName.of("[PROJECT]", "[LOCATION]", "[RUNTIME_VERSION]").toString())
.build();
RuntimeVersion response = tpuClient.getRuntimeVersion(request);
}
Parameter | |
---|---|
Name | Description |
request | GetRuntimeVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RuntimeVersion |
getRuntimeVersion(RuntimeVersionName name)
public final RuntimeVersion getRuntimeVersion(RuntimeVersionName name)
Gets a runtime version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
RuntimeVersionName name =
RuntimeVersionName.of("[PROJECT]", "[LOCATION]", "[RUNTIME_VERSION]");
RuntimeVersion response = tpuClient.getRuntimeVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | RuntimeVersionName Required. The resource name. |
Returns | |
---|---|
Type | Description |
RuntimeVersion |
getRuntimeVersion(String name)
public final RuntimeVersion getRuntimeVersion(String name)
Gets a runtime version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String name =
RuntimeVersionName.of("[PROJECT]", "[LOCATION]", "[RUNTIME_VERSION]").toString();
RuntimeVersion response = tpuClient.getRuntimeVersion(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. The resource name. |
Returns | |
---|---|
Type | Description |
RuntimeVersion |
getRuntimeVersionCallable()
public final UnaryCallable<GetRuntimeVersionRequest,RuntimeVersion> getRuntimeVersionCallable()
Gets a runtime version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
GetRuntimeVersionRequest request =
GetRuntimeVersionRequest.newBuilder()
.setName(
RuntimeVersionName.of("[PROJECT]", "[LOCATION]", "[RUNTIME_VERSION]").toString())
.build();
ApiFuture<RuntimeVersion> future = tpuClient.getRuntimeVersionCallable().futureCall(request);
// Do something.
RuntimeVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetRuntimeVersionRequest,RuntimeVersion> |
getSettings()
public final TpuSettings getSettings()
Returns | |
---|---|
Type | Description |
TpuSettings |
getStub()
public TpuStub getStub()
Returns | |
---|---|
Type | Description |
TpuStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listAcceleratorTypes(ListAcceleratorTypesRequest request)
public final TpuClient.ListAcceleratorTypesPagedResponse listAcceleratorTypes(ListAcceleratorTypesRequest request)
Lists accelerator types supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListAcceleratorTypesRequest request =
ListAcceleratorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (AcceleratorType element : tpuClient.listAcceleratorTypes(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListAcceleratorTypesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TpuClient.ListAcceleratorTypesPagedResponse |
listAcceleratorTypes(LocationName parent)
public final TpuClient.ListAcceleratorTypesPagedResponse listAcceleratorTypes(LocationName parent)
Lists accelerator types supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (AcceleratorType element : tpuClient.listAcceleratorTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListAcceleratorTypesPagedResponse |
listAcceleratorTypes(String parent)
public final TpuClient.ListAcceleratorTypesPagedResponse listAcceleratorTypes(String parent)
Lists accelerator types supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (AcceleratorType element : tpuClient.listAcceleratorTypes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListAcceleratorTypesPagedResponse |
listAcceleratorTypesCallable()
public final UnaryCallable<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse> listAcceleratorTypesCallable()
Lists accelerator types supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListAcceleratorTypesRequest request =
ListAcceleratorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListAcceleratorTypesResponse response =
tpuClient.listAcceleratorTypesCallable().call(request);
for (AcceleratorType element : response.getAcceleratorTypesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse> |
listAcceleratorTypesPagedCallable()
public final UnaryCallable<ListAcceleratorTypesRequest,TpuClient.ListAcceleratorTypesPagedResponse> listAcceleratorTypesPagedCallable()
Lists accelerator types supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListAcceleratorTypesRequest request =
ListAcceleratorTypesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<AcceleratorType> future =
tpuClient.listAcceleratorTypesPagedCallable().futureCall(request);
// Do something.
for (AcceleratorType element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAcceleratorTypesRequest,ListAcceleratorTypesPagedResponse> |
listLocations(ListLocationsRequest request)
public final TpuClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : tpuClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TpuClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = tpuClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,TpuClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future = tpuClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listNodes(ListNodesRequest request)
public final TpuClient.ListNodesPagedResponse listNodes(ListNodesRequest request)
Lists nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListNodesRequest request =
ListNodesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Node element : tpuClient.listNodes(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListNodesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TpuClient.ListNodesPagedResponse |
listNodes(LocationName parent)
public final TpuClient.ListNodesPagedResponse listNodes(LocationName parent)
Lists nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Node element : tpuClient.listNodes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListNodesPagedResponse |
listNodes(String parent)
public final TpuClient.ListNodesPagedResponse listNodes(String parent)
Lists nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Node element : tpuClient.listNodes(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListNodesPagedResponse |
listNodesCallable()
public final UnaryCallable<ListNodesRequest,ListNodesResponse> listNodesCallable()
Lists nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListNodesRequest request =
ListNodesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListNodesResponse response = tpuClient.listNodesCallable().call(request);
for (Node element : response.getNodesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListNodesRequest,ListNodesResponse> |
listNodesPagedCallable()
public final UnaryCallable<ListNodesRequest,TpuClient.ListNodesPagedResponse> listNodesPagedCallable()
Lists nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListNodesRequest request =
ListNodesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Node> future = tpuClient.listNodesPagedCallable().futureCall(request);
// Do something.
for (Node element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListNodesRequest,ListNodesPagedResponse> |
listRuntimeVersions(ListRuntimeVersionsRequest request)
public final TpuClient.ListRuntimeVersionsPagedResponse listRuntimeVersions(ListRuntimeVersionsRequest request)
Lists runtime versions supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListRuntimeVersionsRequest request =
ListRuntimeVersionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (RuntimeVersion element : tpuClient.listRuntimeVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListRuntimeVersionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TpuClient.ListRuntimeVersionsPagedResponse |
listRuntimeVersions(LocationName parent)
public final TpuClient.ListRuntimeVersionsPagedResponse listRuntimeVersions(LocationName parent)
Lists runtime versions supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (RuntimeVersion element : tpuClient.listRuntimeVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | LocationName Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListRuntimeVersionsPagedResponse |
listRuntimeVersions(String parent)
public final TpuClient.ListRuntimeVersionsPagedResponse listRuntimeVersions(String parent)
Lists runtime versions supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (RuntimeVersion element : tpuClient.listRuntimeVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. The parent resource name. |
Returns | |
---|---|
Type | Description |
TpuClient.ListRuntimeVersionsPagedResponse |
listRuntimeVersionsCallable()
public final UnaryCallable<ListRuntimeVersionsRequest,ListRuntimeVersionsResponse> listRuntimeVersionsCallable()
Lists runtime versions supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListRuntimeVersionsRequest request =
ListRuntimeVersionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListRuntimeVersionsResponse response =
tpuClient.listRuntimeVersionsCallable().call(request);
for (RuntimeVersion element : response.getRuntimeVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListRuntimeVersionsRequest,ListRuntimeVersionsResponse> |
listRuntimeVersionsPagedCallable()
public final UnaryCallable<ListRuntimeVersionsRequest,TpuClient.ListRuntimeVersionsPagedResponse> listRuntimeVersionsPagedCallable()
Lists runtime versions supported by this API.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
ListRuntimeVersionsRequest request =
ListRuntimeVersionsRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<RuntimeVersion> future =
tpuClient.listRuntimeVersionsPagedCallable().futureCall(request);
// Do something.
for (RuntimeVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListRuntimeVersionsRequest,ListRuntimeVersionsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
startNodeAsync(StartNodeRequest request)
public final OperationFuture<Node,OperationMetadata> startNodeAsync(StartNodeRequest request)
Starts a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StartNodeRequest request =
StartNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
Node response = tpuClient.startNodeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | StartNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
startNodeCallable()
public final UnaryCallable<StartNodeRequest,Operation> startNodeCallable()
Starts a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StartNodeRequest request =
StartNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
ApiFuture<Operation> future = tpuClient.startNodeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StartNodeRequest,Operation> |
startNodeOperationCallable()
public final OperationCallable<StartNodeRequest,Node,OperationMetadata> startNodeOperationCallable()
Starts a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StartNodeRequest request =
StartNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
OperationFuture<Node, OperationMetadata> future =
tpuClient.startNodeOperationCallable().futureCall(request);
// Do something.
Node response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StartNodeRequest,Node,OperationMetadata> |
stopNodeAsync(StopNodeRequest request)
public final OperationFuture<Node,OperationMetadata> stopNodeAsync(StopNodeRequest request)
Stops a node. This operation is only available with single TPU nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StopNodeRequest request =
StopNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
Node response = tpuClient.stopNodeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | StopNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
stopNodeCallable()
public final UnaryCallable<StopNodeRequest,Operation> stopNodeCallable()
Stops a node. This operation is only available with single TPU nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StopNodeRequest request =
StopNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
ApiFuture<Operation> future = tpuClient.stopNodeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<StopNodeRequest,Operation> |
stopNodeOperationCallable()
public final OperationCallable<StopNodeRequest,Node,OperationMetadata> stopNodeOperationCallable()
Stops a node. This operation is only available with single TPU nodes.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
StopNodeRequest request =
StopNodeRequest.newBuilder()
.setName(NodeName.of("[PROJECT]", "[LOCATION]", "[NODE]").toString())
.build();
OperationFuture<Node, OperationMetadata> future =
tpuClient.stopNodeOperationCallable().futureCall(request);
// Do something.
Node response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<StopNodeRequest,Node,OperationMetadata> |
updateNodeAsync(Node node, FieldMask updateMask)
public final OperationFuture<Node,OperationMetadata> updateNodeAsync(Node node, FieldMask updateMask)
Updates the configurations of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
Node node = Node.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Node response = tpuClient.updateNodeAsync(node, updateMask).get();
}
Parameters | |
---|---|
Name | Description |
node | Node Required. The node. Only fields specified in update_mask are updated. |
updateMask | FieldMask Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips]. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
updateNodeAsync(UpdateNodeRequest request)
public final OperationFuture<Node,OperationMetadata> updateNodeAsync(UpdateNodeRequest request)
Updates the configurations of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
UpdateNodeRequest request =
UpdateNodeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setNode(Node.newBuilder().build())
.build();
Node response = tpuClient.updateNodeAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | UpdateNodeRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Node,OperationMetadata> |
updateNodeCallable()
public final UnaryCallable<UpdateNodeRequest,Operation> updateNodeCallable()
Updates the configurations of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
UpdateNodeRequest request =
UpdateNodeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setNode(Node.newBuilder().build())
.build();
ApiFuture<Operation> future = tpuClient.updateNodeCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateNodeRequest,Operation> |
updateNodeOperationCallable()
public final OperationCallable<UpdateNodeRequest,Node,OperationMetadata> updateNodeOperationCallable()
Updates the configurations of a node.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (TpuClient tpuClient = TpuClient.create()) {
UpdateNodeRequest request =
UpdateNodeRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setNode(Node.newBuilder().build())
.build();
OperationFuture<Node, OperationMetadata> future =
tpuClient.updateNodeOperationCallable().futureCall(request);
// Do something.
Node response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateNodeRequest,Node,OperationMetadata> |