Class TpuSettings (2.2.6)

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 total timeout of getNode to 30 seconds:


 TpuSettings.Builder tpuSettingsBuilder = TpuSettings.newBuilder();
 tpuSettingsBuilder
     .getNodeSettings()
     .setRetrySettings(
         tpuSettingsBuilder
             .getNodeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TpuSettings tpuSettings = tpuSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > TpuSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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>

deleteNodeOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteNodeRequest,Node,OperationMetadata>

deleteNodeSettings()

public UnaryCallSettings<DeleteNodeRequest,Operation> deleteNodeSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteNodeRequest,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>

getNodeSettings()

public UnaryCallSettings<GetNodeRequest,Node> getNodeSettings()

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

Returns

Type	Description
UnaryCallSettings<GetNodeRequest,Node>

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>

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>

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>

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

ClientSettings<SettingsT>.<B>toBuilder()

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>