- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.3
- 1.0.6
- 0.6.2
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 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 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();
Static Methods
create(ManagedNotebookServiceStubSettings stub)
public static final ManagedNotebookServiceSettings create(ManagedNotebookServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ManagedNotebookServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
ManagedNotebookServiceSettings |
|
| 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 ManagedNotebookServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
ManagedNotebookServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static ManagedNotebookServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ManagedNotebookServiceSettings.Builder |
|
Constructors
ManagedNotebookServiceSettings(ManagedNotebookServiceSettings.Builder settingsBuilder)
protected ManagedNotebookServiceSettings(ManagedNotebookServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ManagedNotebookServiceSettings.Builder |
Methods
createRuntimeOperationSettings()
public OperationCallSettings<CreateRuntimeRequest,Runtime,OperationMetadata> createRuntimeOperationSettings()Returns the object with the settings used for calls to createRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateRuntimeRequest,Runtime,OperationMetadata> |
|
createRuntimeSettings()
public UnaryCallSettings<CreateRuntimeRequest,Operation> createRuntimeSettings()Returns the object with the settings used for calls to createRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateRuntimeRequest,Operation> |
|
deleteRuntimeOperationSettings()
public OperationCallSettings<DeleteRuntimeRequest,Empty,OperationMetadata> deleteRuntimeOperationSettings()Returns the object with the settings used for calls to deleteRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteRuntimeRequest,Empty,OperationMetadata> |
|
deleteRuntimeSettings()
public UnaryCallSettings<DeleteRuntimeRequest,Operation> deleteRuntimeSettings()Returns the object with the settings used for calls to deleteRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteRuntimeRequest,Operation> |
|
diagnoseRuntimeOperationSettings()
public OperationCallSettings<DiagnoseRuntimeRequest,Runtime,OperationMetadata> diagnoseRuntimeOperationSettings()Returns the object with the settings used for calls to diagnoseRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DiagnoseRuntimeRequest,Runtime,OperationMetadata> |
|
diagnoseRuntimeSettings()
public UnaryCallSettings<DiagnoseRuntimeRequest,Operation> diagnoseRuntimeSettings()Returns the object with the settings used for calls to diagnoseRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DiagnoseRuntimeRequest,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> |
|
getRuntimeSettings()
public UnaryCallSettings<GetRuntimeRequest,Runtime> getRuntimeSettings()Returns the object with the settings used for calls to getRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetRuntimeRequest,Runtime> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ManagedNotebookServiceClient.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> |
|
listRuntimesSettings()
public PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse,ManagedNotebookServiceClient.ListRuntimesPagedResponse> listRuntimesSettings()Returns the object with the settings used for calls to listRuntimes.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse,ListRuntimesPagedResponse> |
|
refreshRuntimeTokenInternalSettings()
public UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> refreshRuntimeTokenInternalSettings()Returns the object with the settings used for calls to refreshRuntimeTokenInternal.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> |
|
reportRuntimeEventOperationSettings()
public OperationCallSettings<ReportRuntimeEventRequest,Runtime,OperationMetadata> reportRuntimeEventOperationSettings()Returns the object with the settings used for calls to reportRuntimeEvent.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ReportRuntimeEventRequest,Runtime,OperationMetadata> |
|
reportRuntimeEventSettings()
public UnaryCallSettings<ReportRuntimeEventRequest,Operation> reportRuntimeEventSettings()Returns the object with the settings used for calls to reportRuntimeEvent.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ReportRuntimeEventRequest,Operation> |
|
resetRuntimeOperationSettings()
public OperationCallSettings<ResetRuntimeRequest,Runtime,OperationMetadata> resetRuntimeOperationSettings()Returns the object with the settings used for calls to resetRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ResetRuntimeRequest,Runtime,OperationMetadata> |
|
resetRuntimeSettings()
public UnaryCallSettings<ResetRuntimeRequest,Operation> resetRuntimeSettings()Returns the object with the settings used for calls to resetRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ResetRuntimeRequest,Operation> |
|
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> |
|
startRuntimeOperationSettings()
public OperationCallSettings<StartRuntimeRequest,Runtime,OperationMetadata> startRuntimeOperationSettings()Returns the object with the settings used for calls to startRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<StartRuntimeRequest,Runtime,OperationMetadata> |
|
startRuntimeSettings()
public UnaryCallSettings<StartRuntimeRequest,Operation> startRuntimeSettings()Returns the object with the settings used for calls to startRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<StartRuntimeRequest,Operation> |
|
stopRuntimeOperationSettings()
public OperationCallSettings<StopRuntimeRequest,Runtime,OperationMetadata> stopRuntimeOperationSettings()Returns the object with the settings used for calls to stopRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<StopRuntimeRequest,Runtime,OperationMetadata> |
|
stopRuntimeSettings()
public UnaryCallSettings<StopRuntimeRequest,Operation> stopRuntimeSettings()Returns the object with the settings used for calls to stopRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<StopRuntimeRequest,Operation> |
|
switchRuntimeOperationSettings()
public OperationCallSettings<SwitchRuntimeRequest,Runtime,OperationMetadata> switchRuntimeOperationSettings()Returns the object with the settings used for calls to switchRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SwitchRuntimeRequest,Runtime,OperationMetadata> |
|
switchRuntimeSettings()
public UnaryCallSettings<SwitchRuntimeRequest,Operation> switchRuntimeSettings()Returns the object with the settings used for calls to switchRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SwitchRuntimeRequest,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 ManagedNotebookServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ManagedNotebookServiceSettings.Builder |
|
updateRuntimeOperationSettings()
public OperationCallSettings<UpdateRuntimeRequest,Runtime,OperationMetadata> updateRuntimeOperationSettings()Returns the object with the settings used for calls to updateRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateRuntimeRequest,Runtime,OperationMetadata> |
|
updateRuntimeSettings()
public UnaryCallSettings<UpdateRuntimeRequest,Operation> updateRuntimeSettings()Returns the object with the settings used for calls to updateRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateRuntimeRequest,Operation> |
|
upgradeRuntimeOperationSettings()
public OperationCallSettings<UpgradeRuntimeRequest,Runtime,OperationMetadata> upgradeRuntimeOperationSettings()Returns the object with the settings used for calls to upgradeRuntime.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpgradeRuntimeRequest,Runtime,OperationMetadata> |
|
upgradeRuntimeSettings()
public UnaryCallSettings<UpgradeRuntimeRequest,Operation> upgradeRuntimeSettings()Returns the object with the settings used for calls to upgradeRuntime.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpgradeRuntimeRequest,Operation> |
|