com.google.cloud.spanner.admin.database.v1.DatabaseAdminSettings Maven / Gradle / Ivy
Show all versions of google-cloud-spanner 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.spanner.admin.database.v1;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListBackupOperationsPagedResponse;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListBackupSchedulesPagedResponse;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListBackupsPagedResponse;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListDatabaseOperationsPagedResponse;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListDatabaseRolesPagedResponse;
import static com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.ListDatabasesPagedResponse;
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.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
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 com.google.spanner.admin.database.v1.Backup;
import com.google.spanner.admin.database.v1.BackupSchedule;
import com.google.spanner.admin.database.v1.CopyBackupMetadata;
import com.google.spanner.admin.database.v1.CopyBackupRequest;
import com.google.spanner.admin.database.v1.CreateBackupMetadata;
import com.google.spanner.admin.database.v1.CreateBackupRequest;
import com.google.spanner.admin.database.v1.CreateBackupScheduleRequest;
import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
import com.google.spanner.admin.database.v1.Database;
import com.google.spanner.admin.database.v1.DeleteBackupRequest;
import com.google.spanner.admin.database.v1.DeleteBackupScheduleRequest;
import com.google.spanner.admin.database.v1.DropDatabaseRequest;
import com.google.spanner.admin.database.v1.GetBackupRequest;
import com.google.spanner.admin.database.v1.GetBackupScheduleRequest;
import com.google.spanner.admin.database.v1.GetDatabaseDdlRequest;
import com.google.spanner.admin.database.v1.GetDatabaseDdlResponse;
import com.google.spanner.admin.database.v1.GetDatabaseRequest;
import com.google.spanner.admin.database.v1.ListBackupOperationsRequest;
import com.google.spanner.admin.database.v1.ListBackupOperationsResponse;
import com.google.spanner.admin.database.v1.ListBackupSchedulesRequest;
import com.google.spanner.admin.database.v1.ListBackupSchedulesResponse;
import com.google.spanner.admin.database.v1.ListBackupsRequest;
import com.google.spanner.admin.database.v1.ListBackupsResponse;
import com.google.spanner.admin.database.v1.ListDatabaseOperationsRequest;
import com.google.spanner.admin.database.v1.ListDatabaseOperationsResponse;
import com.google.spanner.admin.database.v1.ListDatabaseRolesRequest;
import com.google.spanner.admin.database.v1.ListDatabaseRolesResponse;
import com.google.spanner.admin.database.v1.ListDatabasesRequest;
import com.google.spanner.admin.database.v1.ListDatabasesResponse;
import com.google.spanner.admin.database.v1.RestoreDatabaseMetadata;
import com.google.spanner.admin.database.v1.RestoreDatabaseRequest;
import com.google.spanner.admin.database.v1.UpdateBackupRequest;
import com.google.spanner.admin.database.v1.UpdateBackupScheduleRequest;
import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
import com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest;
import com.google.spanner.admin.database.v1.UpdateDatabaseMetadata;
import com.google.spanner.admin.database.v1.UpdateDatabaseRequest;
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 DatabaseAdminClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (spanner.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 getDatabase 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
* DatabaseAdminSettings.Builder databaseAdminSettingsBuilder = DatabaseAdminSettings.newBuilder();
* databaseAdminSettingsBuilder
* .getDatabaseSettings()
* .setRetrySettings(
* databaseAdminSettingsBuilder
* .getDatabaseSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* DatabaseAdminSettings databaseAdminSettings = databaseAdminSettingsBuilder.build();
* }
*/
@Generated("by gapic-generator-java")
public class DatabaseAdminSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listDatabases. */
public PagedCallSettings
listDatabasesSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listDatabasesSettings();
}
/** Returns the object with the settings used for calls to createDatabase. */
public UnaryCallSettings createDatabaseSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).createDatabaseSettings();
}
/** Returns the object with the settings used for calls to createDatabase. */
public OperationCallSettings
createDatabaseOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).createDatabaseOperationSettings();
}
/** Returns the object with the settings used for calls to getDatabase. */
public UnaryCallSettings getDatabaseSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).getDatabaseSettings();
}
/** Returns the object with the settings used for calls to updateDatabase. */
public UnaryCallSettings updateDatabaseSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateDatabaseSettings();
}
/** Returns the object with the settings used for calls to updateDatabase. */
public OperationCallSettings
updateDatabaseOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateDatabaseOperationSettings();
}
/** Returns the object with the settings used for calls to updateDatabaseDdl. */
public UnaryCallSettings updateDatabaseDdlSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateDatabaseDdlSettings();
}
/** Returns the object with the settings used for calls to updateDatabaseDdl. */
public OperationCallSettings
updateDatabaseDdlOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateDatabaseDdlOperationSettings();
}
/** Returns the object with the settings used for calls to dropDatabase. */
public UnaryCallSettings dropDatabaseSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).dropDatabaseSettings();
}
/** Returns the object with the settings used for calls to getDatabaseDdl. */
public UnaryCallSettings getDatabaseDdlSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).getDatabaseDdlSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).testIamPermissionsSettings();
}
/** Returns the object with the settings used for calls to createBackup. */
public UnaryCallSettings createBackupSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).createBackupSettings();
}
/** Returns the object with the settings used for calls to createBackup. */
public OperationCallSettings
createBackupOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).createBackupOperationSettings();
}
/** Returns the object with the settings used for calls to copyBackup. */
public UnaryCallSettings copyBackupSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).copyBackupSettings();
}
/** Returns the object with the settings used for calls to copyBackup. */
public OperationCallSettings
copyBackupOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).copyBackupOperationSettings();
}
/** Returns the object with the settings used for calls to getBackup. */
public UnaryCallSettings getBackupSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).getBackupSettings();
}
/** Returns the object with the settings used for calls to updateBackup. */
public UnaryCallSettings updateBackupSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateBackupSettings();
}
/** Returns the object with the settings used for calls to deleteBackup. */
public UnaryCallSettings deleteBackupSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).deleteBackupSettings();
}
/** Returns the object with the settings used for calls to listBackups. */
public PagedCallSettings
listBackupsSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listBackupsSettings();
}
/** Returns the object with the settings used for calls to restoreDatabase. */
public UnaryCallSettings restoreDatabaseSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).restoreDatabaseSettings();
}
/** Returns the object with the settings used for calls to restoreDatabase. */
public OperationCallSettings
restoreDatabaseOperationSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).restoreDatabaseOperationSettings();
}
/** Returns the object with the settings used for calls to listDatabaseOperations. */
public PagedCallSettings<
ListDatabaseOperationsRequest,
ListDatabaseOperationsResponse,
ListDatabaseOperationsPagedResponse>
listDatabaseOperationsSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listDatabaseOperationsSettings();
}
/** Returns the object with the settings used for calls to listBackupOperations. */
public PagedCallSettings<
ListBackupOperationsRequest,
ListBackupOperationsResponse,
ListBackupOperationsPagedResponse>
listBackupOperationsSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listBackupOperationsSettings();
}
/** Returns the object with the settings used for calls to listDatabaseRoles. */
public PagedCallSettings<
ListDatabaseRolesRequest, ListDatabaseRolesResponse, ListDatabaseRolesPagedResponse>
listDatabaseRolesSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listDatabaseRolesSettings();
}
/** Returns the object with the settings used for calls to createBackupSchedule. */
public UnaryCallSettings
createBackupScheduleSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).createBackupScheduleSettings();
}
/** Returns the object with the settings used for calls to getBackupSchedule. */
public UnaryCallSettings getBackupScheduleSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).getBackupScheduleSettings();
}
/** Returns the object with the settings used for calls to updateBackupSchedule. */
public UnaryCallSettings
updateBackupScheduleSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).updateBackupScheduleSettings();
}
/** Returns the object with the settings used for calls to deleteBackupSchedule. */
public UnaryCallSettings deleteBackupScheduleSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).deleteBackupScheduleSettings();
}
/** Returns the object with the settings used for calls to listBackupSchedules. */
public PagedCallSettings<
ListBackupSchedulesRequest, ListBackupSchedulesResponse, ListBackupSchedulesPagedResponse>
listBackupSchedulesSettings() {
return ((DatabaseAdminStubSettings) getStubSettings()).listBackupSchedulesSettings();
}
public static final DatabaseAdminSettings create(DatabaseAdminStubSettings stub)
throws IOException {
return new DatabaseAdminSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return DatabaseAdminStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return DatabaseAdminStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return DatabaseAdminStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return DatabaseAdminStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return DatabaseAdminStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return DatabaseAdminStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return DatabaseAdminStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return DatabaseAdminStubSettings.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 DatabaseAdminSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for DatabaseAdminSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(DatabaseAdminStubSettings.newBuilder(clientContext));
}
protected Builder(DatabaseAdminSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(DatabaseAdminStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(DatabaseAdminStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(DatabaseAdminStubSettings.newHttpJsonBuilder());
}
public DatabaseAdminStubSettings.Builder getStubSettingsBuilder() {
return ((DatabaseAdminStubSettings.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 listDatabases. */
public PagedCallSettings.Builder<
ListDatabasesRequest, ListDatabasesResponse, ListDatabasesPagedResponse>
listDatabasesSettings() {
return getStubSettingsBuilder().listDatabasesSettings();
}
/** Returns the builder for the settings used for calls to createDatabase. */
public UnaryCallSettings.Builder createDatabaseSettings() {
return getStubSettingsBuilder().createDatabaseSettings();
}
/** Returns the builder for the settings used for calls to createDatabase. */
public OperationCallSettings.Builder
createDatabaseOperationSettings() {
return getStubSettingsBuilder().createDatabaseOperationSettings();
}
/** Returns the builder for the settings used for calls to getDatabase. */
public UnaryCallSettings.Builder getDatabaseSettings() {
return getStubSettingsBuilder().getDatabaseSettings();
}
/** Returns the builder for the settings used for calls to updateDatabase. */
public UnaryCallSettings.Builder updateDatabaseSettings() {
return getStubSettingsBuilder().updateDatabaseSettings();
}
/** Returns the builder for the settings used for calls to updateDatabase. */
public OperationCallSettings.Builder
updateDatabaseOperationSettings() {
return getStubSettingsBuilder().updateDatabaseOperationSettings();
}
/** Returns the builder for the settings used for calls to updateDatabaseDdl. */
public UnaryCallSettings.Builder
updateDatabaseDdlSettings() {
return getStubSettingsBuilder().updateDatabaseDdlSettings();
}
/** Returns the builder for the settings used for calls to updateDatabaseDdl. */
public OperationCallSettings.Builder
updateDatabaseDdlOperationSettings() {
return getStubSettingsBuilder().updateDatabaseDdlOperationSettings();
}
/** Returns the builder for the settings used for calls to dropDatabase. */
public UnaryCallSettings.Builder dropDatabaseSettings() {
return getStubSettingsBuilder().dropDatabaseSettings();
}
/** Returns the builder for the settings used for calls to getDatabaseDdl. */
public UnaryCallSettings.Builder
getDatabaseDdlSettings() {
return getStubSettingsBuilder().getDatabaseDdlSettings();
}
/** 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();
}
/** Returns the builder for the settings used for calls to createBackup. */
public UnaryCallSettings.Builder createBackupSettings() {
return getStubSettingsBuilder().createBackupSettings();
}
/** Returns the builder for the settings used for calls to createBackup. */
public OperationCallSettings.Builder
createBackupOperationSettings() {
return getStubSettingsBuilder().createBackupOperationSettings();
}
/** Returns the builder for the settings used for calls to copyBackup. */
public UnaryCallSettings.Builder copyBackupSettings() {
return getStubSettingsBuilder().copyBackupSettings();
}
/** Returns the builder for the settings used for calls to copyBackup. */
public OperationCallSettings.Builder
copyBackupOperationSettings() {
return getStubSettingsBuilder().copyBackupOperationSettings();
}
/** Returns the builder for the settings used for calls to getBackup. */
public UnaryCallSettings.Builder getBackupSettings() {
return getStubSettingsBuilder().getBackupSettings();
}
/** Returns the builder for the settings used for calls to updateBackup. */
public UnaryCallSettings.Builder updateBackupSettings() {
return getStubSettingsBuilder().updateBackupSettings();
}
/** Returns the builder for the settings used for calls to deleteBackup. */
public UnaryCallSettings.Builder deleteBackupSettings() {
return getStubSettingsBuilder().deleteBackupSettings();
}
/** Returns the builder for the settings used for calls to listBackups. */
public PagedCallSettings.Builder<
ListBackupsRequest, ListBackupsResponse, ListBackupsPagedResponse>
listBackupsSettings() {
return getStubSettingsBuilder().listBackupsSettings();
}
/** Returns the builder for the settings used for calls to restoreDatabase. */
public UnaryCallSettings.Builder restoreDatabaseSettings() {
return getStubSettingsBuilder().restoreDatabaseSettings();
}
/** Returns the builder for the settings used for calls to restoreDatabase. */
public OperationCallSettings.Builder
restoreDatabaseOperationSettings() {
return getStubSettingsBuilder().restoreDatabaseOperationSettings();
}
/** Returns the builder for the settings used for calls to listDatabaseOperations. */
public PagedCallSettings.Builder<
ListDatabaseOperationsRequest,
ListDatabaseOperationsResponse,
ListDatabaseOperationsPagedResponse>
listDatabaseOperationsSettings() {
return getStubSettingsBuilder().listDatabaseOperationsSettings();
}
/** Returns the builder for the settings used for calls to listBackupOperations. */
public PagedCallSettings.Builder<
ListBackupOperationsRequest,
ListBackupOperationsResponse,
ListBackupOperationsPagedResponse>
listBackupOperationsSettings() {
return getStubSettingsBuilder().listBackupOperationsSettings();
}
/** Returns the builder for the settings used for calls to listDatabaseRoles. */
public PagedCallSettings.Builder<
ListDatabaseRolesRequest, ListDatabaseRolesResponse, ListDatabaseRolesPagedResponse>
listDatabaseRolesSettings() {
return getStubSettingsBuilder().listDatabaseRolesSettings();
}
/** Returns the builder for the settings used for calls to createBackupSchedule. */
public UnaryCallSettings.Builder
createBackupScheduleSettings() {
return getStubSettingsBuilder().createBackupScheduleSettings();
}
/** Returns the builder for the settings used for calls to getBackupSchedule. */
public UnaryCallSettings.Builder
getBackupScheduleSettings() {
return getStubSettingsBuilder().getBackupScheduleSettings();
}
/** Returns the builder for the settings used for calls to updateBackupSchedule. */
public UnaryCallSettings.Builder
updateBackupScheduleSettings() {
return getStubSettingsBuilder().updateBackupScheduleSettings();
}
/** Returns the builder for the settings used for calls to deleteBackupSchedule. */
public UnaryCallSettings.Builder
deleteBackupScheduleSettings() {
return getStubSettingsBuilder().deleteBackupScheduleSettings();
}
/** Returns the builder for the settings used for calls to listBackupSchedules. */
public PagedCallSettings.Builder<
ListBackupSchedulesRequest,
ListBackupSchedulesResponse,
ListBackupSchedulesPagedResponse>
listBackupSchedulesSettings() {
return getStubSettingsBuilder().listBackupSchedulesSettings();
}
@Override
public DatabaseAdminSettings build() throws IOException {
return new DatabaseAdminSettings(this);
}
}
}