com.google.cloud.aiplatform.v1beta1.NotebookServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-aiplatform Show documentation
/*
* 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.aiplatform.v1beta1;
import static com.google.cloud.aiplatform.v1beta1.NotebookServiceClient.ListLocationsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.NotebookServiceClient.ListNotebookExecutionJobsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.NotebookServiceClient.ListNotebookRuntimesPagedResponse;
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.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.aiplatform.v1beta1.stub.NotebookServiceStubSettings;
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.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 (aiplatform.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 getNotebookRuntimeTemplate to 30 seconds:
*
*
{@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
* .getNotebookRuntimeTemplateSettings()
* .setRetrySettings(
* notebookServiceSettingsBuilder
* .getNotebookRuntimeTemplateSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class NotebookServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createNotebookRuntimeTemplate. */
public UnaryCallSettings
createNotebookRuntimeTemplateSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.createNotebookRuntimeTemplateSettings();
}
/** Returns the object with the settings used for calls to createNotebookRuntimeTemplate. */
public OperationCallSettings<
CreateNotebookRuntimeTemplateRequest,
NotebookRuntimeTemplate,
CreateNotebookRuntimeTemplateOperationMetadata>
createNotebookRuntimeTemplateOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.createNotebookRuntimeTemplateOperationSettings();
}
/** Returns the object with the settings used for calls to getNotebookRuntimeTemplate. */
public UnaryCallSettings
getNotebookRuntimeTemplateSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).getNotebookRuntimeTemplateSettings();
}
/** Returns the object with the settings used for calls to listNotebookRuntimeTemplates. */
public PagedCallSettings<
ListNotebookRuntimeTemplatesRequest,
ListNotebookRuntimeTemplatesResponse,
ListNotebookRuntimeTemplatesPagedResponse>
listNotebookRuntimeTemplatesSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).listNotebookRuntimeTemplatesSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate. */
public UnaryCallSettings
deleteNotebookRuntimeTemplateSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.deleteNotebookRuntimeTemplateSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate. */
public OperationCallSettings
deleteNotebookRuntimeTemplateOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.deleteNotebookRuntimeTemplateOperationSettings();
}
/** Returns the object with the settings used for calls to updateNotebookRuntimeTemplate. */
public UnaryCallSettings
updateNotebookRuntimeTemplateSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.updateNotebookRuntimeTemplateSettings();
}
/** Returns the object with the settings used for calls to assignNotebookRuntime. */
public UnaryCallSettings
assignNotebookRuntimeSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).assignNotebookRuntimeSettings();
}
/** Returns the object with the settings used for calls to assignNotebookRuntime. */
public OperationCallSettings<
AssignNotebookRuntimeRequest, NotebookRuntime, AssignNotebookRuntimeOperationMetadata>
assignNotebookRuntimeOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.assignNotebookRuntimeOperationSettings();
}
/** Returns the object with the settings used for calls to getNotebookRuntime. */
public UnaryCallSettings
getNotebookRuntimeSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).getNotebookRuntimeSettings();
}
/** Returns the object with the settings used for calls to listNotebookRuntimes. */
public PagedCallSettings<
ListNotebookRuntimesRequest,
ListNotebookRuntimesResponse,
ListNotebookRuntimesPagedResponse>
listNotebookRuntimesSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).listNotebookRuntimesSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookRuntime. */
public UnaryCallSettings
deleteNotebookRuntimeSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).deleteNotebookRuntimeSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookRuntime. */
public OperationCallSettings
deleteNotebookRuntimeOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.deleteNotebookRuntimeOperationSettings();
}
/** Returns the object with the settings used for calls to upgradeNotebookRuntime. */
public UnaryCallSettings
upgradeNotebookRuntimeSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).upgradeNotebookRuntimeSettings();
}
/** Returns the object with the settings used for calls to upgradeNotebookRuntime. */
public OperationCallSettings<
UpgradeNotebookRuntimeRequest,
UpgradeNotebookRuntimeResponse,
UpgradeNotebookRuntimeOperationMetadata>
upgradeNotebookRuntimeOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.upgradeNotebookRuntimeOperationSettings();
}
/** Returns the object with the settings used for calls to startNotebookRuntime. */
public UnaryCallSettings startNotebookRuntimeSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).startNotebookRuntimeSettings();
}
/** Returns the object with the settings used for calls to startNotebookRuntime. */
public OperationCallSettings<
StartNotebookRuntimeRequest,
StartNotebookRuntimeResponse,
StartNotebookRuntimeOperationMetadata>
startNotebookRuntimeOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.startNotebookRuntimeOperationSettings();
}
/** Returns the object with the settings used for calls to createNotebookExecutionJob. */
public UnaryCallSettings
createNotebookExecutionJobSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).createNotebookExecutionJobSettings();
}
/** Returns the object with the settings used for calls to createNotebookExecutionJob. */
public OperationCallSettings<
CreateNotebookExecutionJobRequest,
NotebookExecutionJob,
CreateNotebookExecutionJobOperationMetadata>
createNotebookExecutionJobOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.createNotebookExecutionJobOperationSettings();
}
/** Returns the object with the settings used for calls to getNotebookExecutionJob. */
public UnaryCallSettings
getNotebookExecutionJobSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).getNotebookExecutionJobSettings();
}
/** Returns the object with the settings used for calls to listNotebookExecutionJobs. */
public PagedCallSettings<
ListNotebookExecutionJobsRequest,
ListNotebookExecutionJobsResponse,
ListNotebookExecutionJobsPagedResponse>
listNotebookExecutionJobsSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).listNotebookExecutionJobsSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookExecutionJob. */
public UnaryCallSettings
deleteNotebookExecutionJobSettings() {
return ((NotebookServiceStubSettings) getStubSettings()).deleteNotebookExecutionJobSettings();
}
/** Returns the object with the settings used for calls to deleteNotebookExecutionJob. */
public OperationCallSettings
deleteNotebookExecutionJobOperationSettings() {
return ((NotebookServiceStubSettings) getStubSettings())
.deleteNotebookExecutionJobOperationSettings();
}
/** 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 ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return NotebookServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return NotebookServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return NotebookServiceStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** 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());
}
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 createNotebookRuntimeTemplate. */
public UnaryCallSettings.Builder
createNotebookRuntimeTemplateSettings() {
return getStubSettingsBuilder().createNotebookRuntimeTemplateSettings();
}
/** Returns the builder for the settings used for calls to createNotebookRuntimeTemplate. */
public OperationCallSettings.Builder<
CreateNotebookRuntimeTemplateRequest,
NotebookRuntimeTemplate,
CreateNotebookRuntimeTemplateOperationMetadata>
createNotebookRuntimeTemplateOperationSettings() {
return getStubSettingsBuilder().createNotebookRuntimeTemplateOperationSettings();
}
/** Returns the builder for the settings used for calls to getNotebookRuntimeTemplate. */
public UnaryCallSettings.Builder
getNotebookRuntimeTemplateSettings() {
return getStubSettingsBuilder().getNotebookRuntimeTemplateSettings();
}
/** Returns the builder for the settings used for calls to listNotebookRuntimeTemplates. */
public PagedCallSettings.Builder<
ListNotebookRuntimeTemplatesRequest,
ListNotebookRuntimeTemplatesResponse,
ListNotebookRuntimeTemplatesPagedResponse>
listNotebookRuntimeTemplatesSettings() {
return getStubSettingsBuilder().listNotebookRuntimeTemplatesSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookRuntimeTemplate. */
public UnaryCallSettings.Builder
deleteNotebookRuntimeTemplateSettings() {
return getStubSettingsBuilder().deleteNotebookRuntimeTemplateSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookRuntimeTemplate. */
public OperationCallSettings.Builder<
DeleteNotebookRuntimeTemplateRequest, Empty, DeleteOperationMetadata>
deleteNotebookRuntimeTemplateOperationSettings() {
return getStubSettingsBuilder().deleteNotebookRuntimeTemplateOperationSettings();
}
/** Returns the builder for the settings used for calls to updateNotebookRuntimeTemplate. */
public UnaryCallSettings.Builder
updateNotebookRuntimeTemplateSettings() {
return getStubSettingsBuilder().updateNotebookRuntimeTemplateSettings();
}
/** Returns the builder for the settings used for calls to assignNotebookRuntime. */
public UnaryCallSettings.Builder
assignNotebookRuntimeSettings() {
return getStubSettingsBuilder().assignNotebookRuntimeSettings();
}
/** Returns the builder for the settings used for calls to assignNotebookRuntime. */
public OperationCallSettings.Builder<
AssignNotebookRuntimeRequest, NotebookRuntime, AssignNotebookRuntimeOperationMetadata>
assignNotebookRuntimeOperationSettings() {
return getStubSettingsBuilder().assignNotebookRuntimeOperationSettings();
}
/** Returns the builder for the settings used for calls to getNotebookRuntime. */
public UnaryCallSettings.Builder
getNotebookRuntimeSettings() {
return getStubSettingsBuilder().getNotebookRuntimeSettings();
}
/** Returns the builder for the settings used for calls to listNotebookRuntimes. */
public PagedCallSettings.Builder<
ListNotebookRuntimesRequest,
ListNotebookRuntimesResponse,
ListNotebookRuntimesPagedResponse>
listNotebookRuntimesSettings() {
return getStubSettingsBuilder().listNotebookRuntimesSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookRuntime. */
public UnaryCallSettings.Builder
deleteNotebookRuntimeSettings() {
return getStubSettingsBuilder().deleteNotebookRuntimeSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookRuntime. */
public OperationCallSettings.Builder<
DeleteNotebookRuntimeRequest, Empty, DeleteOperationMetadata>
deleteNotebookRuntimeOperationSettings() {
return getStubSettingsBuilder().deleteNotebookRuntimeOperationSettings();
}
/** Returns the builder for the settings used for calls to upgradeNotebookRuntime. */
public UnaryCallSettings.Builder
upgradeNotebookRuntimeSettings() {
return getStubSettingsBuilder().upgradeNotebookRuntimeSettings();
}
/** Returns the builder for the settings used for calls to upgradeNotebookRuntime. */
public OperationCallSettings.Builder<
UpgradeNotebookRuntimeRequest,
UpgradeNotebookRuntimeResponse,
UpgradeNotebookRuntimeOperationMetadata>
upgradeNotebookRuntimeOperationSettings() {
return getStubSettingsBuilder().upgradeNotebookRuntimeOperationSettings();
}
/** Returns the builder for the settings used for calls to startNotebookRuntime. */
public UnaryCallSettings.Builder
startNotebookRuntimeSettings() {
return getStubSettingsBuilder().startNotebookRuntimeSettings();
}
/** Returns the builder for the settings used for calls to startNotebookRuntime. */
public OperationCallSettings.Builder<
StartNotebookRuntimeRequest,
StartNotebookRuntimeResponse,
StartNotebookRuntimeOperationMetadata>
startNotebookRuntimeOperationSettings() {
return getStubSettingsBuilder().startNotebookRuntimeOperationSettings();
}
/** Returns the builder for the settings used for calls to createNotebookExecutionJob. */
public UnaryCallSettings.Builder
createNotebookExecutionJobSettings() {
return getStubSettingsBuilder().createNotebookExecutionJobSettings();
}
/** Returns the builder for the settings used for calls to createNotebookExecutionJob. */
public OperationCallSettings.Builder<
CreateNotebookExecutionJobRequest,
NotebookExecutionJob,
CreateNotebookExecutionJobOperationMetadata>
createNotebookExecutionJobOperationSettings() {
return getStubSettingsBuilder().createNotebookExecutionJobOperationSettings();
}
/** Returns the builder for the settings used for calls to getNotebookExecutionJob. */
public UnaryCallSettings.Builder
getNotebookExecutionJobSettings() {
return getStubSettingsBuilder().getNotebookExecutionJobSettings();
}
/** Returns the builder for the settings used for calls to listNotebookExecutionJobs. */
public PagedCallSettings.Builder<
ListNotebookExecutionJobsRequest,
ListNotebookExecutionJobsResponse,
ListNotebookExecutionJobsPagedResponse>
listNotebookExecutionJobsSettings() {
return getStubSettingsBuilder().listNotebookExecutionJobsSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookExecutionJob. */
public UnaryCallSettings.Builder
deleteNotebookExecutionJobSettings() {
return getStubSettingsBuilder().deleteNotebookExecutionJobSettings();
}
/** Returns the builder for the settings used for calls to deleteNotebookExecutionJob. */
public OperationCallSettings.Builder<
DeleteNotebookExecutionJobRequest, Empty, DeleteOperationMetadata>
deleteNotebookExecutionJobOperationSettings() {
return getStubSettingsBuilder().deleteNotebookExecutionJobOperationSettings();
}
/** 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);
}
}
}