Package com.google.cloud.tpu.v2alpha1 (2.30.0)

A client to Cloud TPU API

The interfaces provided are listed below, along with usage samples.

TpuClient

Service Description: Manages TPU nodes and other resources

TPU API v2alpha1

Sample for TpuClient:


 // 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);
 }

Classes

AcceleratorConfig

A TPU accelerator configuration.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorConfig

AcceleratorConfig.Builder

A TPU accelerator configuration.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorConfig

AcceleratorType

A accelerator type that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorType

AcceleratorType.Builder

A accelerator type that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorType

AcceleratorTypeName.Builder

Builder for projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}.

AccessConfig

An access config attached to the TPU worker.

Protobuf type google.cloud.tpu.v2alpha1.AccessConfig

AccessConfig.Builder

An access config attached to the TPU worker.

Protobuf type google.cloud.tpu.v2alpha1.AccessConfig

AttachedDisk

A node-attached disk resource. Next ID: 8;

Protobuf type google.cloud.tpu.v2alpha1.AttachedDisk

AttachedDisk.Builder

A node-attached disk resource. Next ID: 8;

Protobuf type google.cloud.tpu.v2alpha1.AttachedDisk

BootDiskConfig

Boot disk configurations.

Protobuf type google.cloud.tpu.v2alpha1.BootDiskConfig

BootDiskConfig.Builder

Boot disk configurations.

Protobuf type google.cloud.tpu.v2alpha1.BootDiskConfig

CreateNodeRequest

Request for CreateNode.

Protobuf type google.cloud.tpu.v2alpha1.CreateNodeRequest

CreateNodeRequest.Builder

Request for CreateNode.

Protobuf type google.cloud.tpu.v2alpha1.CreateNodeRequest

CreateQueuedResourceRequest

Request for CreateQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest

CreateQueuedResourceRequest.Builder

Request for CreateQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest

CustomerEncryptionKey

Customer's encryption key.

Protobuf type google.cloud.tpu.v2alpha1.CustomerEncryptionKey

CustomerEncryptionKey.Builder

Customer's encryption key.

Protobuf type google.cloud.tpu.v2alpha1.CustomerEncryptionKey

DeleteNodeRequest

Request for DeleteNode.

Protobuf type google.cloud.tpu.v2alpha1.DeleteNodeRequest

DeleteNodeRequest.Builder

Request for DeleteNode.

Protobuf type google.cloud.tpu.v2alpha1.DeleteNodeRequest

DeleteQueuedResourceRequest

Request for DeleteQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest

DeleteQueuedResourceRequest.Builder

Request for DeleteQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest

GenerateServiceIdentityRequest

Request for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest

GenerateServiceIdentityRequest.Builder

Request for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest

GenerateServiceIdentityResponse

Response for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse

GenerateServiceIdentityResponse.Builder

Response for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse

GetAcceleratorTypeRequest

Request for GetAcceleratorType.

Protobuf type google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest

GetAcceleratorTypeRequest.Builder

Request for GetAcceleratorType.

Protobuf type google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest

GetGuestAttributesRequest

Request for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesRequest

GetGuestAttributesRequest.Builder

Request for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesRequest

GetGuestAttributesResponse

Response for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesResponse

GetGuestAttributesResponse.Builder

Response for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesResponse

GetNodeRequest

Request for GetNode.

Protobuf type google.cloud.tpu.v2alpha1.GetNodeRequest

GetNodeRequest.Builder

Request for GetNode.

Protobuf type google.cloud.tpu.v2alpha1.GetNodeRequest

GetQueuedResourceRequest

Request for GetQueuedResource

Protobuf type google.cloud.tpu.v2alpha1.GetQueuedResourceRequest

GetQueuedResourceRequest.Builder

Request for GetQueuedResource

Protobuf type google.cloud.tpu.v2alpha1.GetQueuedResourceRequest

GetRuntimeVersionRequest

Request for GetRuntimeVersion.

Protobuf type google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest

GetRuntimeVersionRequest.Builder

Request for GetRuntimeVersion.

Protobuf type google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest

GuestAttributes

A guest attributes.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributes

GuestAttributes.Builder

A guest attributes.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributes

GuestAttributesEntry

A guest attributes namespace/key/value entry.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesEntry

GuestAttributesEntry.Builder

A guest attributes namespace/key/value entry.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesEntry

GuestAttributesValue

Array of guest attribute namespace/key/value tuples.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesValue

GuestAttributesValue.Builder

Array of guest attribute namespace/key/value tuples.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesValue

ListAcceleratorTypesRequest

Request for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest

ListAcceleratorTypesRequest.Builder

Request for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest

ListAcceleratorTypesResponse

Response for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse

ListAcceleratorTypesResponse.Builder

Response for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse

ListNodesRequest

Request for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesRequest

ListNodesRequest.Builder

Request for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesRequest

ListNodesResponse

Response for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesResponse

ListNodesResponse.Builder

Response for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesResponse

ListQueuedResourcesRequest

Request for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest

ListQueuedResourcesRequest.Builder

Request for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest

ListQueuedResourcesResponse

Response for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse

ListQueuedResourcesResponse.Builder

Response for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse

ListRuntimeVersionsRequest

Request for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsRequest

ListRuntimeVersionsRequest.Builder

Request for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsRequest

ListRuntimeVersionsResponse

Response for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse

ListRuntimeVersionsResponse.Builder

Response for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse

LocationName.Builder

Builder for projects/{project}/locations/{location}.

NetworkConfig

Network related configurations.

Protobuf type google.cloud.tpu.v2alpha1.NetworkConfig

NetworkConfig.Builder

Network related configurations.

Protobuf type google.cloud.tpu.v2alpha1.NetworkConfig

NetworkEndpoint

A network endpoint over which a TPU worker can be reached.

Protobuf type google.cloud.tpu.v2alpha1.NetworkEndpoint

NetworkEndpoint.Builder

A network endpoint over which a TPU worker can be reached.

Protobuf type google.cloud.tpu.v2alpha1.NetworkEndpoint

Node

A TPU instance.

Protobuf type google.cloud.tpu.v2alpha1.Node

Node.Builder

A TPU instance.

Protobuf type google.cloud.tpu.v2alpha1.Node

NodeName.Builder

Builder for projects/{project}/locations/{location}/nodes/{node}.

OperationMetadata

Metadata describing an Operation

Protobuf type google.cloud.tpu.v2alpha1.OperationMetadata

OperationMetadata.Builder

Metadata describing an Operation

Protobuf type google.cloud.tpu.v2alpha1.OperationMetadata

QueuedResource

A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource.BestEffort

BestEffort tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.BestEffort

QueuedResource.BestEffort.Builder

BestEffort tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.BestEffort

QueuedResource.Builder

A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource

QueuedResource.Guaranteed

Guaranteed tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Guaranteed

QueuedResource.Guaranteed.Builder

Guaranteed tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Guaranteed

QueuedResource.QueueingPolicy

Defines the policy of the QueuedRequest.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.QueueingPolicy

QueuedResource.QueueingPolicy.Builder

Defines the policy of the QueuedRequest.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.QueueingPolicy

QueuedResource.Spot

Spot tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Spot

QueuedResource.Spot.Builder

Spot tier definition.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Spot

QueuedResource.Tpu

Details of the TPU resource(s) being requested.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu

QueuedResource.Tpu.Builder

Details of the TPU resource(s) being requested.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu

QueuedResource.Tpu.NodeSpec

Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec

QueuedResource.Tpu.NodeSpec.Builder

Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec

QueuedResource.Tpu.NodeSpec.MultiNodeParams

Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams

QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder

Protobuf type google.cloud.tpu.v2alpha1.QueuedResource.Tpu.NodeSpec.MultiNodeParams

QueuedResourceName

QueuedResourceName.Builder

Builder for projects/{project}/locations/{location}/queuedResources/{queued_resource}.

QueuedResourceState

QueuedResourceState defines the details of the QueuedResource request.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState

QueuedResourceState.AcceptedData

Further data for the accepted state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.AcceptedData

QueuedResourceState.AcceptedData.Builder

Further data for the accepted state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.AcceptedData

QueuedResourceState.ActiveData

Further data for the active state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.ActiveData

QueuedResourceState.ActiveData.Builder

Further data for the active state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.ActiveData

QueuedResourceState.Builder

QueuedResourceState defines the details of the QueuedResource request.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState

QueuedResourceState.CreatingData

Further data for the creating state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.CreatingData

QueuedResourceState.CreatingData.Builder

Further data for the creating state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.CreatingData

QueuedResourceState.DeletingData

Further data for the deleting state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.DeletingData

QueuedResourceState.DeletingData.Builder

Further data for the deleting state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.DeletingData

QueuedResourceState.FailedData

Further data for the failed state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.FailedData

QueuedResourceState.FailedData.Builder

Further data for the failed state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.FailedData

QueuedResourceState.ProvisioningData

Further data for the provisioning state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.ProvisioningData

QueuedResourceState.ProvisioningData.Builder

Further data for the provisioning state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.ProvisioningData

QueuedResourceState.SuspendedData

Further data for the suspended state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.SuspendedData

QueuedResourceState.SuspendedData.Builder

Further data for the suspended state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.SuspendedData

QueuedResourceState.SuspendingData

Further data for the suspending state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.SuspendingData

QueuedResourceState.SuspendingData.Builder

Further data for the suspending state.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState.SuspendingData

ResetQueuedResourceRequest

Request for ResetQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.ResetQueuedResourceRequest

ResetQueuedResourceRequest.Builder

Request for ResetQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.ResetQueuedResourceRequest

RuntimeVersion

A runtime version that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.RuntimeVersion

RuntimeVersion.Builder

A runtime version that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.RuntimeVersion

RuntimeVersionName

RuntimeVersionName.Builder

Builder for projects/{project}/locations/{location}/runtimeVersions/{runtime_version}.

SchedulingConfig

Sets the scheduling options for this node.

Protobuf type google.cloud.tpu.v2alpha1.SchedulingConfig

SchedulingConfig.Builder

Sets the scheduling options for this node.

Protobuf type google.cloud.tpu.v2alpha1.SchedulingConfig

ServiceAccount

A service account.

Protobuf type google.cloud.tpu.v2alpha1.ServiceAccount

ServiceAccount.Builder

A service account.

Protobuf type google.cloud.tpu.v2alpha1.ServiceAccount

ServiceIdentity

The per-product per-project service identity for Cloud TPU service.

Protobuf type google.cloud.tpu.v2alpha1.ServiceIdentity

ServiceIdentity.Builder

The per-product per-project service identity for Cloud TPU service.

Protobuf type google.cloud.tpu.v2alpha1.ServiceIdentity

ShieldedInstanceConfig

A set of Shielded Instance options.

Protobuf type google.cloud.tpu.v2alpha1.ShieldedInstanceConfig

ShieldedInstanceConfig.Builder

A set of Shielded Instance options.

Protobuf type google.cloud.tpu.v2alpha1.ShieldedInstanceConfig

SimulateMaintenanceEventRequest

Request for SimulateMaintenanceEvent.

Protobuf type google.cloud.tpu.v2alpha1.SimulateMaintenanceEventRequest

SimulateMaintenanceEventRequest.Builder

Request for SimulateMaintenanceEvent.

Protobuf type google.cloud.tpu.v2alpha1.SimulateMaintenanceEventRequest

StartNodeRequest

Request for StartNode.

Protobuf type google.cloud.tpu.v2alpha1.StartNodeRequest

StartNodeRequest.Builder

Request for StartNode.

Protobuf type google.cloud.tpu.v2alpha1.StartNodeRequest

StopNodeRequest

Request for StopNode.

Protobuf type google.cloud.tpu.v2alpha1.StopNodeRequest

StopNodeRequest.Builder

Request for StopNode.

Protobuf type google.cloud.tpu.v2alpha1.StopNodeRequest

Symptom

A Symptom instance.

Protobuf type google.cloud.tpu.v2alpha1.Symptom

Symptom.Builder

A Symptom instance.

Protobuf type google.cloud.tpu.v2alpha1.Symptom

TpuClient

Service Description: Manages TPU nodes and other resources

TPU API v2alpha1

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);

Please refer to the GitHub repository's samples for more quickstart code snippets.

The default service address (tpu.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getNode to 30 seconds:


 // 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.Builder tpuSettingsBuilder = TpuSettings.newBuilder();
 tpuSettingsBuilder
     .getNodeSettings()
     .setRetrySettings(
         tpuSettingsBuilder
             .getNodeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TpuSettings tpuSettings = tpuSettingsBuilder.build();