All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.cloud.notebooks.v2.NotebookServiceSettings Maven / Gradle / Ivy

Go to download

is a managed service that offers an integrated and secure JupyterLab environment for data scientists and machine learning developers to experiment, develop, and deploy models into production. Users can create instances running JupyterLab that come pre-installed with the latest data science and machine learning frameworks in a single click.

There is a newer version: 1.53.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.notebooks.v2;

import static com.google.cloud.notebooks.v2.NotebookServiceClient.ListInstancesPagedResponse;
import static com.google.cloud.notebooks.v2.NotebookServiceClient.ListLocationsPagedResponse;

import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.OperationCallSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.cloud.notebooks.v2.stub.NotebookServiceStubSettings;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Settings class to configure an instance of {@link 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: * *

{@code
 * // 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://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 createInstance: * *

{@code
 * // 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();
 * }
*/ @Generated("by gapic-generator-java") public class NotebookServiceSettings extends ClientSettings { /** Returns the object with the settings used for calls to listInstances. */ public PagedCallSettings listInstancesSettings() { return ((NotebookServiceStubSettings) getStubSettings()).listInstancesSettings(); } /** Returns the object with the settings used for calls to getInstance. */ public UnaryCallSettings getInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).getInstanceSettings(); } /** Returns the object with the settings used for calls to createInstance. */ public UnaryCallSettings createInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).createInstanceSettings(); } /** Returns the object with the settings used for calls to createInstance. */ public OperationCallSettings createInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).createInstanceOperationSettings(); } /** Returns the object with the settings used for calls to updateInstance. */ public UnaryCallSettings updateInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).updateInstanceSettings(); } /** Returns the object with the settings used for calls to updateInstance. */ public OperationCallSettings updateInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).updateInstanceOperationSettings(); } /** Returns the object with the settings used for calls to deleteInstance. */ public UnaryCallSettings deleteInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).deleteInstanceSettings(); } /** Returns the object with the settings used for calls to deleteInstance. */ public OperationCallSettings deleteInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).deleteInstanceOperationSettings(); } /** Returns the object with the settings used for calls to startInstance. */ public UnaryCallSettings startInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).startInstanceSettings(); } /** Returns the object with the settings used for calls to startInstance. */ public OperationCallSettings startInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).startInstanceOperationSettings(); } /** Returns the object with the settings used for calls to stopInstance. */ public UnaryCallSettings stopInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).stopInstanceSettings(); } /** Returns the object with the settings used for calls to stopInstance. */ public OperationCallSettings stopInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).stopInstanceOperationSettings(); } /** Returns the object with the settings used for calls to resetInstance. */ public UnaryCallSettings resetInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).resetInstanceSettings(); } /** Returns the object with the settings used for calls to resetInstance. */ public OperationCallSettings resetInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).resetInstanceOperationSettings(); } /** Returns the object with the settings used for calls to checkInstanceUpgradability. */ public UnaryCallSettings checkInstanceUpgradabilitySettings() { return ((NotebookServiceStubSettings) getStubSettings()).checkInstanceUpgradabilitySettings(); } /** Returns the object with the settings used for calls to upgradeInstance. */ public UnaryCallSettings upgradeInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).upgradeInstanceSettings(); } /** Returns the object with the settings used for calls to upgradeInstance. */ public OperationCallSettings upgradeInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).upgradeInstanceOperationSettings(); } /** Returns the object with the settings used for calls to rollbackInstance. */ public UnaryCallSettings rollbackInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).rollbackInstanceSettings(); } /** Returns the object with the settings used for calls to rollbackInstance. */ public OperationCallSettings rollbackInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).rollbackInstanceOperationSettings(); } /** Returns the object with the settings used for calls to diagnoseInstance. */ public UnaryCallSettings diagnoseInstanceSettings() { return ((NotebookServiceStubSettings) getStubSettings()).diagnoseInstanceSettings(); } /** Returns the object with the settings used for calls to diagnoseInstance. */ public OperationCallSettings diagnoseInstanceOperationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).diagnoseInstanceOperationSettings(); } /** Returns the object with the settings used for calls to listLocations. */ public PagedCallSettings listLocationsSettings() { return ((NotebookServiceStubSettings) getStubSettings()).listLocationsSettings(); } /** Returns the object with the settings used for calls to getLocation. */ public UnaryCallSettings getLocationSettings() { return ((NotebookServiceStubSettings) getStubSettings()).getLocationSettings(); } /** Returns the object with the settings used for calls to setIamPolicy. */ public UnaryCallSettings setIamPolicySettings() { return ((NotebookServiceStubSettings) getStubSettings()).setIamPolicySettings(); } /** Returns the object with the settings used for calls to getIamPolicy. */ public UnaryCallSettings getIamPolicySettings() { return ((NotebookServiceStubSettings) getStubSettings()).getIamPolicySettings(); } /** Returns the object with the settings used for calls to testIamPermissions. */ public UnaryCallSettings testIamPermissionsSettings() { return ((NotebookServiceStubSettings) getStubSettings()).testIamPermissionsSettings(); } public static final NotebookServiceSettings create(NotebookServiceStubSettings stub) throws IOException { return new NotebookServiceSettings.Builder(stub.toBuilder()).build(); } /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return NotebookServiceStubSettings.defaultExecutorProviderBuilder(); } /** Returns the default service endpoint. */ public static String getDefaultEndpoint() { return NotebookServiceStubSettings.getDefaultEndpoint(); } /** Returns the default service scopes. */ public static List getDefaultServiceScopes() { return NotebookServiceStubSettings.getDefaultServiceScopes(); } /** Returns a builder for the default credentials for this service. */ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { return NotebookServiceStubSettings.defaultCredentialsProviderBuilder(); } /** Returns a builder for the default gRPC ChannelProvider for this service. */ public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { return NotebookServiceStubSettings.defaultGrpcTransportProviderBuilder(); } /** Returns a builder for the default REST ChannelProvider for this service. */ @BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder() { return NotebookServiceStubSettings.defaultHttpJsonTransportProviderBuilder(); } public static TransportChannelProvider defaultTransportChannelProvider() { return NotebookServiceStubSettings.defaultTransportChannelProvider(); } public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { return NotebookServiceStubSettings.defaultApiClientHeaderProviderBuilder(); } /** Returns a new gRPC builder for this class. */ public static Builder newBuilder() { return Builder.createDefault(); } /** Returns a new REST builder for this class. */ public static Builder newHttpJsonBuilder() { return Builder.createHttpJsonDefault(); } /** Returns a new builder for this class. */ public static Builder newBuilder(ClientContext clientContext) { return new Builder(clientContext); } /** Returns a builder containing all the values of this settings class. */ public Builder toBuilder() { return new Builder(this); } protected NotebookServiceSettings(Builder settingsBuilder) throws IOException { super(settingsBuilder); } /** Builder for NotebookServiceSettings. */ public static class Builder extends ClientSettings.Builder { protected Builder() throws IOException { this(((ClientContext) null)); } protected Builder(ClientContext clientContext) { super(NotebookServiceStubSettings.newBuilder(clientContext)); } protected Builder(NotebookServiceSettings settings) { super(settings.getStubSettings().toBuilder()); } protected Builder(NotebookServiceStubSettings.Builder stubSettings) { super(stubSettings); } private static Builder createDefault() { return new Builder(NotebookServiceStubSettings.newBuilder()); } private static Builder createHttpJsonDefault() { return new Builder(NotebookServiceStubSettings.newHttpJsonBuilder()); } public NotebookServiceStubSettings.Builder getStubSettingsBuilder() { return ((NotebookServiceStubSettings.Builder) getStubSettings()); } /** * Applies the given settings updater function to all of the unary API methods in this service. * *

Note: This method does not support applying settings to streaming methods. */ public Builder applyToAllUnaryMethods( ApiFunction, Void> settingsUpdater) { super.applyToAllUnaryMethods( getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); return this; } /** Returns the builder for the settings used for calls to listInstances. */ public PagedCallSettings.Builder< ListInstancesRequest, ListInstancesResponse, ListInstancesPagedResponse> listInstancesSettings() { return getStubSettingsBuilder().listInstancesSettings(); } /** Returns the builder for the settings used for calls to getInstance. */ public UnaryCallSettings.Builder getInstanceSettings() { return getStubSettingsBuilder().getInstanceSettings(); } /** Returns the builder for the settings used for calls to createInstance. */ public UnaryCallSettings.Builder createInstanceSettings() { return getStubSettingsBuilder().createInstanceSettings(); } /** Returns the builder for the settings used for calls to createInstance. */ public OperationCallSettings.Builder createInstanceOperationSettings() { return getStubSettingsBuilder().createInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to updateInstance. */ public UnaryCallSettings.Builder updateInstanceSettings() { return getStubSettingsBuilder().updateInstanceSettings(); } /** Returns the builder for the settings used for calls to updateInstance. */ public OperationCallSettings.Builder updateInstanceOperationSettings() { return getStubSettingsBuilder().updateInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to deleteInstance. */ public UnaryCallSettings.Builder deleteInstanceSettings() { return getStubSettingsBuilder().deleteInstanceSettings(); } /** Returns the builder for the settings used for calls to deleteInstance. */ public OperationCallSettings.Builder deleteInstanceOperationSettings() { return getStubSettingsBuilder().deleteInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to startInstance. */ public UnaryCallSettings.Builder startInstanceSettings() { return getStubSettingsBuilder().startInstanceSettings(); } /** Returns the builder for the settings used for calls to startInstance. */ public OperationCallSettings.Builder startInstanceOperationSettings() { return getStubSettingsBuilder().startInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to stopInstance. */ public UnaryCallSettings.Builder stopInstanceSettings() { return getStubSettingsBuilder().stopInstanceSettings(); } /** Returns the builder for the settings used for calls to stopInstance. */ public OperationCallSettings.Builder stopInstanceOperationSettings() { return getStubSettingsBuilder().stopInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to resetInstance. */ public UnaryCallSettings.Builder resetInstanceSettings() { return getStubSettingsBuilder().resetInstanceSettings(); } /** Returns the builder for the settings used for calls to resetInstance. */ public OperationCallSettings.Builder resetInstanceOperationSettings() { return getStubSettingsBuilder().resetInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to checkInstanceUpgradability. */ public UnaryCallSettings.Builder< CheckInstanceUpgradabilityRequest, CheckInstanceUpgradabilityResponse> checkInstanceUpgradabilitySettings() { return getStubSettingsBuilder().checkInstanceUpgradabilitySettings(); } /** Returns the builder for the settings used for calls to upgradeInstance. */ public UnaryCallSettings.Builder upgradeInstanceSettings() { return getStubSettingsBuilder().upgradeInstanceSettings(); } /** Returns the builder for the settings used for calls to upgradeInstance. */ public OperationCallSettings.Builder upgradeInstanceOperationSettings() { return getStubSettingsBuilder().upgradeInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to rollbackInstance. */ public UnaryCallSettings.Builder rollbackInstanceSettings() { return getStubSettingsBuilder().rollbackInstanceSettings(); } /** Returns the builder for the settings used for calls to rollbackInstance. */ public OperationCallSettings.Builder rollbackInstanceOperationSettings() { return getStubSettingsBuilder().rollbackInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to diagnoseInstance. */ public UnaryCallSettings.Builder diagnoseInstanceSettings() { return getStubSettingsBuilder().diagnoseInstanceSettings(); } /** Returns the builder for the settings used for calls to diagnoseInstance. */ public OperationCallSettings.Builder diagnoseInstanceOperationSettings() { return getStubSettingsBuilder().diagnoseInstanceOperationSettings(); } /** Returns the builder for the settings used for calls to listLocations. */ public PagedCallSettings.Builder< ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse> listLocationsSettings() { return getStubSettingsBuilder().listLocationsSettings(); } /** Returns the builder for the settings used for calls to getLocation. */ public UnaryCallSettings.Builder getLocationSettings() { return getStubSettingsBuilder().getLocationSettings(); } /** Returns the builder for the settings used for calls to setIamPolicy. */ public UnaryCallSettings.Builder setIamPolicySettings() { return getStubSettingsBuilder().setIamPolicySettings(); } /** Returns the builder for the settings used for calls to getIamPolicy. */ public UnaryCallSettings.Builder getIamPolicySettings() { return getStubSettingsBuilder().getIamPolicySettings(); } /** Returns the builder for the settings used for calls to testIamPermissions. */ public UnaryCallSettings.Builder testIamPermissionsSettings() { return getStubSettingsBuilder().testIamPermissionsSettings(); } @Override public NotebookServiceSettings build() throws IOException { return new NotebookServiceSettings(this); } } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy