Package com.google.cloud.aiplatform.v1
Class TensorboardServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<TensorboardServiceSettings>
com.google.cloud.aiplatform.v1.TensorboardServiceSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](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 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)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
tensorboardServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for TensorboardServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTensorboardServiceSettings(TensorboardServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to batchCreateTensorboardRuns.Returns the object with the settings used for calls to batchCreateTensorboardTimeSeries.UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse> Returns the object with the settings used for calls to batchReadTensorboardTimeSeriesData.static final TensorboardServiceSettingsReturns the object with the settings used for calls to createTensorboardExperiment.Returns the object with the settings used for calls to createTensorboard.Returns the object with the settings used for calls to createTensorboardRun.Returns the object with the settings used for calls to createTensorboard.Returns the object with the settings used for calls to createTensorboardTimeSeries.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 TransportChannelProviderOperationCallSettings<DeleteTensorboardExperimentRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardExperiment.Returns the object with the settings used for calls to deleteTensorboardExperiment.OperationCallSettings<DeleteTensorboardRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboard.OperationCallSettings<DeleteTensorboardRunRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardRun.Returns the object with the settings used for calls to deleteTensorboardRun.Returns the object with the settings used for calls to deleteTensorboard.OperationCallSettings<DeleteTensorboardTimeSeriesRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardTimeSeries.Returns the object with the settings used for calls to deleteTensorboardTimeSeries.PagedCallSettings<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse, TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse> Returns the object with the settings used for calls to exportTensorboardTimeSeriesData.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getTensorboardExperiment.Returns the object with the settings used for calls to getTensorboardRun.Returns the object with the settings used for calls to getTensorboard.Returns the object with the settings used for calls to getTensorboardTimeSeries.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, TensorboardServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse, TensorboardServiceClient.ListTensorboardExperimentsPagedResponse> Returns the object with the settings used for calls to listTensorboardExperiments.PagedCallSettings<ListTensorboardRunsRequest,ListTensorboardRunsResponse, TensorboardServiceClient.ListTensorboardRunsPagedResponse> Returns the object with the settings used for calls to listTensorboardRuns.PagedCallSettings<ListTensorboardsRequest,ListTensorboardsResponse, TensorboardServiceClient.ListTensorboardsPagedResponse> Returns the object with the settings used for calls to listTensorboards.PagedCallSettings<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse, TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse> Returns the object with the settings used for calls to listTensorboardTimeSeries.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to readTensorboardBlobData.Returns the object with the settings used for calls to readTensorboardSize.Returns the object with the settings used for calls to readTensorboardTimeSeriesData.Returns the object with the settings used for calls to readTensorboardUsage.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateTensorboardExperiment.Returns the object with the settings used for calls to updateTensorboard.Returns the object with the settings used for calls to updateTensorboardRun.Returns the object with the settings used for calls to updateTensorboard.Returns the object with the settings used for calls to updateTensorboardTimeSeries.Returns the object with the settings used for calls to writeTensorboardExperimentData.Returns the object with the settings used for calls to writeTensorboardRunData.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
-
TensorboardServiceSettings
protected TensorboardServiceSettings(TensorboardServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createTensorboardSettings
Returns the object with the settings used for calls to createTensorboard. -
createTensorboardOperationSettings
public OperationCallSettings<CreateTensorboardRequest,Tensorboard, createTensorboardOperationSettings()CreateTensorboardOperationMetadata> Returns the object with the settings used for calls to createTensorboard. -
getTensorboardSettings
Returns the object with the settings used for calls to getTensorboard. -
updateTensorboardSettings
Returns the object with the settings used for calls to updateTensorboard. -
updateTensorboardOperationSettings
public OperationCallSettings<UpdateTensorboardRequest,Tensorboard, updateTensorboardOperationSettings()UpdateTensorboardOperationMetadata> Returns the object with the settings used for calls to updateTensorboard. -
listTensorboardsSettings
public PagedCallSettings<ListTensorboardsRequest,ListTensorboardsResponse, listTensorboardsSettings()TensorboardServiceClient.ListTensorboardsPagedResponse> Returns the object with the settings used for calls to listTensorboards. -
deleteTensorboardSettings
Returns the object with the settings used for calls to deleteTensorboard. -
deleteTensorboardOperationSettings
public OperationCallSettings<DeleteTensorboardRequest,com.google.protobuf.Empty, deleteTensorboardOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboard. -
readTensorboardUsageSettings
public UnaryCallSettings<ReadTensorboardUsageRequest,ReadTensorboardUsageResponse> readTensorboardUsageSettings()Returns the object with the settings used for calls to readTensorboardUsage. -
readTensorboardSizeSettings
public UnaryCallSettings<ReadTensorboardSizeRequest,ReadTensorboardSizeResponse> readTensorboardSizeSettings()Returns the object with the settings used for calls to readTensorboardSize. -
createTensorboardExperimentSettings
public UnaryCallSettings<CreateTensorboardExperimentRequest,TensorboardExperiment> createTensorboardExperimentSettings()Returns the object with the settings used for calls to createTensorboardExperiment. -
getTensorboardExperimentSettings
public UnaryCallSettings<GetTensorboardExperimentRequest,TensorboardExperiment> getTensorboardExperimentSettings()Returns the object with the settings used for calls to getTensorboardExperiment. -
updateTensorboardExperimentSettings
public UnaryCallSettings<UpdateTensorboardExperimentRequest,TensorboardExperiment> updateTensorboardExperimentSettings()Returns the object with the settings used for calls to updateTensorboardExperiment. -
listTensorboardExperimentsSettings
public PagedCallSettings<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse, listTensorboardExperimentsSettings()TensorboardServiceClient.ListTensorboardExperimentsPagedResponse> Returns the object with the settings used for calls to listTensorboardExperiments. -
deleteTensorboardExperimentSettings
public UnaryCallSettings<DeleteTensorboardExperimentRequest,Operation> deleteTensorboardExperimentSettings()Returns the object with the settings used for calls to deleteTensorboardExperiment. -
deleteTensorboardExperimentOperationSettings
public OperationCallSettings<DeleteTensorboardExperimentRequest,com.google.protobuf.Empty, deleteTensorboardExperimentOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardExperiment. -
createTensorboardRunSettings
Returns the object with the settings used for calls to createTensorboardRun. -
batchCreateTensorboardRunsSettings
public UnaryCallSettings<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse> batchCreateTensorboardRunsSettings()Returns the object with the settings used for calls to batchCreateTensorboardRuns. -
getTensorboardRunSettings
Returns the object with the settings used for calls to getTensorboardRun. -
updateTensorboardRunSettings
Returns the object with the settings used for calls to updateTensorboardRun. -
listTensorboardRunsSettings
public PagedCallSettings<ListTensorboardRunsRequest,ListTensorboardRunsResponse, listTensorboardRunsSettings()TensorboardServiceClient.ListTensorboardRunsPagedResponse> Returns the object with the settings used for calls to listTensorboardRuns. -
deleteTensorboardRunSettings
Returns the object with the settings used for calls to deleteTensorboardRun. -
deleteTensorboardRunOperationSettings
public OperationCallSettings<DeleteTensorboardRunRequest,com.google.protobuf.Empty, deleteTensorboardRunOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardRun. -
batchCreateTensorboardTimeSeriesSettings
public UnaryCallSettings<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse> batchCreateTensorboardTimeSeriesSettings()Returns the object with the settings used for calls to batchCreateTensorboardTimeSeries. -
createTensorboardTimeSeriesSettings
public UnaryCallSettings<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries> createTensorboardTimeSeriesSettings()Returns the object with the settings used for calls to createTensorboardTimeSeries. -
getTensorboardTimeSeriesSettings
public UnaryCallSettings<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries> getTensorboardTimeSeriesSettings()Returns the object with the settings used for calls to getTensorboardTimeSeries. -
updateTensorboardTimeSeriesSettings
public UnaryCallSettings<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries> updateTensorboardTimeSeriesSettings()Returns the object with the settings used for calls to updateTensorboardTimeSeries. -
listTensorboardTimeSeriesSettings
public PagedCallSettings<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse, listTensorboardTimeSeriesSettings()TensorboardServiceClient.ListTensorboardTimeSeriesPagedResponse> Returns the object with the settings used for calls to listTensorboardTimeSeries. -
deleteTensorboardTimeSeriesSettings
public UnaryCallSettings<DeleteTensorboardTimeSeriesRequest,Operation> deleteTensorboardTimeSeriesSettings()Returns the object with the settings used for calls to deleteTensorboardTimeSeries. -
deleteTensorboardTimeSeriesOperationSettings
public OperationCallSettings<DeleteTensorboardTimeSeriesRequest,com.google.protobuf.Empty, deleteTensorboardTimeSeriesOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTensorboardTimeSeries. -
batchReadTensorboardTimeSeriesDataSettings
public UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse> batchReadTensorboardTimeSeriesDataSettings()Returns the object with the settings used for calls to batchReadTensorboardTimeSeriesData. -
readTensorboardTimeSeriesDataSettings
public UnaryCallSettings<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse> readTensorboardTimeSeriesDataSettings()Returns the object with the settings used for calls to readTensorboardTimeSeriesData. -
readTensorboardBlobDataSettings
public ServerStreamingCallSettings<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse> readTensorboardBlobDataSettings()Returns the object with the settings used for calls to readTensorboardBlobData. -
writeTensorboardExperimentDataSettings
public UnaryCallSettings<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse> writeTensorboardExperimentDataSettings()Returns the object with the settings used for calls to writeTensorboardExperimentData. -
writeTensorboardRunDataSettings
public UnaryCallSettings<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse> writeTensorboardRunDataSettings()Returns the object with the settings used for calls to writeTensorboardRunData. -
exportTensorboardTimeSeriesDataSettings
public PagedCallSettings<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse, exportTensorboardTimeSeriesDataSettings()TensorboardServiceClient.ExportTensorboardTimeSeriesDataPagedResponse> Returns the object with the settings used for calls to exportTensorboardTimeSeriesData. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()TensorboardServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final TensorboardServiceSettings create(TensorboardServiceStubSettings stub) throws IOException - 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<TensorboardServiceSettings>
-