@Generated("by gapic-generator-java")
Package com.google.cloud.tpu.v2alpha1
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);
}
-
Class Summary Class Description AcceleratorConfig A TPU accelerator configuration.AcceleratorConfig.Builder A TPU accelerator configuration.AcceleratorType A accelerator type that a Node can be configured with.AcceleratorType.Builder A accelerator type that a Node can be configured with.AcceleratorTypeName AcceleratorTypeName.Builder Builder for projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}.AccessConfig An access config attached to the TPU worker.AccessConfig.Builder An access config attached to the TPU worker.AttachedDisk A node-attached disk resource.AttachedDisk.Builder A node-attached disk resource.BootDiskConfig Boot disk configurations.BootDiskConfig.Builder Boot disk configurations.CloudTpuProto CreateNodeRequest Request for [CreateNode][google.cloud.tpu.v2alpha1.Tpu.CreateNode].CreateNodeRequest.Builder Request for [CreateNode][google.cloud.tpu.v2alpha1.Tpu.CreateNode].CreateQueuedResourceRequest Request for [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].CreateQueuedResourceRequest.Builder Request for [CreateQueuedResource][google.cloud.tpu.v2alpha1.Tpu.CreateQueuedResource].CustomerEncryptionKey Customer's encryption key.CustomerEncryptionKey.Builder Customer's encryption key.DeleteNodeRequest Request for [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode].DeleteNodeRequest.Builder Request for [DeleteNode][google.cloud.tpu.v2alpha1.Tpu.DeleteNode].DeleteQueuedResourceRequest Request for [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].DeleteQueuedResourceRequest.Builder Request for [DeleteQueuedResource][google.cloud.tpu.v2alpha1.Tpu.DeleteQueuedResource].GenerateServiceIdentityRequest Request for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].GenerateServiceIdentityRequest.Builder Request for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].GenerateServiceIdentityResponse Response for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].GenerateServiceIdentityResponse.Builder Response for [GenerateServiceIdentity][google.cloud.tpu.v2alpha1.Tpu.GenerateServiceIdentity].GetAcceleratorTypeRequest Request for [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].GetAcceleratorTypeRequest.Builder Request for [GetAcceleratorType][google.cloud.tpu.v2alpha1.Tpu.GetAcceleratorType].GetGuestAttributesRequest Request for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].GetGuestAttributesRequest.Builder Request for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].GetGuestAttributesResponse Response for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].GetGuestAttributesResponse.Builder Response for [GetGuestAttributes][google.cloud.tpu.v2alpha1.Tpu.GetGuestAttributes].GetNodeRequest Request for [GetNode][google.cloud.tpu.v2alpha1.Tpu.GetNode].GetNodeRequest.Builder Request for [GetNode][google.cloud.tpu.v2alpha1.Tpu.GetNode].GetQueuedResourceRequest Request for [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]GetQueuedResourceRequest.Builder Request for [GetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.GetQueuedResource]GetRuntimeVersionRequest Request for [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].GetRuntimeVersionRequest.Builder Request for [GetRuntimeVersion][google.cloud.tpu.v2alpha1.Tpu.GetRuntimeVersion].GuestAttributes A guest attributes.GuestAttributes.Builder A guest attributes.GuestAttributesEntry A guest attributes namespace/key/value entry.GuestAttributesEntry.Builder A guest attributes namespace/key/value entry.GuestAttributesValue Array of guest attribute namespace/key/value tuples.GuestAttributesValue.Builder Array of guest attribute namespace/key/value tuples.ListAcceleratorTypesRequest Request for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].ListAcceleratorTypesRequest.Builder Request for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].ListAcceleratorTypesResponse Response for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].ListAcceleratorTypesResponse.Builder Response for [ListAcceleratorTypes][google.cloud.tpu.v2alpha1.Tpu.ListAcceleratorTypes].ListNodesRequest Request for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes].ListNodesRequest.Builder Request for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes].ListNodesResponse Response for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes].ListNodesResponse.Builder Response for [ListNodes][google.cloud.tpu.v2alpha1.Tpu.ListNodes].ListQueuedResourcesRequest Request for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].ListQueuedResourcesRequest.Builder Request for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].ListQueuedResourcesResponse Response for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].ListQueuedResourcesResponse.Builder Response for [ListQueuedResources][google.cloud.tpu.v2alpha1.Tpu.ListQueuedResources].ListRuntimeVersionsRequest Request for [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions].ListRuntimeVersionsRequest.Builder Request for [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions].ListRuntimeVersionsResponse Response for [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions].ListRuntimeVersionsResponse.Builder Response for [ListRuntimeVersions][google.cloud.tpu.v2alpha1.Tpu.ListRuntimeVersions].LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.NetworkConfig Network related configurations.NetworkConfig.Builder Network related configurations.NetworkEndpoint A network endpoint over which a TPU worker can be reached.NetworkEndpoint.Builder A network endpoint over which a TPU worker can be reached.Node A TPU instance.Node.Builder A TPU instance.NodeName NodeName.Builder Builder for projects/{project}/locations/{location}/nodes/{node}.OperationMetadata Metadata describing an [Operation][google.longrunning.Operation]OperationMetadata.Builder Metadata describing an [Operation][google.longrunning.Operation]QueuedResource A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.QueuedResource.BestEffort BestEffort tier definition.QueuedResource.BestEffort.Builder BestEffort tier definition.QueuedResource.Builder A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.QueuedResource.Guaranteed Guaranteed tier definition.QueuedResource.Guaranteed.Builder Guaranteed tier definition.QueuedResource.QueueingPolicy Defines the policy of the QueuedRequest.QueuedResource.QueueingPolicy.Builder Defines the policy of the QueuedRequest.QueuedResource.Spot Spot tier definition.QueuedResource.Spot.Builder Spot tier definition.QueuedResource.Tpu Details of the TPU resource(s) being requested.QueuedResource.Tpu.Builder Details of the TPU resource(s) being requested.QueuedResource.Tpu.NodeSpec Details of the TPU node(s) being requested.QueuedResource.Tpu.NodeSpec.Builder Details of the TPU node(s) being requested.QueuedResource.Tpu.NodeSpec.MultiNodeParams Parameters to specify for multi-node QueuedResource requests.QueuedResource.Tpu.NodeSpec.MultiNodeParams.Builder Parameters to specify for multi-node QueuedResource requests.QueuedResourceName QueuedResourceName.Builder Builder for projects/{project}/locations/{location}/queuedResources/{queued_resource}.QueuedResourceState QueuedResourceState defines the details of the QueuedResource request.QueuedResourceState.AcceptedData Further data for the accepted state.QueuedResourceState.AcceptedData.Builder Further data for the accepted state.QueuedResourceState.ActiveData Further data for the active state.QueuedResourceState.ActiveData.Builder Further data for the active state.QueuedResourceState.Builder QueuedResourceState defines the details of the QueuedResource request.QueuedResourceState.CreatingData Further data for the creating state.QueuedResourceState.CreatingData.Builder Further data for the creating state.QueuedResourceState.DeletingData Further data for the deleting state.QueuedResourceState.DeletingData.Builder Further data for the deleting state.QueuedResourceState.FailedData Further data for the failed state.QueuedResourceState.FailedData.Builder Further data for the failed state.QueuedResourceState.ProvisioningData Further data for the provisioning state.QueuedResourceState.ProvisioningData.Builder Further data for the provisioning state.QueuedResourceState.SuspendedData Further data for the suspended state.QueuedResourceState.SuspendedData.Builder Further data for the suspended state.QueuedResourceState.SuspendingData Further data for the suspending state.QueuedResourceState.SuspendingData.Builder Further data for the suspending state.ResetQueuedResourceRequest Request for [ResetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.ResetQueuedResource].ResetQueuedResourceRequest.Builder Request for [ResetQueuedResource][google.cloud.tpu.v2alpha1.Tpu.ResetQueuedResource].RuntimeVersion A runtime version that a Node can be configured with.RuntimeVersion.Builder A runtime version that a Node can be configured with.RuntimeVersionName RuntimeVersionName.Builder Builder for projects/{project}/locations/{location}/runtimeVersions/{runtime_version}.SchedulingConfig Sets the scheduling options for this node.SchedulingConfig.Builder Sets the scheduling options for this node.ServiceAccount A service account.ServiceAccount.Builder A service account.ServiceIdentity The per-product per-project service identity for Cloud TPU service.ServiceIdentity.Builder The per-product per-project service identity for Cloud TPU service.ShieldedInstanceConfig A set of Shielded Instance options.ShieldedInstanceConfig.Builder A set of Shielded Instance options.SimulateMaintenanceEventRequest Request for [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent].SimulateMaintenanceEventRequest.Builder Request for [SimulateMaintenanceEvent][google.cloud.tpu.v2alpha1.Tpu.SimulateMaintenanceEvent].StartNodeRequest Request for [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode].StartNodeRequest.Builder Request for [StartNode][google.cloud.tpu.v2alpha1.Tpu.StartNode].StopNodeRequest Request for [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode].StopNodeRequest.Builder Request for [StopNode][google.cloud.tpu.v2alpha1.Tpu.StopNode].Symptom A Symptom instance.Symptom.Builder A Symptom instance.TpuClient Service Description: Manages TPU nodes and other resourcesTpuClient.ListAcceleratorTypesFixedSizeCollection TpuClient.ListAcceleratorTypesPage TpuClient.ListAcceleratorTypesPagedResponse TpuClient.ListLocationsFixedSizeCollection TpuClient.ListLocationsPage TpuClient.ListLocationsPagedResponse TpuClient.ListNodesFixedSizeCollection TpuClient.ListNodesPage TpuClient.ListNodesPagedResponse TpuClient.ListQueuedResourcesFixedSizeCollection TpuClient.ListQueuedResourcesPage TpuClient.ListQueuedResourcesPagedResponse TpuClient.ListRuntimeVersionsFixedSizeCollection TpuClient.ListRuntimeVersionsPage TpuClient.ListRuntimeVersionsPagedResponse TpuGrpc Manages TPU nodes and other resources TPU API v2alpha1TpuGrpc.TpuBlockingStub A stub to allow clients to do synchronous rpc calls to service Tpu.TpuGrpc.TpuFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service Tpu.TpuGrpc.TpuImplBase Base class for the server implementation of the service Tpu.TpuGrpc.TpuStub A stub to allow clients to do asynchronous rpc calls to service Tpu.TpuSettings Settings class to configure an instance ofTpuClient
.TpuSettings.Builder Builder for TpuSettings.UpdateNodeRequest Request for [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode].UpdateNodeRequest.Builder Request for [UpdateNode][google.cloud.tpu.v2alpha1.Tpu.UpdateNode]. -
Enum Summary Enum Description AcceleratorConfig.Type TPU type.AttachedDisk.DiskMode The different mode of the attached disk.CustomerEncryptionKey.KeyCase Node.ApiVersion TPU API Version.Node.Health Health defines the status of a TPU node as reported by Health Monitor.Node.State Represents the different states of a TPU node during its lifecycle.QueuedResource.QueueingPolicy.StartTimingConstraintsCase QueuedResource.ResourceCase QueuedResource.TierCase QueuedResourceState.State Output only state of the requestQueuedResourceState.StateDataCase QueuedResourceState.StateInitiator The initiator of the QueuedResource's SUSPENDING/SUSPENDED state.Symptom.SymptomType SymptomType represents the different types of Symptoms that a TPU can be at.