Class NotebookServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>
com.google.cloud.aiplatform.v1beta1.NotebookServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class NotebookServiceSettings
extends ClientSettings<NotebookServiceSettings>
Settings class to configure an instance of
NotebookServiceClient.
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 getNotebookRuntimeTemplate:
// 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
NotebookServiceSettings.Builder notebookServiceSettingsBuilder =
NotebookServiceSettings.newBuilder();
notebookServiceSettingsBuilder
.getNotebookRuntimeTemplateSettings()
.setRetrySettings(
notebookServiceSettingsBuilder
.getNotebookRuntimeTemplateSettings()
.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());
NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.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 createNotebookRuntimeTemplate:
// 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
NotebookServiceSettings.Builder notebookServiceSettingsBuilder =
NotebookServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
notebookServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for NotebookServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedNotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime, AssignNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to assignNotebookRuntime.Returns the object with the settings used for calls to assignNotebookRuntime.static final NotebookServiceSettingsOperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob, CreateNotebookExecutionJobOperationMetadata> Returns the object with the settings used for calls to createNotebookExecutionJob.Returns the object with the settings used for calls to createNotebookExecutionJob.OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate, CreateNotebookRuntimeTemplateOperationMetadata> Returns the object with the settings used for calls to createNotebookRuntimeTemplate.Returns the object with the settings used for calls to createNotebookRuntimeTemplate.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<DeleteNotebookExecutionJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookExecutionJob.Returns the object with the settings used for calls to deleteNotebookExecutionJob.OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookRuntime.Returns the object with the settings used for calls to deleteNotebookRuntime.OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.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 getNotebookExecutionJob.Returns the object with the settings used for calls to getNotebookRuntime.Returns the object with the settings used for calls to getNotebookRuntimeTemplate.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, NotebookServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse, NotebookServiceClient.ListNotebookExecutionJobsPagedResponse> Returns the object with the settings used for calls to listNotebookExecutionJobs.PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse, NotebookServiceClient.ListNotebookRuntimesPagedResponse> Returns the object with the settings used for calls to listNotebookRuntimes.PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse, NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> Returns the object with the settings used for calls to listNotebookRuntimeTemplates.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 setIamPolicy.OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse, StartNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to startNotebookRuntime.Returns the object with the settings used for calls to startNotebookRuntime.OperationCallSettings<StopNotebookRuntimeRequest,StopNotebookRuntimeResponse, StopNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to stopNotebookRuntime.Returns the object with the settings used for calls to stopNotebookRuntime.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 updateNotebookRuntimeTemplate.OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse, UpgradeNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to upgradeNotebookRuntime.Returns the object with the settings used for calls to upgradeNotebookRuntime.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
-
NotebookServiceSettings
protected NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createNotebookRuntimeTemplateSettings
public UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,Operation> createNotebookRuntimeTemplateSettings()Returns the object with the settings used for calls to createNotebookRuntimeTemplate. -
createNotebookRuntimeTemplateOperationSettings
public OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate, createNotebookRuntimeTemplateOperationSettings()CreateNotebookRuntimeTemplateOperationMetadata> Returns the object with the settings used for calls to createNotebookRuntimeTemplate. -
getNotebookRuntimeTemplateSettings
public UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> getNotebookRuntimeTemplateSettings()Returns the object with the settings used for calls to getNotebookRuntimeTemplate. -
listNotebookRuntimeTemplatesSettings
public PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse, listNotebookRuntimeTemplatesSettings()NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> Returns the object with the settings used for calls to listNotebookRuntimeTemplates. -
deleteNotebookRuntimeTemplateSettings
public UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,Operation> deleteNotebookRuntimeTemplateSettings()Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate. -
deleteNotebookRuntimeTemplateOperationSettings
public OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty, deleteNotebookRuntimeTemplateOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate. -
updateNotebookRuntimeTemplateSettings
public UnaryCallSettings<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> updateNotebookRuntimeTemplateSettings()Returns the object with the settings used for calls to updateNotebookRuntimeTemplate. -
assignNotebookRuntimeSettings
Returns the object with the settings used for calls to assignNotebookRuntime. -
assignNotebookRuntimeOperationSettings
public OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime, assignNotebookRuntimeOperationSettings()AssignNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to assignNotebookRuntime. -
getNotebookRuntimeSettings
Returns the object with the settings used for calls to getNotebookRuntime. -
listNotebookRuntimesSettings
public PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse, listNotebookRuntimesSettings()NotebookServiceClient.ListNotebookRuntimesPagedResponse> Returns the object with the settings used for calls to listNotebookRuntimes. -
deleteNotebookRuntimeSettings
Returns the object with the settings used for calls to deleteNotebookRuntime. -
deleteNotebookRuntimeOperationSettings
public OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty, deleteNotebookRuntimeOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookRuntime. -
upgradeNotebookRuntimeSettings
Returns the object with the settings used for calls to upgradeNotebookRuntime. -
upgradeNotebookRuntimeOperationSettings
public OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse, upgradeNotebookRuntimeOperationSettings()UpgradeNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to upgradeNotebookRuntime. -
startNotebookRuntimeSettings
Returns the object with the settings used for calls to startNotebookRuntime. -
startNotebookRuntimeOperationSettings
public OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse, startNotebookRuntimeOperationSettings()StartNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to startNotebookRuntime. -
stopNotebookRuntimeSettings
Returns the object with the settings used for calls to stopNotebookRuntime. -
stopNotebookRuntimeOperationSettings
public OperationCallSettings<StopNotebookRuntimeRequest,StopNotebookRuntimeResponse, stopNotebookRuntimeOperationSettings()StopNotebookRuntimeOperationMetadata> Returns the object with the settings used for calls to stopNotebookRuntime. -
createNotebookExecutionJobSettings
public UnaryCallSettings<CreateNotebookExecutionJobRequest,Operation> createNotebookExecutionJobSettings()Returns the object with the settings used for calls to createNotebookExecutionJob. -
createNotebookExecutionJobOperationSettings
public OperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob, createNotebookExecutionJobOperationSettings()CreateNotebookExecutionJobOperationMetadata> Returns the object with the settings used for calls to createNotebookExecutionJob. -
getNotebookExecutionJobSettings
public UnaryCallSettings<GetNotebookExecutionJobRequest,NotebookExecutionJob> getNotebookExecutionJobSettings()Returns the object with the settings used for calls to getNotebookExecutionJob. -
listNotebookExecutionJobsSettings
public PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse, listNotebookExecutionJobsSettings()NotebookServiceClient.ListNotebookExecutionJobsPagedResponse> Returns the object with the settings used for calls to listNotebookExecutionJobs. -
deleteNotebookExecutionJobSettings
public UnaryCallSettings<DeleteNotebookExecutionJobRequest,Operation> deleteNotebookExecutionJobSettings()Returns the object with the settings used for calls to deleteNotebookExecutionJob. -
deleteNotebookExecutionJobOperationSettings
public OperationCallSettings<DeleteNotebookExecutionJobRequest,com.google.protobuf.Empty, deleteNotebookExecutionJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNotebookExecutionJob. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()NotebookServiceClient.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 NotebookServiceSettings create(NotebookServiceStubSettings 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<NotebookServiceSettings>
-