Class TensorboardServiceStubSettings (3.28.0)

public class TensorboardServiceStubSettings extends StubSettings<TensorboardServiceStubSettings>

Settings class to configure an instance of TensorboardServiceStub.

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 total timeout of getTensorboard 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
 TensorboardServiceStubSettings.Builder tensorboardServiceSettingsBuilder =
     TensorboardServiceStubSettings.newBuilder();
 tensorboardServiceSettingsBuilder
     .getTensorboardSettings()
     .setRetrySettings(
         tensorboardServiceSettingsBuilder
             .getTensorboardSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TensorboardServiceStubSettings tensorboardServiceSettings =
     tensorboardServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > TensorboardServiceStubSettings

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

Returns a new builder for this class.

Returns
TypeDescription
TensorboardServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static TensorboardServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
TensorboardServiceStubSettings.Builder

Constructors

TensorboardServiceStubSettings(TensorboardServiceStubSettings.Builder settingsBuilder)

protected TensorboardServiceStubSettings(TensorboardServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderTensorboardServiceStubSettings.Builder

Methods

batchCreateTensorboardRunsSettings()

public UnaryCallSettings<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse> batchCreateTensorboardRunsSettings()

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

Returns
TypeDescription
UnaryCallSettings<BatchCreateTensorboardRunsRequest,BatchCreateTensorboardRunsResponse>

batchCreateTensorboardTimeSeriesSettings()

public UnaryCallSettings<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse> batchCreateTensorboardTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<BatchCreateTensorboardTimeSeriesRequest,BatchCreateTensorboardTimeSeriesResponse>

batchReadTensorboardTimeSeriesDataSettings()

public UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse> batchReadTensorboardTimeSeriesDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<BatchReadTensorboardTimeSeriesDataRequest,BatchReadTensorboardTimeSeriesDataResponse>

createStub()

public TensorboardServiceStub createStub()
Returns
TypeDescription
TensorboardServiceStub
Exceptions
TypeDescription
IOException

createTensorboardExperimentSettings()

public UnaryCallSettings<CreateTensorboardExperimentRequest,TensorboardExperiment> createTensorboardExperimentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTensorboardExperimentRequest,TensorboardExperiment>

createTensorboardOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateTensorboardRequest,Tensorboard,CreateTensorboardOperationMetadata>

createTensorboardRunSettings()

public UnaryCallSettings<CreateTensorboardRunRequest,TensorboardRun> createTensorboardRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTensorboardRunRequest,TensorboardRun>

createTensorboardSettings()

public UnaryCallSettings<CreateTensorboardRequest,Operation> createTensorboardSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTensorboardRequest,Operation>

createTensorboardTimeSeriesSettings()

public UnaryCallSettings<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries> createTensorboardTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

deleteTensorboardExperimentOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTensorboardExperimentRequest,Empty,DeleteOperationMetadata>

deleteTensorboardExperimentSettings()

public UnaryCallSettings<DeleteTensorboardExperimentRequest,Operation> deleteTensorboardExperimentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTensorboardExperimentRequest,Operation>

deleteTensorboardOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTensorboardRequest,Empty,DeleteOperationMetadata>

deleteTensorboardRunOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTensorboardRunRequest,Empty,DeleteOperationMetadata>

deleteTensorboardRunSettings()

public UnaryCallSettings<DeleteTensorboardRunRequest,Operation> deleteTensorboardRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTensorboardRunRequest,Operation>

deleteTensorboardSettings()

public UnaryCallSettings<DeleteTensorboardRequest,Operation> deleteTensorboardSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTensorboardRequest,Operation>

deleteTensorboardTimeSeriesOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTensorboardTimeSeriesRequest,Empty,DeleteOperationMetadata>

deleteTensorboardTimeSeriesSettings()

public UnaryCallSettings<DeleteTensorboardTimeSeriesRequest,Operation> deleteTensorboardTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTensorboardTimeSeriesRequest,Operation>

exportTensorboardTimeSeriesDataSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ExportTensorboardTimeSeriesDataRequest,ExportTensorboardTimeSeriesDataResponse,ExportTensorboardTimeSeriesDataPagedResponse>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallSettings<GetTensorboardExperimentRequest,TensorboardExperiment>

getTensorboardRunSettings()

public UnaryCallSettings<GetTensorboardRunRequest,TensorboardRun> getTensorboardRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTensorboardRunRequest,TensorboardRun>

getTensorboardSettings()

public UnaryCallSettings<GetTensorboardRequest,Tensorboard> getTensorboardSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTensorboardRequest,Tensorboard>

getTensorboardTimeSeriesSettings()

public UnaryCallSettings<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries> getTensorboardTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTensorboardTimeSeriesRequest,TensorboardTimeSeries>

listLocationsSettings()

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

listTensorboardExperimentsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTensorboardExperimentsRequest,ListTensorboardExperimentsResponse,ListTensorboardExperimentsPagedResponse>

listTensorboardRunsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTensorboardRunsRequest,ListTensorboardRunsResponse,ListTensorboardRunsPagedResponse>

listTensorboardTimeSeriesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTensorboardTimeSeriesRequest,ListTensorboardTimeSeriesResponse,ListTensorboardTimeSeriesPagedResponse>

listTensorboardsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTensorboardsRequest,ListTensorboardsResponse,ListTensorboardsPagedResponse>

readTensorboardBlobDataSettings()

public ServerStreamingCallSettings<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse> readTensorboardBlobDataSettings()

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

Returns
TypeDescription
ServerStreamingCallSettings<ReadTensorboardBlobDataRequest,ReadTensorboardBlobDataResponse>

readTensorboardSizeSettings()

public UnaryCallSettings<ReadTensorboardSizeRequest,ReadTensorboardSizeResponse> readTensorboardSizeSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReadTensorboardSizeRequest,ReadTensorboardSizeResponse>

readTensorboardTimeSeriesDataSettings()

public UnaryCallSettings<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse> readTensorboardTimeSeriesDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReadTensorboardTimeSeriesDataRequest,ReadTensorboardTimeSeriesDataResponse>

readTensorboardUsageSettings()

public UnaryCallSettings<ReadTensorboardUsageRequest,ReadTensorboardUsageResponse> readTensorboardUsageSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReadTensorboardUsageRequest,ReadTensorboardUsageResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public TensorboardServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
TensorboardServiceStubSettings.Builder
Overrides

updateTensorboardExperimentSettings()

public UnaryCallSettings<UpdateTensorboardExperimentRequest,TensorboardExperiment> updateTensorboardExperimentSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTensorboardExperimentRequest,TensorboardExperiment>

updateTensorboardOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateTensorboardRequest,Tensorboard,UpdateTensorboardOperationMetadata>

updateTensorboardRunSettings()

public UnaryCallSettings<UpdateTensorboardRunRequest,TensorboardRun> updateTensorboardRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTensorboardRunRequest,TensorboardRun>

updateTensorboardSettings()

public UnaryCallSettings<UpdateTensorboardRequest,Operation> updateTensorboardSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTensorboardRequest,Operation>

updateTensorboardTimeSeriesSettings()

public UnaryCallSettings<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries> updateTensorboardTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTensorboardTimeSeriesRequest,TensorboardTimeSeries>

writeTensorboardExperimentDataSettings()

public UnaryCallSettings<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse> writeTensorboardExperimentDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<WriteTensorboardExperimentDataRequest,WriteTensorboardExperimentDataResponse>

writeTensorboardRunDataSettings()

public UnaryCallSettings<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse> writeTensorboardRunDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<WriteTensorboardRunDataRequest,WriteTensorboardRunDataResponse>