@BetaApi @Generated(value="by gapic-generator-java") public class NotebookServiceStubSettings extends com.google.api.gax.rpc.StubSettings<NotebookServiceStubSettings>
NotebookServiceStub.
The default instance has everything set to sensible defaults:
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
NotebookServiceStubSettings.Builder notebookServiceSettingsBuilder =
NotebookServiceStubSettings.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());
NotebookServiceStubSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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
NotebookServiceStubSettings.Builder notebookServiceSettingsBuilder =
NotebookServiceStubSettings.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();
| Modifier and Type | Class and Description |
|---|---|
static class |
NotebookServiceStubSettings.Builder
Builder for NotebookServiceStubSettings.
|
| Modifier | Constructor and Description |
|---|---|
protected |
NotebookServiceStubSettings(NotebookServiceStubSettings.Builder settingsBuilder) |
| Modifier and Type | Method and Description |
|---|---|
com.google.api.gax.rpc.OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata> |
assignNotebookRuntimeOperationSettings()
Returns the object with the settings used for calls to assignNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<AssignNotebookRuntimeRequest,com.google.longrunning.Operation> |
assignNotebookRuntimeSettings()
Returns the object with the settings used for calls to assignNotebookRuntime.
|
com.google.api.gax.rpc.OperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata> |
createNotebookExecutionJobOperationSettings()
Returns the object with the settings used for calls to createNotebookExecutionJob.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookExecutionJobRequest,com.google.longrunning.Operation> |
createNotebookExecutionJobSettings()
Returns the object with the settings used for calls to createNotebookExecutionJob.
|
com.google.api.gax.rpc.OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> |
createNotebookRuntimeTemplateOperationSettings()
Returns the object with the settings used for calls to createNotebookRuntimeTemplate.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> |
createNotebookRuntimeTemplateSettings()
Returns the object with the settings used for calls to createNotebookRuntimeTemplate.
|
NotebookServiceStub |
createStub() |
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultApiClientHeaderProviderBuilder() |
static com.google.api.gax.core.GoogleCredentialsProvider.Builder |
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
|
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder |
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
|
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder |
defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.
|
static com.google.api.gax.rpc.TransportChannelProvider |
defaultTransportChannelProvider() |
com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookExecutionJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> |
deleteNotebookExecutionJobOperationSettings()
Returns the object with the settings used for calls to deleteNotebookExecutionJob.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookExecutionJobRequest,com.google.longrunning.Operation> |
deleteNotebookExecutionJobSettings()
Returns the object with the settings used for calls to deleteNotebookExecutionJob.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty,DeleteOperationMetadata> |
deleteNotebookRuntimeOperationSettings()
Returns the object with the settings used for calls to deleteNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeRequest,com.google.longrunning.Operation> |
deleteNotebookRuntimeSettings()
Returns the object with the settings used for calls to deleteNotebookRuntime.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata> |
deleteNotebookRuntimeTemplateOperationSettings()
Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> |
deleteNotebookRuntimeTemplateSettings()
Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.
|
static String |
getDefaultEndpoint()
Returns the default service endpoint.
|
static String |
getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
|
static List<String> |
getDefaultServiceScopes()
Returns the default service scopes.
|
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
|
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getLocationSettings()
Returns the object with the settings used for calls to getLocation.
|
com.google.api.gax.rpc.UnaryCallSettings<GetNotebookExecutionJobRequest,NotebookExecutionJob> |
getNotebookExecutionJobSettings()
Returns the object with the settings used for calls to getNotebookExecutionJob.
|
com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime> |
getNotebookRuntimeSettings()
Returns the object with the settings used for calls to getNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> |
getNotebookRuntimeTemplateSettings()
Returns the object with the settings used for calls to getNotebookRuntimeTemplate.
|
String |
getServiceName()
Returns the default service name.
|
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,NotebookServiceClient.ListLocationsPagedResponse> |
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
|
com.google.api.gax.rpc.PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse,NotebookServiceClient.ListNotebookExecutionJobsPagedResponse> |
listNotebookExecutionJobsSettings()
Returns the object with the settings used for calls to listNotebookExecutionJobs.
|
com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,NotebookServiceClient.ListNotebookRuntimesPagedResponse> |
listNotebookRuntimesSettings()
Returns the object with the settings used for calls to listNotebookRuntimes.
|
com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> |
listNotebookRuntimeTemplatesSettings()
Returns the object with the settings used for calls to listNotebookRuntimeTemplates.
|
static NotebookServiceStubSettings.Builder |
newBuilder()
Returns a new builder for this class.
|
static NotebookServiceStubSettings.Builder |
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
|
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
|
com.google.api.gax.rpc.OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata> |
startNotebookRuntimeOperationSettings()
Returns the object with the settings used for calls to startNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<StartNotebookRuntimeRequest,com.google.longrunning.Operation> |
startNotebookRuntimeSettings()
Returns the object with the settings used for calls to startNotebookRuntime.
|
com.google.api.gax.rpc.OperationCallSettings<StopNotebookRuntimeRequest,StopNotebookRuntimeResponse,StopNotebookRuntimeOperationMetadata> |
stopNotebookRuntimeOperationSettings()
Returns the object with the settings used for calls to stopNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<StopNotebookRuntimeRequest,com.google.longrunning.Operation> |
stopNotebookRuntimeSettings()
Returns the object with the settings used for calls to stopNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
|
NotebookServiceStubSettings.Builder |
toBuilder()
Returns a builder containing all the values of this settings class.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> |
updateNotebookRuntimeTemplateSettings()
Returns the object with the settings used for calls to updateNotebookRuntimeTemplate.
|
com.google.api.gax.rpc.OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata> |
upgradeNotebookRuntimeOperationSettings()
Returns the object with the settings used for calls to upgradeNotebookRuntime.
|
com.google.api.gax.rpc.UnaryCallSettings<UpgradeNotebookRuntimeRequest,com.google.longrunning.Operation> |
upgradeNotebookRuntimeSettings()
Returns the object with the settings used for calls to upgradeNotebookRuntime.
|
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toStringprotected NotebookServiceStubSettings(NotebookServiceStubSettings.Builder settingsBuilder) throws IOException
IOExceptionpublic com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> createNotebookRuntimeTemplateSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> getNotebookRuntimeTemplateSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> listNotebookRuntimeTemplatesSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> deleteNotebookRuntimeTemplateSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> updateNotebookRuntimeTemplateSettings()
public com.google.api.gax.rpc.UnaryCallSettings<AssignNotebookRuntimeRequest,com.google.longrunning.Operation> assignNotebookRuntimeSettings()
public com.google.api.gax.rpc.OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata> assignNotebookRuntimeOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime> getNotebookRuntimeSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,NotebookServiceClient.ListNotebookRuntimesPagedResponse> listNotebookRuntimesSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeRequest,com.google.longrunning.Operation> deleteNotebookRuntimeSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpgradeNotebookRuntimeRequest,com.google.longrunning.Operation> upgradeNotebookRuntimeSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata> upgradeNotebookRuntimeOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<StartNotebookRuntimeRequest,com.google.longrunning.Operation> startNotebookRuntimeSettings()
public com.google.api.gax.rpc.OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata> startNotebookRuntimeOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<StopNotebookRuntimeRequest,com.google.longrunning.Operation> stopNotebookRuntimeSettings()
public com.google.api.gax.rpc.OperationCallSettings<StopNotebookRuntimeRequest,StopNotebookRuntimeResponse,StopNotebookRuntimeOperationMetadata> stopNotebookRuntimeOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookExecutionJobRequest,com.google.longrunning.Operation> createNotebookExecutionJobSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateNotebookExecutionJobRequest,NotebookExecutionJob,CreateNotebookExecutionJobOperationMetadata> createNotebookExecutionJobOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetNotebookExecutionJobRequest,NotebookExecutionJob> getNotebookExecutionJobSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListNotebookExecutionJobsRequest,ListNotebookExecutionJobsResponse,NotebookServiceClient.ListNotebookExecutionJobsPagedResponse> listNotebookExecutionJobsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookExecutionJobRequest,com.google.longrunning.Operation> deleteNotebookExecutionJobSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookExecutionJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookExecutionJobOperationSettings()
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,NotebookServiceClient.ListLocationsPagedResponse> listLocationsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
public NotebookServiceStub createStub() throws IOException
IOExceptionpublic String getServiceName()
getServiceName in class com.google.api.gax.rpc.StubSettings<NotebookServiceStubSettings>public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
@ObsoleteApi(value="Use getEndpoint() instead") public static String getDefaultEndpoint()
public static String getDefaultMtlsEndpoint()
public static List<String> getDefaultServiceScopes()
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
public static NotebookServiceStubSettings.Builder newBuilder()
public static NotebookServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
public NotebookServiceStubSettings.Builder toBuilder()
toBuilder in class com.google.api.gax.rpc.StubSettings<NotebookServiceStubSettings>Copyright © 2025 Google LLC. All rights reserved.