Package com.google.cloud.notebooks.v1
Class ManagedNotebookServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ManagedNotebookServiceSettings>
com.google.cloud.notebooks.v1.ManagedNotebookServiceSettings
@Generated("by gapic-generator-java")
public class ManagedNotebookServiceSettings
extends ClientSettings<ManagedNotebookServiceSettings>
Settings class to configure an instance of
ManagedNotebookServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (notebooks.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 getRuntime:
// 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
ManagedNotebookServiceSettings.Builder managedNotebookServiceSettingsBuilder =
ManagedNotebookServiceSettings.newBuilder();
managedNotebookServiceSettingsBuilder
.getRuntimeSettings()
.setRetrySettings(
managedNotebookServiceSettingsBuilder
.getRuntimeSettings()
.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());
ManagedNotebookServiceSettings managedNotebookServiceSettings =
managedNotebookServiceSettingsBuilder.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 createRuntime:
// 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
ManagedNotebookServiceSettings.Builder managedNotebookServiceSettingsBuilder =
ManagedNotebookServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
managedNotebookServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ManagedNotebookServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedManagedNotebookServiceSettings(ManagedNotebookServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ManagedNotebookServiceSettingsReturns the object with the settings used for calls to createRuntime.Returns the object with the settings used for calls to createRuntime.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<DeleteRuntimeRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRuntime.Returns the object with the settings used for calls to deleteRuntime.Returns the object with the settings used for calls to diagnoseRuntime.Returns the object with the settings used for calls to diagnoseRuntime.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 getRuntime.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ManagedNotebookServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse, ManagedNotebookServiceClient.ListRuntimesPagedResponse> Returns the object with the settings used for calls to listRuntimes.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 refreshRuntimeTokenInternal.Returns the object with the settings used for calls to reportRuntimeEvent.Returns the object with the settings used for calls to reportRuntimeEvent.Returns the object with the settings used for calls to resetRuntime.Returns the object with the settings used for calls to resetRuntime.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to startRuntime.Returns the object with the settings used for calls to startRuntime.Returns the object with the settings used for calls to stopRuntime.Returns the object with the settings used for calls to stopRuntime.Returns the object with the settings used for calls to switchRuntime.Returns the object with the settings used for calls to switchRuntime.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 updateRuntime.Returns the object with the settings used for calls to updateRuntime.Returns the object with the settings used for calls to upgradeRuntime.Returns the object with the settings used for calls to upgradeRuntime.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
-
ManagedNotebookServiceSettings
protected ManagedNotebookServiceSettings(ManagedNotebookServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listRuntimesSettings
public PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse, listRuntimesSettings()ManagedNotebookServiceClient.ListRuntimesPagedResponse> Returns the object with the settings used for calls to listRuntimes. -
getRuntimeSettings
Returns the object with the settings used for calls to getRuntime. -
createRuntimeSettings
Returns the object with the settings used for calls to createRuntime. -
createRuntimeOperationSettings
public OperationCallSettings<CreateRuntimeRequest,Runtime, createRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRuntime. -
updateRuntimeSettings
Returns the object with the settings used for calls to updateRuntime. -
updateRuntimeOperationSettings
public OperationCallSettings<UpdateRuntimeRequest,Runtime, updateRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRuntime. -
deleteRuntimeSettings
Returns the object with the settings used for calls to deleteRuntime. -
deleteRuntimeOperationSettings
public OperationCallSettings<DeleteRuntimeRequest,com.google.protobuf.Empty, deleteRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRuntime. -
startRuntimeSettings
Returns the object with the settings used for calls to startRuntime. -
startRuntimeOperationSettings
public OperationCallSettings<StartRuntimeRequest,Runtime, startRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to startRuntime. -
stopRuntimeSettings
Returns the object with the settings used for calls to stopRuntime. -
stopRuntimeOperationSettings
public OperationCallSettings<StopRuntimeRequest,Runtime, stopRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to stopRuntime. -
switchRuntimeSettings
Returns the object with the settings used for calls to switchRuntime. -
switchRuntimeOperationSettings
public OperationCallSettings<SwitchRuntimeRequest,Runtime, switchRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to switchRuntime. -
resetRuntimeSettings
Returns the object with the settings used for calls to resetRuntime. -
resetRuntimeOperationSettings
public OperationCallSettings<ResetRuntimeRequest,Runtime, resetRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resetRuntime. -
upgradeRuntimeSettings
Returns the object with the settings used for calls to upgradeRuntime. -
upgradeRuntimeOperationSettings
public OperationCallSettings<UpgradeRuntimeRequest,Runtime, upgradeRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to upgradeRuntime. -
reportRuntimeEventSettings
Returns the object with the settings used for calls to reportRuntimeEvent. -
reportRuntimeEventOperationSettings
public OperationCallSettings<ReportRuntimeEventRequest,Runtime, reportRuntimeEventOperationSettings()OperationMetadata> Returns the object with the settings used for calls to reportRuntimeEvent. -
refreshRuntimeTokenInternalSettings
public UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> refreshRuntimeTokenInternalSettings()Returns the object with the settings used for calls to refreshRuntimeTokenInternal. -
diagnoseRuntimeSettings
Returns the object with the settings used for calls to diagnoseRuntime. -
diagnoseRuntimeOperationSettings
public OperationCallSettings<DiagnoseRuntimeRequest,Runtime, diagnoseRuntimeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to diagnoseRuntime. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ManagedNotebookServiceClient.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 ManagedNotebookServiceSettings create(ManagedNotebookServiceStubSettings 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<ManagedNotebookServiceSettings>
-