- 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 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 total timeout of getInstance to 30 seconds:
// 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()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
Static Methods
create(NotebookServiceStubSettings stub)
public static final NotebookServiceSettings create(NotebookServiceStubSettings stub)| Name | Description |
| stub | NotebookServiceStubSettings |
| Type | Description |
| NotebookServiceSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static NotebookServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| NotebookServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static NotebookServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| NotebookServiceSettings.Builder |
Constructors
NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)
protected NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | NotebookServiceSettings.Builder |
Methods
createEnvironmentOperationSettings()
public OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationSettings()Returns the object with the settings used for calls to createEnvironment.
| Type | Description |
| OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> |
createEnvironmentSettings()
public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()Returns the object with the settings used for calls to createEnvironment.
| Type | Description |
| UnaryCallSettings<CreateEnvironmentRequest,Operation> |
createInstanceOperationSettings()
public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()Returns the object with the settings used for calls to createInstance.
| Type | Description |
| OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> |
createInstanceSettings()
public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()Returns the object with the settings used for calls to createInstance.
| Type | Description |
| UnaryCallSettings<CreateInstanceRequest,Operation> |
deleteEnvironmentOperationSettings()
public OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationSettings()Returns the object with the settings used for calls to deleteEnvironment.
| Type | Description |
| OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata> |
deleteEnvironmentSettings()
public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()Returns the object with the settings used for calls to deleteEnvironment.
| Type | Description |
| UnaryCallSettings<DeleteEnvironmentRequest,Operation> |
deleteInstanceOperationSettings()
public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()Returns the object with the settings used for calls to deleteInstance.
| Type | Description |
| OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> |
deleteInstanceSettings()
public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()Returns the object with the settings used for calls to deleteInstance.
| Type | Description |
| UnaryCallSettings<DeleteInstanceRequest,Operation> |
getEnvironmentSettings()
public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()Returns the object with the settings used for calls to getEnvironment.
| Type | Description |
| UnaryCallSettings<GetEnvironmentRequest,Environment> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| Type | Description |
| UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Type | Description |
| UnaryCallSettings<GetInstanceRequest,Instance> |
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Type | Description |
| UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
isInstanceUpgradeableSettings() (deprecated)
public UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> isInstanceUpgradeableSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to isInstanceUpgradeable.
| Type | Description |
| UnaryCallSettings<IsInstanceUpgradeableRequest,IsInstanceUpgradeableResponse> |
listEnvironmentsSettings()
public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,NotebookServiceClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()Returns the object with the settings used for calls to listEnvironments.
| Type | Description |
| PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse> |
listInstancesSettings()
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,NotebookServiceClient.ListInstancesPagedResponse> listInstancesSettings()Returns the object with the settings used for calls to listInstances.
| Type | Description |
| PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse> |
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,NotebookServiceClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Type | Description |
| PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
registerInstanceOperationSettings()
public OperationCallSettings<RegisterInstanceRequest,Instance,OperationMetadata> registerInstanceOperationSettings()Returns the object with the settings used for calls to registerInstance.
| Type | Description |
| OperationCallSettings<RegisterInstanceRequest,Instance,OperationMetadata> |
registerInstanceSettings()
public UnaryCallSettings<RegisterInstanceRequest,Operation> registerInstanceSettings()Returns the object with the settings used for calls to registerInstance.
| Type | Description |
| UnaryCallSettings<RegisterInstanceRequest,Operation> |
reportInstanceInfoOperationSettings()
public OperationCallSettings<ReportInstanceInfoRequest,Instance,OperationMetadata> reportInstanceInfoOperationSettings()Returns the object with the settings used for calls to reportInstanceInfo.
| Type | Description |
| OperationCallSettings<ReportInstanceInfoRequest,Instance,OperationMetadata> |
reportInstanceInfoSettings()
public UnaryCallSettings<ReportInstanceInfoRequest,Operation> reportInstanceInfoSettings()Returns the object with the settings used for calls to reportInstanceInfo.
| Type | Description |
| UnaryCallSettings<ReportInstanceInfoRequest,Operation> |
resetInstanceOperationSettings()
public OperationCallSettings<ResetInstanceRequest,Instance,OperationMetadata> resetInstanceOperationSettings()Returns the object with the settings used for calls to resetInstance.
| Type | Description |
| OperationCallSettings<ResetInstanceRequest,Instance,OperationMetadata> |
resetInstanceSettings()
public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()Returns the object with the settings used for calls to resetInstance.
| Type | Description |
| UnaryCallSettings<ResetInstanceRequest,Operation> |
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| Type | Description |
| UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
setInstanceAcceleratorOperationSettings()
public OperationCallSettings<SetInstanceAcceleratorRequest,Instance,OperationMetadata> setInstanceAcceleratorOperationSettings()Returns the object with the settings used for calls to setInstanceAccelerator.
| Type | Description |
| OperationCallSettings<SetInstanceAcceleratorRequest,Instance,OperationMetadata> |
setInstanceAcceleratorSettings()
public UnaryCallSettings<SetInstanceAcceleratorRequest,Operation> setInstanceAcceleratorSettings()Returns the object with the settings used for calls to setInstanceAccelerator.
| Type | Description |
| UnaryCallSettings<SetInstanceAcceleratorRequest,Operation> |
setInstanceLabelsOperationSettings()
public OperationCallSettings<SetInstanceLabelsRequest,Instance,OperationMetadata> setInstanceLabelsOperationSettings()Returns the object with the settings used for calls to setInstanceLabels.
| Type | Description |
| OperationCallSettings<SetInstanceLabelsRequest,Instance,OperationMetadata> |
setInstanceLabelsSettings()
public UnaryCallSettings<SetInstanceLabelsRequest,Operation> setInstanceLabelsSettings()Returns the object with the settings used for calls to setInstanceLabels.
| Type | Description |
| UnaryCallSettings<SetInstanceLabelsRequest,Operation> |
setInstanceMachineTypeOperationSettings()
public OperationCallSettings<SetInstanceMachineTypeRequest,Instance,OperationMetadata> setInstanceMachineTypeOperationSettings()Returns the object with the settings used for calls to setInstanceMachineType.
| Type | Description |
| OperationCallSettings<SetInstanceMachineTypeRequest,Instance,OperationMetadata> |
setInstanceMachineTypeSettings()
public UnaryCallSettings<SetInstanceMachineTypeRequest,Operation> setInstanceMachineTypeSettings()Returns the object with the settings used for calls to setInstanceMachineType.
| Type | Description |
| UnaryCallSettings<SetInstanceMachineTypeRequest,Operation> |
startInstanceOperationSettings()
public OperationCallSettings<StartInstanceRequest,Instance,OperationMetadata> startInstanceOperationSettings()Returns the object with the settings used for calls to startInstance.
| Type | Description |
| OperationCallSettings<StartInstanceRequest,Instance,OperationMetadata> |
startInstanceSettings()
public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()Returns the object with the settings used for calls to startInstance.
| Type | Description |
| UnaryCallSettings<StartInstanceRequest,Operation> |
stopInstanceOperationSettings()
public OperationCallSettings<StopInstanceRequest,Instance,OperationMetadata> stopInstanceOperationSettings()Returns the object with the settings used for calls to stopInstance.
| Type | Description |
| OperationCallSettings<StopInstanceRequest,Instance,OperationMetadata> |
stopInstanceSettings()
public UnaryCallSettings<StopInstanceRequest,Operation> stopInstanceSettings()Returns the object with the settings used for calls to stopInstance.
| Type | Description |
| UnaryCallSettings<StopInstanceRequest,Operation> |
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions.
| 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.
| Type | Description |
| NotebookServiceSettings.Builder |
upgradeInstanceInternalOperationSettings() (deprecated)
public OperationCallSettings<UpgradeInstanceInternalRequest,Instance,OperationMetadata> upgradeInstanceInternalOperationSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to upgradeInstanceInternal.
| Type | Description |
| OperationCallSettings<UpgradeInstanceInternalRequest,Instance,OperationMetadata> |
upgradeInstanceInternalSettings() (deprecated)
public UnaryCallSettings<UpgradeInstanceInternalRequest,Operation> upgradeInstanceInternalSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to upgradeInstanceInternal.
| Type | Description |
| UnaryCallSettings<UpgradeInstanceInternalRequest,Operation> |
upgradeInstanceOperationSettings() (deprecated)
public OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata> upgradeInstanceOperationSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to upgradeInstance.
| Type | Description |
| OperationCallSettings<UpgradeInstanceRequest,Instance,OperationMetadata> |
upgradeInstanceSettings() (deprecated)
public UnaryCallSettings<UpgradeInstanceRequest,Operation> upgradeInstanceSettings()Deprecated. This method is deprecated and will be removed in the next major version update.
Returns the object with the settings used for calls to upgradeInstance.
| Type | Description |
| UnaryCallSettings<UpgradeInstanceRequest,Operation> |