Class TensorboardServiceSettings (3.54.0)

Version latest

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class TensorboardServiceSettings extends ClientSettings<TensorboardServiceSettings>

Settings class to configure an instance of TensorboardServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.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 getTensorboard:

 // 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
 TensorboardServiceSettings.Builder tensorboardServiceSettingsBuilder =
     TensorboardServiceSettings.newBuilder();
 tensorboardServiceSettingsBuilder
     .getTensorboardSettings()
     .setRetrySettings(
         tensorboardServiceSettingsBuilder
             .getTensorboardSettings()
             .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());
 TensorboardServiceSettings tensorboardServiceSettings =
     tensorboardServiceSettingsBuilder.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 createTensorboard:

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

Inheritance

java.lang.Object > ClientSettings > TensorboardServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

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(TensorboardServiceStubSettings stub)

public static final TensorboardServiceSettings create(TensorboardServiceStubSettings stub)

Parameter
Name	Description
stub	TensorboardServiceStubSettings

Returns
Type	Description
TensorboardServiceSettings

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 TensorboardServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
TensorboardServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static TensorboardServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
TensorboardServiceSettings.Builder

Constructors

TensorboardServiceSettings(TensorboardServiceSettings.Builder settingsBuilder)

protected TensorboardServiceSettings(TensorboardServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	TensorboardServiceSettings.Builder

Methods

batchCreateTensorboardRunsSettings()

public UnaryCallSettings<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse> batchCreateTensorboardRunsSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse>

batchCreateTensorboardTimeSeriesSettings()

public UnaryCallSettings<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse> batchCreateTensorboardTimeSeriesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse>

batchReadTensorboardTimeSeriesDataSettings()

public UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse> batchReadTensorboardTimeSeriesDataSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse>

createTensorboardExperimentSettings()

public UnaryCallSettings<CreateTensorboardExperimentRequest,TensorboardExperiment> createTensorboardExperimentSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTensorboardExperimentRequest,TensorboardExperiment>

createTensorboardOperationSettings()

public OperationCallSettings<CreateTensorboardRequest,Tensorboard,CreateTensorboardOperationMetadata> createTensorboardOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateTensorboardRequest,Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardRunSettings()

public UnaryCallSettings<CreateTensorboardRunRequest,TensorboardRun> createTensorboardRunSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTensorboardRunRequest,TensorboardRun>

createTensorboardSettings()

public UnaryCallSettings<CreateTensorboardRequest,Operation> createTensorboardSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTensorboardRequest,Operation>

createTensorboardTimeSeriesSettings()

public UnaryCallSettings<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries> createTensorboardTimeSeriesSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

deleteTensorboardExperimentOperationSettings()

public OperationCallSettings<DeleteTensorboardExperimentRequest,Empty,DeleteOperationMetadata> deleteTensorboardExperimentOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteTensorboardExperimentRequest,Empty,DeleteOperationMetadata>

deleteTensorboardExperimentSettings()

public UnaryCallSettings<DeleteTensorboardExperimentRequest,Operation> deleteTensorboardExperimentSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTensorboardExperimentRequest,Operation>

deleteTensorboardOperationSettings()

public OperationCallSettings<DeleteTensorboardRequest,Empty,DeleteOperationMetadata> deleteTensorboardOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteTensorboardRequest,Empty,DeleteOperationMetadata>

deleteTensorboardRunOperationSettings()

public OperationCallSettings<DeleteTensorboardRunRequest,Empty,DeleteOperationMetadata> deleteTensorboardRunOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteTensorboardRunRequest,Empty,DeleteOperationMetadata>

deleteTensorboardRunSettings()

public UnaryCallSettings<DeleteTensorboardRunRequest,Operation> deleteTensorboardRunSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTensorboardRunRequest,Operation>

deleteTensorboardSettings()

public UnaryCallSettings<DeleteTensorboardRequest,Operation> deleteTensorboardSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTensorboardRequest,Operation>

deleteTensorboardTimeSeriesOperationSettings()

public OperationCallSettings<DeleteTensorboardTimeSeriesRequest,Empty,DeleteOperationMetadata> deleteTensorboardTimeSeriesOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteTensorboardTimeSeriesRequest,Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesSettings()

public UnaryCallSettings<DeleteTensorboardTimeSeriesRequest,Operation> deleteTensorboardTimeSeriesSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTensorboardTimeSeriesRequest,Operation>

exportTensorboardTimeSeriesDataSettings()

public PagedCallSettings<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse,TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse> exportTensorboardTimeSeriesDataSettings()

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

Returns
Type	Description
PagedCallSettings<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse,ExportTensorboardTimeSeriesDataPagedResponse>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

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>

getTensorboardExperimentSettings()

public UnaryCallSettings<GetTensorboardExperimentRequest,TensorboardExperiment> getTensorboardExperimentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTensorboardExperimentRequest,TensorboardExperiment>

getTensorboardRunSettings()

public UnaryCallSettings<GetTensorboardRunRequest,TensorboardRun> getTensorboardRunSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTensorboardRunRequest,TensorboardRun>

getTensorboardSettings()

public UnaryCallSettings<GetTensorboardRequest,Tensorboard> getTensorboardSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTensorboardRequest,Tensorboard>

getTensorboardTimeSeriesSettings()

public UnaryCallSettings<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries> getTensorboardTimeSeriesSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,TensorboardServiceClient.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>

listTensorboardExperimentsSettings()

public PagedCallSettings<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse,TensorboardServiceClient.ListTensorboardExperimentsPagedResponse> listTensorboardExperimentsSettings()

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

Returns
Type	Description
PagedCallSettings<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse,ListTensorboardExperimentsPagedResponse>

listTensorboardRunsSettings()

public PagedCallSettings<ListTensorboardRunsRequest,ListTensorboardRunsResponse,TensorboardServiceClient.ListTensorboardRunsPagedResponse> listTensorboardRunsSettings()

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

Returns
Type	Description
PagedCallSettings<ListTensorboardRunsRequest,ListTensorboardRunsResponse,ListTensorboardRunsPagedResponse>

listTensorboardTimeSeriesSettings()

public PagedCallSettings<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse,TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse> listTensorboardTimeSeriesSettings()

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

Returns
Type	Description
PagedCallSettings<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse,ListTensorboardTimeSeriesPagedResponse>

listTensorboardsSettings()

public PagedCallSettings<ListTensorboardsRequest,ListTensorboardsResponse,TensorboardServiceClient.ListTensorboardsPagedResponse> listTensorboardsSettings()

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

Returns
Type	Description
PagedCallSettings<ListTensorboardsRequest,ListTensorboardsResponse,ListTensorboardsPagedResponse>

readTensorboardBlobDataSettings()

public ServerStreamingCallSettings<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse> readTensorboardBlobDataSettings()

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

Returns
Type	Description
ServerStreamingCallSettings<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse>

readTensorboardSizeSettings()

public UnaryCallSettings<ReadTensorboardSizeRequest,ReadTensorboardSizeResponse> readTensorboardSizeSettings()

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

Returns
Type	Description
UnaryCallSettings<ReadTensorboardSizeRequest,ReadTensorboardSizeResponse>

readTensorboardTimeSeriesDataSettings()

public UnaryCallSettings<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse> readTensorboardTimeSeriesDataSettings()

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

Returns
Type	Description
UnaryCallSettings<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse>

readTensorboardUsageSettings()

public UnaryCallSettings<ReadTensorboardUsageRequest,ReadTensorboardUsageResponse> readTensorboardUsageSettings()

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

Returns
Type	Description
UnaryCallSettings<ReadTensorboardUsageRequest,ReadTensorboardUsageResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public TensorboardServiceSettings.Builder toBuilder()

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

Returns
Type	Description
TensorboardServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateTensorboardExperimentSettings()

public UnaryCallSettings<UpdateTensorboardExperimentRequest,TensorboardExperiment> updateTensorboardExperimentSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateTensorboardExperimentRequest,TensorboardExperiment>

updateTensorboardOperationSettings()

public OperationCallSettings<UpdateTensorboardRequest,Tensorboard,UpdateTensorboardOperationMetadata> updateTensorboardOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateTensorboardRequest,Tensorboard,UpdateTensorboardOperationMetadata>

updateTensorboardRunSettings()

public UnaryCallSettings<UpdateTensorboardRunRequest,TensorboardRun> updateTensorboardRunSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateTensorboardRunRequest,TensorboardRun>

updateTensorboardSettings()

public UnaryCallSettings<UpdateTensorboardRequest,Operation> updateTensorboardSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateTensorboardRequest,Operation>

updateTensorboardTimeSeriesSettings()

public UnaryCallSettings<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries> updateTensorboardTimeSeriesSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

writeTensorboardExperimentDataSettings()

public UnaryCallSettings<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse> writeTensorboardExperimentDataSettings()

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

Returns
Type	Description
UnaryCallSettings<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse>

writeTensorboardRunDataSettings()

public UnaryCallSettings<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse> writeTensorboardRunDataSettings()

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

Returns
Type	Description
UnaryCallSettings<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse>