Package com.google.cloud.notebooks.v1
Class NotebookServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>
com.google.cloud.notebooks.v1.NotebookServiceSettings
@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 (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 getInstance:
// 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
.getInstanceSettings()
.setRetrySettings(
notebookServiceSettingsBuilder
.getInstanceSettings()
.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 createInstance:
// 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 TypeMethodDescriptionstatic final NotebookServiceSettingsReturns the object with the settings used for calls to createEnvironment.Returns the object with the settings used for calls to createEnvironment.Returns the object with the settings used for calls to createExecution.Returns the object with the settings used for calls to createExecution.Returns the object with the settings used for calls to createInstance.Returns the object with the settings used for calls to createInstance.Returns the object with the settings used for calls to createSchedule.Returns the object with the settings used for calls to createSchedule.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<DeleteEnvironmentRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteEnvironment.Returns the object with the settings used for calls to deleteEnvironment.OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteExecution.Returns the object with the settings used for calls to deleteExecution.OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInstance.Returns the object with the settings used for calls to deleteInstance.OperationCallSettings<DeleteScheduleRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteSchedule.Returns the object with the settings used for calls to deleteSchedule.Returns the object with the settings used for calls to diagnoseInstance.Returns the object with the settings used for calls to diagnoseInstance.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEnvironment.Returns the object with the settings used for calls to getExecution.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getInstanceHealth.Returns the object with the settings used for calls to getInstance.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getSchedule.Returns the object with the settings used for calls to isInstanceUpgradeable.PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse, NotebookServiceClient.ListEnvironmentsPagedResponse> Returns the object with the settings used for calls to listEnvironments.PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, NotebookServiceClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, NotebookServiceClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, NotebookServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse, NotebookServiceClient.ListSchedulesPagedResponse> Returns the object with the settings used for calls to listSchedules.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 registerInstance.Returns the object with the settings used for calls to registerInstance.Returns the object with the settings used for calls to reportInstanceInfo.Returns the object with the settings used for calls to reportInstanceInfo.Returns the object with the settings used for calls to resetInstance.Returns the object with the settings used for calls to resetInstance.Returns the object with the settings used for calls to rollbackInstance.Returns the object with the settings used for calls to rollbackInstance.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to setInstanceAccelerator.Returns the object with the settings used for calls to setInstanceAccelerator.Returns the object with the settings used for calls to setInstanceLabels.Returns the object with the settings used for calls to setInstanceLabels.Returns the object with the settings used for calls to setInstanceMachineType.Returns the object with the settings used for calls to setInstanceMachineType.Returns the object with the settings used for calls to startInstance.Returns the object with the settings used for calls to startInstance.Returns the object with the settings used for calls to stopInstance.Returns the object with the settings used for calls to stopInstance.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 triggerSchedule.Returns the object with the settings used for calls to triggerSchedule.Returns the object with the settings used for calls to updateInstanceConfig.Returns the object with the settings used for calls to updateInstanceConfig.Returns the object with the settings used for calls to updateInstanceMetadataItems.Returns the object with the settings used for calls to updateShieldedInstanceConfig.Returns the object with the settings used for calls to updateShieldedInstanceConfig.Returns the object with the settings used for calls to upgradeInstanceInternal.Returns the object with the settings used for calls to upgradeInstanceInternal.Returns the object with the settings used for calls to upgradeInstance.Returns the object with the settings used for calls to upgradeInstance.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
-
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()NotebookServiceClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances. -
getInstanceSettings
Returns the object with the settings used for calls to getInstance. -
createInstanceSettings
Returns the object with the settings used for calls to createInstance. -
createInstanceOperationSettings
public OperationCallSettings<CreateInstanceRequest,Instance, createInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInstance. -
registerInstanceSettings
Returns the object with the settings used for calls to registerInstance. -
registerInstanceOperationSettings
public OperationCallSettings<RegisterInstanceRequest,Instance, registerInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to registerInstance. -
setInstanceAcceleratorSettings
Returns the object with the settings used for calls to setInstanceAccelerator. -
setInstanceAcceleratorOperationSettings
public OperationCallSettings<SetInstanceAcceleratorRequest,Instance, setInstanceAcceleratorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to setInstanceAccelerator. -
setInstanceMachineTypeSettings
Returns the object with the settings used for calls to setInstanceMachineType. -
setInstanceMachineTypeOperationSettings
public OperationCallSettings<SetInstanceMachineTypeRequest,Instance, setInstanceMachineTypeOperationSettings()OperationMetadata> Returns the object with the settings used for calls to setInstanceMachineType. -
updateInstanceConfigSettings
Returns the object with the settings used for calls to updateInstanceConfig. -
updateInstanceConfigOperationSettings
public OperationCallSettings<UpdateInstanceConfigRequest,Instance, updateInstanceConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInstanceConfig. -
updateShieldedInstanceConfigSettings
public UnaryCallSettings<UpdateShieldedInstanceConfigRequest,Operation> updateShieldedInstanceConfigSettings()Returns the object with the settings used for calls to updateShieldedInstanceConfig. -
updateShieldedInstanceConfigOperationSettings
public OperationCallSettings<UpdateShieldedInstanceConfigRequest,Instance, updateShieldedInstanceConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateShieldedInstanceConfig. -
setInstanceLabelsSettings
Returns the object with the settings used for calls to setInstanceLabels. -
setInstanceLabelsOperationSettings
public OperationCallSettings<SetInstanceLabelsRequest,Instance, setInstanceLabelsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to setInstanceLabels. -
updateInstanceMetadataItemsSettings
public UnaryCallSettings<UpdateInstanceMetadataItemsRequest,UpdateInstanceMetadataItemsResponse> updateInstanceMetadataItemsSettings()Returns the object with the settings used for calls to updateInstanceMetadataItems. -
deleteInstanceSettings
Returns the object with the settings used for calls to deleteInstance. -
deleteInstanceOperationSettings
public OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty, deleteInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInstance. -
startInstanceSettings
Returns the object with the settings used for calls to startInstance. -
startInstanceOperationSettings
public OperationCallSettings<StartInstanceRequest,Instance, startInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to startInstance. -
stopInstanceSettings
Returns the object with the settings used for calls to stopInstance. -
stopInstanceOperationSettings
public OperationCallSettings<StopInstanceRequest,Instance, stopInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to stopInstance. -
resetInstanceSettings
Returns the object with the settings used for calls to resetInstance. -
resetInstanceOperationSettings
public OperationCallSettings<ResetInstanceRequest,Instance, resetInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to resetInstance. -
reportInstanceInfoSettings
Returns the object with the settings used for calls to reportInstanceInfo. -
reportInstanceInfoOperationSettings
public OperationCallSettings<ReportInstanceInfoRequest,Instance, reportInstanceInfoOperationSettings()OperationMetadata> Returns the object with the settings used for calls to reportInstanceInfo. -
isInstanceUpgradeableSettings
public UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> isInstanceUpgradeableSettings()Returns the object with the settings used for calls to isInstanceUpgradeable. -
getInstanceHealthSettings
public UnaryCallSettings<GetInstanceHealthRequest,GetInstanceHealthResponse> getInstanceHealthSettings()Returns the object with the settings used for calls to getInstanceHealth. -
upgradeInstanceSettings
Returns the object with the settings used for calls to upgradeInstance. -
upgradeInstanceOperationSettings
public OperationCallSettings<UpgradeInstanceRequest,Instance, upgradeInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to upgradeInstance. -
rollbackInstanceSettings
Returns the object with the settings used for calls to rollbackInstance. -
rollbackInstanceOperationSettings
public OperationCallSettings<RollbackInstanceRequest,Instance, rollbackInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to rollbackInstance. -
diagnoseInstanceSettings
Returns the object with the settings used for calls to diagnoseInstance. -
diagnoseInstanceOperationSettings
public OperationCallSettings<DiagnoseInstanceRequest,Instance, diagnoseInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to diagnoseInstance. -
upgradeInstanceInternalSettings
public UnaryCallSettings<UpgradeInstanceInternalRequest,Operation> upgradeInstanceInternalSettings()Returns the object with the settings used for calls to upgradeInstanceInternal. -
upgradeInstanceInternalOperationSettings
public OperationCallSettings<UpgradeInstanceInternalRequest,Instance, upgradeInstanceInternalOperationSettings()OperationMetadata> Returns the object with the settings used for calls to upgradeInstanceInternal. -
listEnvironmentsSettings
public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse, listEnvironmentsSettings()NotebookServiceClient.ListEnvironmentsPagedResponse> Returns the object with the settings used for calls to listEnvironments. -
getEnvironmentSettings
Returns the object with the settings used for calls to getEnvironment. -
createEnvironmentSettings
Returns the object with the settings used for calls to createEnvironment. -
createEnvironmentOperationSettings
public OperationCallSettings<CreateEnvironmentRequest,Environment, createEnvironmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createEnvironment. -
deleteEnvironmentSettings
Returns the object with the settings used for calls to deleteEnvironment. -
deleteEnvironmentOperationSettings
public OperationCallSettings<DeleteEnvironmentRequest,com.google.protobuf.Empty, deleteEnvironmentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteEnvironment. -
listSchedulesSettings
public PagedCallSettings<ListSchedulesRequest,ListSchedulesResponse, listSchedulesSettings()NotebookServiceClient.ListSchedulesPagedResponse> Returns the object with the settings used for calls to listSchedules. -
getScheduleSettings
Returns the object with the settings used for calls to getSchedule. -
deleteScheduleSettings
Returns the object with the settings used for calls to deleteSchedule. -
deleteScheduleOperationSettings
public OperationCallSettings<DeleteScheduleRequest,com.google.protobuf.Empty, deleteScheduleOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteSchedule. -
createScheduleSettings
Returns the object with the settings used for calls to createSchedule. -
createScheduleOperationSettings
public OperationCallSettings<CreateScheduleRequest,Schedule, createScheduleOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createSchedule. -
triggerScheduleSettings
Returns the object with the settings used for calls to triggerSchedule. -
triggerScheduleOperationSettings
public OperationCallSettings<TriggerScheduleRequest,Schedule, triggerScheduleOperationSettings()OperationMetadata> Returns the object with the settings used for calls to triggerSchedule. -
listExecutionsSettings
public PagedCallSettings<ListExecutionsRequest,ListExecutionsResponse, listExecutionsSettings()NotebookServiceClient.ListExecutionsPagedResponse> Returns the object with the settings used for calls to listExecutions. -
getExecutionSettings
Returns the object with the settings used for calls to getExecution. -
deleteExecutionSettings
Returns the object with the settings used for calls to deleteExecution. -
deleteExecutionOperationSettings
public OperationCallSettings<DeleteExecutionRequest,com.google.protobuf.Empty, deleteExecutionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteExecution. -
createExecutionSettings
Returns the object with the settings used for calls to createExecution. -
createExecutionOperationSettings
public OperationCallSettings<CreateExecutionRequest,Execution, createExecutionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createExecution. -
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>
-