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

A accelerator type that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorType

A accelerator type that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.AcceleratorType

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

An access config attached to the TPU worker.

Protobuf type google.cloud.tpu.v2alpha1.AccessConfig

An access config attached to the TPU worker.

Protobuf type google.cloud.tpu.v2alpha1.AccessConfig

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

Protobuf type google.cloud.tpu.v2alpha1.AttachedDisk

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

Protobuf type google.cloud.tpu.v2alpha1.AttachedDisk

Request for CreateNode.

Protobuf type google.cloud.tpu.v2alpha1.CreateNodeRequest

Request for CreateNode.

Protobuf type google.cloud.tpu.v2alpha1.CreateNodeRequest

Request for CreateQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest

Request for CreateQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.CreateQueuedResourceRequest

Request for DeleteNode.

Protobuf type google.cloud.tpu.v2alpha1.DeleteNodeRequest

Request for DeleteNode.

Protobuf type google.cloud.tpu.v2alpha1.DeleteNodeRequest

Request for DeleteQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest

Request for DeleteQueuedResource.

Protobuf type google.cloud.tpu.v2alpha1.DeleteQueuedResourceRequest

Request for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest

Request for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityRequest

Response for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse

Response for GenerateServiceIdentity.

Protobuf type google.cloud.tpu.v2alpha1.GenerateServiceIdentityResponse

Request for GetAcceleratorType.

Protobuf type google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest

Request for GetAcceleratorType.

Protobuf type google.cloud.tpu.v2alpha1.GetAcceleratorTypeRequest

Request for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesRequest

Request for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesRequest

Response for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesResponse

Response for GetGuestAttributes.

Protobuf type google.cloud.tpu.v2alpha1.GetGuestAttributesResponse

Request for GetNode.

Protobuf type google.cloud.tpu.v2alpha1.GetNodeRequest

Request for GetNode.

Protobuf type google.cloud.tpu.v2alpha1.GetNodeRequest

Request for GetQueuedResource

Protobuf type google.cloud.tpu.v2alpha1.GetQueuedResourceRequest

Request for GetQueuedResource

Protobuf type google.cloud.tpu.v2alpha1.GetQueuedResourceRequest

Request for GetRuntimeVersion.

Protobuf type google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest

Request for GetRuntimeVersion.

Protobuf type google.cloud.tpu.v2alpha1.GetRuntimeVersionRequest

A guest attributes.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributes

A guest attributes.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributes

A guest attributes namespace/key/value entry.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesEntry

A guest attributes namespace/key/value entry.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesEntry

Array of guest attribute namespace/key/value tuples.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesValue

Array of guest attribute namespace/key/value tuples.

Protobuf type google.cloud.tpu.v2alpha1.GuestAttributesValue

Request for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest

Request for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesRequest

Response for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse

Response for ListAcceleratorTypes.

Protobuf type google.cloud.tpu.v2alpha1.ListAcceleratorTypesResponse

Request for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesRequest

Request for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesRequest

Response for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesResponse

Response for ListNodes.

Protobuf type google.cloud.tpu.v2alpha1.ListNodesResponse

Request for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest

Request for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesRequest

Response for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse

Response for ListQueuedResources.

Protobuf type google.cloud.tpu.v2alpha1.ListQueuedResourcesResponse

Request for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsRequest

Request for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsRequest

Response for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse

Response for ListRuntimeVersions.

Protobuf type google.cloud.tpu.v2alpha1.ListRuntimeVersionsResponse

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

Network related configurations.

Protobuf type google.cloud.tpu.v2alpha1.NetworkConfig

Network related configurations.

Protobuf type google.cloud.tpu.v2alpha1.NetworkConfig

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

Protobuf type google.cloud.tpu.v2alpha1.NetworkEndpoint

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

Protobuf type google.cloud.tpu.v2alpha1.NetworkEndpoint

A TPU instance.

Protobuf type google.cloud.tpu.v2alpha1.Node

A TPU instance.

Protobuf type google.cloud.tpu.v2alpha1.Node

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

Metadata describing an Operation

Protobuf type google.cloud.tpu.v2alpha1.OperationMetadata

Metadata describing an Operation

Protobuf type google.cloud.tpu.v2alpha1.OperationMetadata

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

BestEffort tier definition.

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

BestEffort tier definition.

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

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

Guaranteed tier definition.

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

Guaranteed tier definition.

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

Defines the policy of the QueuedRequest.

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

Defines the policy of the QueuedRequest.

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

Details of the TPU resource(s) being requested.

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

Details of the TPU resource(s) being requested.

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

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

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

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

QueuedResourceState defines the details of the QueuedResource request.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState

Further data for the accepted state.

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

Further data for the accepted state.

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

Further data for the active state.

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

Further data for the active state.

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

QueuedResourceState defines the details of the QueuedResource request.

Protobuf type google.cloud.tpu.v2alpha1.QueuedResourceState

Further data for the creating state.

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

Further data for the creating state.

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

Further data for the deleting state.

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

Further data for the deleting state.

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

Further data for the failed state.

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

Further data for the failed state.

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

Further data for the provisioning state.

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

Further data for the provisioning state.

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

Further data for the suspended state.

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

Further data for the suspended state.

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

Further data for the suspending state.

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

Further data for the suspending state.

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

A runtime version that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.RuntimeVersion

A runtime version that a Node can be configured with.

Protobuf type google.cloud.tpu.v2alpha1.RuntimeVersion

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

Sets the scheduling options for this node.

Protobuf type google.cloud.tpu.v2alpha1.SchedulingConfig

Sets the scheduling options for this node.

Protobuf type google.cloud.tpu.v2alpha1.SchedulingConfig

A service account.

Protobuf type google.cloud.tpu.v2alpha1.ServiceAccount

A service account.

Protobuf type google.cloud.tpu.v2alpha1.ServiceAccount

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

Protobuf type google.cloud.tpu.v2alpha1.ServiceIdentity

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

Protobuf type google.cloud.tpu.v2alpha1.ServiceIdentity

A set of Shielded Instance options.

Protobuf type google.cloud.tpu.v2alpha1.ShieldedInstanceConfig

A set of Shielded Instance options.

Protobuf type google.cloud.tpu.v2alpha1.ShieldedInstanceConfig

Request for SimulateMaintenanceEvent.

Protobuf type google.cloud.tpu.v2alpha1.SimulateMaintenanceEventRequest

Request for SimulateMaintenanceEvent.

Protobuf type google.cloud.tpu.v2alpha1.SimulateMaintenanceEventRequest

Request for StartNode.

Protobuf type google.cloud.tpu.v2alpha1.StartNodeRequest

Request for StartNode.

Protobuf type google.cloud.tpu.v2alpha1.StartNodeRequest

Request for StopNode.

Protobuf type google.cloud.tpu.v2alpha1.StopNodeRequest

Request for StopNode.

Protobuf type google.cloud.tpu.v2alpha1.StopNodeRequest

A Symptom instance.

Protobuf type google.cloud.tpu.v2alpha1.Symptom

A Symptom instance.

Protobuf type google.cloud.tpu.v2alpha1.Symptom

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:

1. 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.
2. 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.
3. 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.

Manages TPU nodes and other resources TPU API v2alpha1

Manages TPU nodes and other resources TPU API v2alpha1

Manages TPU nodes and other resources TPU API v2alpha1

Manages TPU nodes and other resources TPU API v2alpha1

Manages TPU nodes and other resources TPU API v2alpha1

Settings class to configure an instance of TpuClient.

The default instance has everything set to sensible defaults:

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

Builder for TpuSettings.

Request for UpdateNode.

Protobuf type google.cloud.tpu.v2alpha1.UpdateNodeRequest

Request for UpdateNode.

Protobuf type google.cloud.tpu.v2alpha1.UpdateNodeRequest

The different mode of the attached disk.

Protobuf enum google.cloud.tpu.v2alpha1.AttachedDisk.DiskMode

TPU API Version.

Protobuf enum google.cloud.tpu.v2alpha1.Node.ApiVersion

Health defines the status of a TPU node as reported by Health Monitor.

Protobuf enum google.cloud.tpu.v2alpha1.Node.Health

Represents the different states of a TPU node during its lifecycle.

Protobuf enum google.cloud.tpu.v2alpha1.Node.State

Output only state of the request

Protobuf enum google.cloud.tpu.v2alpha1.QueuedResourceState.State

SymptomType represents the different types of Symptoms that a TPU can be at.

Protobuf enum google.cloud.tpu.v2alpha1.Symptom.SymptomType