Class TpuSettings (2.54.0) 

public class TpuSettings extends ClientSettings<TpuSettings>

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 RetrySettings of getNode:


 // 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()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 TpuSettings tpuSettings = tpuSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createNode:


 // 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();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 tpuSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > TpuSettings

Static Methods

create(TpuStubSettings stub)

public static final TpuSettings create(TpuStubSettings stub)
Parameter
Name Description
stub TpuStubSettings
Returns
Type Description
TpuSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static TpuSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
TpuSettings.Builder

newBuilder(ClientContext clientContext)

public static TpuSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
TpuSettings.Builder

Constructors

TpuSettings(TpuSettings.Builder settingsBuilder)

protected TpuSettings(TpuSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder TpuSettings.Builder

Methods

createNodeOperationSettings()

public OperationCallSettings<CreateNodeRequest,Node,OperationMetadata> createNodeOperationSettings()

Returns the object with the settings used for calls to createNode.

Returns
Type Description
OperationCallSettings<CreateNodeRequest,Node,OperationMetadata>

createNodeSettings()

public UnaryCallSettings<CreateNodeRequest,Operation> createNodeSettings()

Returns the object with the settings used for calls to createNode.

Returns
Type Description
UnaryCallSettings<CreateNodeRequest,Operation>

createQueuedResourceOperationSettings()

public OperationCallSettings<CreateQueuedResourceRequest,QueuedResource,OperationMetadata> createQueuedResourceOperationSettings()

Returns the object with the settings used for calls to createQueuedResource.

Returns
Type Description
OperationCallSettings<CreateQueuedResourceRequest,QueuedResource,OperationMetadata>

createQueuedResourceSettings()

public UnaryCallSettings<CreateQueuedResourceRequest,Operation> createQueuedResourceSettings()

Returns the object with the settings used for calls to createQueuedResource.

Returns
Type Description
UnaryCallSettings<CreateQueuedResourceRequest,Operation>

deleteNodeOperationSettings()

public OperationCallSettings<DeleteNodeRequest,Empty,OperationMetadata> deleteNodeOperationSettings()

Returns the object with the settings used for calls to deleteNode.

Returns
Type Description
OperationCallSettings<DeleteNodeRequest,Empty,OperationMetadata>

deleteNodeSettings()

public UnaryCallSettings<DeleteNodeRequest,Operation> deleteNodeSettings()

Returns the object with the settings used for calls to deleteNode.

Returns
Type Description
UnaryCallSettings<DeleteNodeRequest,Operation>

deleteQueuedResourceOperationSettings()

public OperationCallSettings<DeleteQueuedResourceRequest,QueuedResource,OperationMetadata> deleteQueuedResourceOperationSettings()

Returns the object with the settings used for calls to deleteQueuedResource.

Returns
Type Description
OperationCallSettings<DeleteQueuedResourceRequest,QueuedResource,OperationMetadata>

deleteQueuedResourceSettings()

public UnaryCallSettings<DeleteQueuedResourceRequest,Operation> deleteQueuedResourceSettings()

Returns the object with the settings used for calls to deleteQueuedResource.

Returns
Type Description
UnaryCallSettings<DeleteQueuedResourceRequest,Operation>

generateServiceIdentitySettings()

public UnaryCallSettings<GenerateServiceIdentityRequest,GenerateServiceIdentityResponse> generateServiceIdentitySettings()

Returns the object with the settings used for calls to generateServiceIdentity.

Returns
Type Description
UnaryCallSettings<GenerateServiceIdentityRequest,GenerateServiceIdentityResponse>

getAcceleratorTypeSettings()

public UnaryCallSettings<GetAcceleratorTypeRequest,AcceleratorType> getAcceleratorTypeSettings()

Returns the object with the settings used for calls to getAcceleratorType.

Returns
Type Description
UnaryCallSettings<GetAcceleratorTypeRequest,AcceleratorType>

getGuestAttributesSettings()

public UnaryCallSettings<GetGuestAttributesRequest,GetGuestAttributesResponse> getGuestAttributesSettings()

Returns the object with the settings used for calls to getGuestAttributes.

Returns
Type Description
UnaryCallSettings<GetGuestAttributesRequest,GetGuestAttributesResponse>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getNodeSettings()

public UnaryCallSettings<GetNodeRequest,Node> getNodeSettings()

Returns the object with the settings used for calls to getNode.

Returns
Type Description
UnaryCallSettings<GetNodeRequest,Node>

getQueuedResourceSettings()

public UnaryCallSettings<GetQueuedResourceRequest,QueuedResource> getQueuedResourceSettings()

Returns the object with the settings used for calls to getQueuedResource.

Returns
Type Description
UnaryCallSettings<GetQueuedResourceRequest,QueuedResource>

getRuntimeVersionSettings()

public UnaryCallSettings<GetRuntimeVersionRequest,RuntimeVersion> getRuntimeVersionSettings()

Returns the object with the settings used for calls to getRuntimeVersion.

Returns
Type Description
UnaryCallSettings<GetRuntimeVersionRequest,RuntimeVersion>

listAcceleratorTypesSettings()

public PagedCallSettings<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse,TpuClient.ListAcceleratorTypesPagedResponse> listAcceleratorTypesSettings()

Returns the object with the settings used for calls to listAcceleratorTypes.

Returns
Type Description
PagedCallSettings<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse,ListAcceleratorTypesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,TpuClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listNodesSettings()

public PagedCallSettings<ListNodesRequest,ListNodesResponse,TpuClient.ListNodesPagedResponse> listNodesSettings()

Returns the object with the settings used for calls to listNodes.

Returns
Type Description
PagedCallSettings<ListNodesRequest,ListNodesResponse,ListNodesPagedResponse>

listQueuedResourcesSettings()

public PagedCallSettings<ListQueuedResourcesRequest,ListQueuedResourcesResponse,TpuClient.ListQueuedResourcesPagedResponse> listQueuedResourcesSettings()

Returns the object with the settings used for calls to listQueuedResources.

Returns
Type Description
PagedCallSettings<ListQueuedResourcesRequest,ListQueuedResourcesResponse,ListQueuedResourcesPagedResponse>

listRuntimeVersionsSettings()

public PagedCallSettings<ListRuntimeVersionsRequest,ListRuntimeVersionsResponse,TpuClient.ListRuntimeVersionsPagedResponse> listRuntimeVersionsSettings()

Returns the object with the settings used for calls to listRuntimeVersions.

Returns
Type Description
PagedCallSettings<ListRuntimeVersionsRequest,ListRuntimeVersionsResponse,ListRuntimeVersionsPagedResponse>

resetQueuedResourceOperationSettings()

public OperationCallSettings<ResetQueuedResourceRequest,QueuedResource,OperationMetadata> resetQueuedResourceOperationSettings()

Returns the object with the settings used for calls to resetQueuedResource.

Returns
Type Description
OperationCallSettings<ResetQueuedResourceRequest,QueuedResource,OperationMetadata>

resetQueuedResourceSettings()

public UnaryCallSettings<ResetQueuedResourceRequest,Operation> resetQueuedResourceSettings()

Returns the object with the settings used for calls to resetQueuedResource.

Returns
Type Description
UnaryCallSettings<ResetQueuedResourceRequest,Operation>

simulateMaintenanceEventOperationSettings()

public OperationCallSettings<SimulateMaintenanceEventRequest,Node,OperationMetadata> simulateMaintenanceEventOperationSettings()

Returns the object with the settings used for calls to simulateMaintenanceEvent.

Returns
Type Description
OperationCallSettings<SimulateMaintenanceEventRequest,Node,OperationMetadata>

simulateMaintenanceEventSettings()

public UnaryCallSettings<SimulateMaintenanceEventRequest,Operation> simulateMaintenanceEventSettings()

Returns the object with the settings used for calls to simulateMaintenanceEvent.

Returns
Type Description
UnaryCallSettings<SimulateMaintenanceEventRequest,Operation>

startNodeOperationSettings()

public OperationCallSettings<StartNodeRequest,Node,OperationMetadata> startNodeOperationSettings()

Returns the object with the settings used for calls to startNode.

Returns
Type Description
OperationCallSettings<StartNodeRequest,Node,OperationMetadata>

startNodeSettings()

public UnaryCallSettings<StartNodeRequest,Operation> startNodeSettings()

Returns the object with the settings used for calls to startNode.

Returns
Type Description
UnaryCallSettings<StartNodeRequest,Operation>

stopNodeOperationSettings()

public OperationCallSettings<StopNodeRequest,Node,OperationMetadata> stopNodeOperationSettings()

Returns the object with the settings used for calls to stopNode.

Returns
Type Description
OperationCallSettings<StopNodeRequest,Node,OperationMetadata>

stopNodeSettings()

public UnaryCallSettings<StopNodeRequest,Operation> stopNodeSettings()

Returns the object with the settings used for calls to stopNode.

Returns
Type Description
UnaryCallSettings<StopNodeRequest,Operation>

toBuilder()

public TpuSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
TpuSettings.Builder
Overrides

updateNodeOperationSettings()

public OperationCallSettings<UpdateNodeRequest,Node,OperationMetadata> updateNodeOperationSettings()

Returns the object with the settings used for calls to updateNode.

Returns
Type Description
OperationCallSettings<UpdateNodeRequest,Node,OperationMetadata>

updateNodeSettings()

public UnaryCallSettings<UpdateNodeRequest,Operation> updateNodeSettings()

Returns the object with the settings used for calls to updateNode.

Returns
Type Description
UnaryCallSettings<UpdateNodeRequest,Operation>