Class NotebookServiceSettings (3.53.0)

Version 3.53.0

• 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 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 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 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)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 notebookServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > NotebookServiceSettings

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

public static final NotebookServiceSettings create(NotebookServiceStubSettings stub)

Parameter
Name	Description
stub	NotebookServiceStubSettings

Returns
Type	Description
NotebookServiceSettings

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

Returns a new builder for this class.

Returns
Type	Description
NotebookServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static NotebookServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
NotebookServiceSettings.Builder

Constructors

NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)

protected NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	NotebookServiceSettings.Builder

Methods

assignNotebookRuntimeOperationSettings()

public OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata> assignNotebookRuntimeOperationSettings()

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

Returns
Type	Description
OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata>

assignNotebookRuntimeSettings()

public UnaryCallSettings<AssignNotebookRuntimeRequest,Operation> assignNotebookRuntimeSettings()

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

Returns
Type	Description
UnaryCallSettings<AssignNotebookRuntimeRequest,Operation>

createNotebookExecutionJobOperationSettings()

public OperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata> createNotebookExecutionJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata>

createNotebookExecutionJobSettings()

public UnaryCallSettings<CreateNotebookExecutionJobRequest,Operation> createNotebookExecutionJobSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateNotebookExecutionJobRequest,Operation>

createNotebookRuntimeTemplateOperationSettings()

public OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>

createNotebookRuntimeTemplateSettings()

public UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,Operation> createNotebookRuntimeTemplateSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,Operation>

deleteNotebookExecutionJobOperationSettings()

public OperationCallSettings<DeleteNotebookExecutionJobRequest,Empty,DeleteOperationMetadata> deleteNotebookExecutionJobOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteNotebookExecutionJobRequest,Empty,DeleteOperationMetadata>

deleteNotebookExecutionJobSettings()

public UnaryCallSettings<DeleteNotebookExecutionJobRequest,Operation> deleteNotebookExecutionJobSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteNotebookExecutionJobRequest,Operation>

deleteNotebookRuntimeOperationSettings()

public OperationCallSettings<DeleteNotebookRuntimeRequest,Empty,DeleteOperationMetadata> deleteNotebookRuntimeOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteNotebookRuntimeRequest,Empty,DeleteOperationMetadata>

deleteNotebookRuntimeSettings()

public UnaryCallSettings<DeleteNotebookRuntimeRequest,Operation> deleteNotebookRuntimeSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteNotebookRuntimeRequest,Operation>

deleteNotebookRuntimeTemplateOperationSettings()

public OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,Empty,DeleteOperationMetadata>

deleteNotebookRuntimeTemplateSettings()

public UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,Operation> deleteNotebookRuntimeTemplateSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,Operation>

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>

getNotebookExecutionJobSettings()

public UnaryCallSettings<GetNotebookExecutionJobRequest,NotebookExecutionJob> getNotebookExecutionJobSettings()

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

Returns
Type	Description
UnaryCallSettings<GetNotebookExecutionJobRequest,NotebookExecutionJob>

getNotebookRuntimeSettings()

public UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime> getNotebookRuntimeSettings()

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

Returns
Type	Description
UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime>

getNotebookRuntimeTemplateSettings()

public UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> getNotebookRuntimeTemplateSettings()

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

Returns
Type	Description
UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate>

listLocationsSettings()

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

listNotebookExecutionJobsSettings()

public PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse,NotebookServiceClient.ListNotebookExecutionJobsPagedResponse> listNotebookExecutionJobsSettings()

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

Returns
Type	Description
PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse,ListNotebookExecutionJobsPagedResponse>

listNotebookRuntimeTemplatesSettings()

public PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> listNotebookRuntimeTemplatesSettings()

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

Returns
Type	Description
PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,ListNotebookRuntimeTemplatesPagedResponse>

listNotebookRuntimesSettings()

public PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,NotebookServiceClient.ListNotebookRuntimesPagedResponse> listNotebookRuntimesSettings()

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

Returns
Type	Description
PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,ListNotebookRuntimesPagedResponse>

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>

startNotebookRuntimeOperationSettings()

public OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata> startNotebookRuntimeOperationSettings()

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

Returns
Type	Description
OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>

startNotebookRuntimeSettings()

public UnaryCallSettings<StartNotebookRuntimeRequest,Operation> startNotebookRuntimeSettings()

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

Returns
Type	Description
UnaryCallSettings<StartNotebookRuntimeRequest,Operation>

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 NotebookServiceSettings.Builder toBuilder()

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

Returns
Type	Description
NotebookServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateNotebookRuntimeTemplateSettings()

public UnaryCallSettings<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> updateNotebookRuntimeTemplateSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate>

upgradeNotebookRuntimeOperationSettings()

public OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata> upgradeNotebookRuntimeOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>

upgradeNotebookRuntimeSettings()

public UnaryCallSettings<UpgradeNotebookRuntimeRequest,Operation> upgradeNotebookRuntimeSettings()

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

Returns
Type	Description
UnaryCallSettings<UpgradeNotebookRuntimeRequest,Operation>