Class TpuStubSettings (2.38.0)

public class TpuStubSettings extends StubSettings<TpuStubSettings>

Settings class to configure an instance of TpuStub.

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
 TpuStubSettings.Builder tpuSettingsBuilder = TpuStubSettings.newBuilder();
 tpuSettingsBuilder
     .getNodeSettings()
     .setRetrySettings(
         tpuSettingsBuilder
             .getNodeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TpuStubSettings tpuSettings = tpuSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > TpuStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static TpuStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
TpuStubSettings.Builder

newBuilder(ClientContext clientContext)

public static TpuStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
TpuStubSettings.Builder

Constructors

TpuStubSettings(TpuStubSettings.Builder settingsBuilder)

protected TpuStubSettings(TpuStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderTpuStubSettings.Builder

Methods

createNodeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateNodeRequest,Node,OperationMetadata>

createNodeSettings()

public UnaryCallSettings<CreateNodeRequest,Operation> createNodeSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateNodeRequest,Operation>

createStub()

public TpuStub createStub()
Returns
TypeDescription
TpuStub
Exceptions
TypeDescription
IOException

deleteNodeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteNodeRequest,Node,OperationMetadata>

deleteNodeSettings()

public UnaryCallSettings<DeleteNodeRequest,Operation> deleteNodeSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteNodeRequest,Operation>

getAcceleratorTypeSettings()

public UnaryCallSettings<GetAcceleratorTypeRequest,AcceleratorType> getAcceleratorTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAcceleratorTypeRequest,AcceleratorType>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
TypeDescription
String
Overrides

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<GetNodeRequest,Node>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

getTensorFlowVersionSettings()

public UnaryCallSettings<GetTensorFlowVersionRequest,TensorFlowVersion> getTensorFlowVersionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTensorFlowVersionRequest,TensorFlowVersion>

listAcceleratorTypesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAcceleratorTypesRequest,ListAcceleratorTypesResponse,ListAcceleratorTypesPagedResponse>

listLocationsSettings()

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

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListNodesRequest,ListNodesResponse,ListNodesPagedResponse>

listTensorFlowVersionsSettings()

public PagedCallSettings<ListTensorFlowVersionsRequest,ListTensorFlowVersionsResponse,TpuClient.ListTensorFlowVersionsPagedResponse> listTensorFlowVersionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListTensorFlowVersionsRequest,ListTensorFlowVersionsResponse,ListTensorFlowVersionsPagedResponse>

reimageNodeOperationSettings()

public OperationCallSettings<ReimageNodeRequest,Node,OperationMetadata> reimageNodeOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ReimageNodeRequest,Node,OperationMetadata>

reimageNodeSettings()

public UnaryCallSettings<ReimageNodeRequest,Operation> reimageNodeSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReimageNodeRequest,Operation>

startNodeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StartNodeRequest,Node,OperationMetadata>

startNodeSettings()

public UnaryCallSettings<StartNodeRequest,Operation> startNodeSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartNodeRequest,Operation>

stopNodeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StopNodeRequest,Node,OperationMetadata>

stopNodeSettings()

public UnaryCallSettings<StopNodeRequest,Operation> stopNodeSettings()

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

Returns
TypeDescription
UnaryCallSettings<StopNodeRequest,Operation>

toBuilder()

public TpuStubSettings.Builder toBuilder()

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

Returns
TypeDescription
TpuStubSettings.Builder
Overrides