Package com.google.cloud.tpu.v1
Class 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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) 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)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
tpuSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final TpuSettingscreate(TpuStubSettings stub) Returns the object with the settings used for calls to createNode.Returns the object with the settings used for calls to createNode.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to deleteNode.Returns the object with the settings used for calls to deleteNode.Returns the object with the settings used for calls to getAcceleratorType.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getNode.Returns the object with the settings used for calls to getTensorFlowVersion.PagedCallSettings<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse, TpuClient.ListAcceleratorTypesPagedResponse> Returns the object with the settings used for calls to listAcceleratorTypes.Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listNodes.PagedCallSettings<ListTensorFlowVersionsRequest,ListTensorFlowVersionsResponse, TpuClient.ListTensorFlowVersionsPagedResponse> Returns the object with the settings used for calls to listTensorFlowVersions.static TpuSettings.BuilderReturns a new builder for this class.static TpuSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to reimageNode.Returns the object with the settings used for calls to reimageNode.Returns the object with the settings used for calls to startNode.Returns the object with the settings used for calls to startNode.Returns the object with the settings used for calls to stopNode.Returns the object with the settings used for calls to stopNode.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
TpuSettings
- Throws:
IOException
-
-
Method Details
-
listNodesSettings
public PagedCallSettings<ListNodesRequest,ListNodesResponse, listNodesSettings()TpuClient.ListNodesPagedResponse> Returns the object with the settings used for calls to listNodes. -
getNodeSettings
Returns the object with the settings used for calls to getNode. -
createNodeSettings
Returns the object with the settings used for calls to createNode. -
createNodeOperationSettings
public OperationCallSettings<CreateNodeRequest,Node, createNodeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createNode. -
deleteNodeSettings
Returns the object with the settings used for calls to deleteNode. -
deleteNodeOperationSettings
public OperationCallSettings<DeleteNodeRequest,Node, deleteNodeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteNode. -
reimageNodeSettings
Returns the object with the settings used for calls to reimageNode. -
reimageNodeOperationSettings
public OperationCallSettings<ReimageNodeRequest,Node, reimageNodeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to reimageNode. -
stopNodeSettings
Returns the object with the settings used for calls to stopNode. -
stopNodeOperationSettings
Returns the object with the settings used for calls to stopNode. -
startNodeSettings
Returns the object with the settings used for calls to startNode. -
startNodeOperationSettings
Returns the object with the settings used for calls to startNode. -
listTensorFlowVersionsSettings
public PagedCallSettings<ListTensorFlowVersionsRequest,ListTensorFlowVersionsResponse, listTensorFlowVersionsSettings()TpuClient.ListTensorFlowVersionsPagedResponse> Returns the object with the settings used for calls to listTensorFlowVersions. -
getTensorFlowVersionSettings
public UnaryCallSettings<GetTensorFlowVersionRequest,TensorFlowVersion> getTensorFlowVersionSettings()Returns the object with the settings used for calls to getTensorFlowVersion. -
listAcceleratorTypesSettings
public PagedCallSettings<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse, listAcceleratorTypesSettings()TpuClient.ListAcceleratorTypesPagedResponse> Returns the object with the settings used for calls to listAcceleratorTypes. -
getAcceleratorTypeSettings
Returns the object with the settings used for calls to getAcceleratorType. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()TpuClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<TpuSettings>
-