com.google.cloud.spanner.v1.SpannerSettings 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.v1;
import static com.google.cloud.spanner.v1.SpannerClient.ListSessionsPagedResponse;
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.PagedCallSettings;
import com.google.api.gax.rpc.ServerStreamingCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.spanner.v1.stub.SpannerStubSettings;
import com.google.protobuf.Empty;
import com.google.spanner.v1.BatchCreateSessionsRequest;
import com.google.spanner.v1.BatchCreateSessionsResponse;
import com.google.spanner.v1.BatchWriteRequest;
import com.google.spanner.v1.BatchWriteResponse;
import com.google.spanner.v1.BeginTransactionRequest;
import com.google.spanner.v1.CommitRequest;
import com.google.spanner.v1.CommitResponse;
import com.google.spanner.v1.CreateSessionRequest;
import com.google.spanner.v1.DeleteSessionRequest;
import com.google.spanner.v1.ExecuteBatchDmlRequest;
import com.google.spanner.v1.ExecuteBatchDmlResponse;
import com.google.spanner.v1.ExecuteSqlRequest;
import com.google.spanner.v1.GetSessionRequest;
import com.google.spanner.v1.ListSessionsRequest;
import com.google.spanner.v1.ListSessionsResponse;
import com.google.spanner.v1.PartialResultSet;
import com.google.spanner.v1.PartitionQueryRequest;
import com.google.spanner.v1.PartitionReadRequest;
import com.google.spanner.v1.PartitionResponse;
import com.google.spanner.v1.ReadRequest;
import com.google.spanner.v1.ResultSet;
import com.google.spanner.v1.RollbackRequest;
import com.google.spanner.v1.Session;
import com.google.spanner.v1.Transaction;
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 SpannerClient}.
*
* 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
* [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
* of createSession:
*
*
{@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
* SpannerSettings.Builder spannerSettingsBuilder = SpannerSettings.newBuilder();
* spannerSettingsBuilder
* .createSessionSettings()
* .setRetrySettings(
* spannerSettingsBuilder
* .createSessionSettings()
* .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());
* SpannerSettings spannerSettings = spannerSettingsBuilder.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.
*/
@Generated("by gapic-generator-java")
public class SpannerSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createSession. */
public UnaryCallSettings createSessionSettings() {
return ((SpannerStubSettings) getStubSettings()).createSessionSettings();
}
/** Returns the object with the settings used for calls to batchCreateSessions. */
public UnaryCallSettings
batchCreateSessionsSettings() {
return ((SpannerStubSettings) getStubSettings()).batchCreateSessionsSettings();
}
/** Returns the object with the settings used for calls to getSession. */
public UnaryCallSettings getSessionSettings() {
return ((SpannerStubSettings) getStubSettings()).getSessionSettings();
}
/** Returns the object with the settings used for calls to listSessions. */
public PagedCallSettings
listSessionsSettings() {
return ((SpannerStubSettings) getStubSettings()).listSessionsSettings();
}
/** Returns the object with the settings used for calls to deleteSession. */
public UnaryCallSettings deleteSessionSettings() {
return ((SpannerStubSettings) getStubSettings()).deleteSessionSettings();
}
/** Returns the object with the settings used for calls to executeSql. */
public UnaryCallSettings executeSqlSettings() {
return ((SpannerStubSettings) getStubSettings()).executeSqlSettings();
}
/** Returns the object with the settings used for calls to executeStreamingSql. */
public ServerStreamingCallSettings
executeStreamingSqlSettings() {
return ((SpannerStubSettings) getStubSettings()).executeStreamingSqlSettings();
}
/** Returns the object with the settings used for calls to executeBatchDml. */
public UnaryCallSettings
executeBatchDmlSettings() {
return ((SpannerStubSettings) getStubSettings()).executeBatchDmlSettings();
}
/** Returns the object with the settings used for calls to read. */
public UnaryCallSettings readSettings() {
return ((SpannerStubSettings) getStubSettings()).readSettings();
}
/** Returns the object with the settings used for calls to streamingRead. */
public ServerStreamingCallSettings streamingReadSettings() {
return ((SpannerStubSettings) getStubSettings()).streamingReadSettings();
}
/** Returns the object with the settings used for calls to beginTransaction. */
public UnaryCallSettings beginTransactionSettings() {
return ((SpannerStubSettings) getStubSettings()).beginTransactionSettings();
}
/** Returns the object with the settings used for calls to commit. */
public UnaryCallSettings commitSettings() {
return ((SpannerStubSettings) getStubSettings()).commitSettings();
}
/** Returns the object with the settings used for calls to rollback. */
public UnaryCallSettings rollbackSettings() {
return ((SpannerStubSettings) getStubSettings()).rollbackSettings();
}
/** Returns the object with the settings used for calls to partitionQuery. */
public UnaryCallSettings partitionQuerySettings() {
return ((SpannerStubSettings) getStubSettings()).partitionQuerySettings();
}
/** Returns the object with the settings used for calls to partitionRead. */
public UnaryCallSettings partitionReadSettings() {
return ((SpannerStubSettings) getStubSettings()).partitionReadSettings();
}
/** Returns the object with the settings used for calls to batchWrite. */
public ServerStreamingCallSettings batchWriteSettings() {
return ((SpannerStubSettings) getStubSettings()).batchWriteSettings();
}
public static final SpannerSettings create(SpannerStubSettings stub) throws IOException {
return new SpannerSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return SpannerStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return SpannerStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return SpannerStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return SpannerStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return SpannerStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return SpannerStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return SpannerStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return SpannerStubSettings.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 SpannerSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for SpannerSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(SpannerStubSettings.newBuilder(clientContext));
}
protected Builder(SpannerSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(SpannerStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(SpannerStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(SpannerStubSettings.newHttpJsonBuilder());
}
public SpannerStubSettings.Builder getStubSettingsBuilder() {
return ((SpannerStubSettings.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 createSession. */
public UnaryCallSettings.Builder createSessionSettings() {
return getStubSettingsBuilder().createSessionSettings();
}
/** Returns the builder for the settings used for calls to batchCreateSessions. */
public UnaryCallSettings.Builder
batchCreateSessionsSettings() {
return getStubSettingsBuilder().batchCreateSessionsSettings();
}
/** Returns the builder for the settings used for calls to getSession. */
public UnaryCallSettings.Builder getSessionSettings() {
return getStubSettingsBuilder().getSessionSettings();
}
/** Returns the builder for the settings used for calls to listSessions. */
public PagedCallSettings.Builder<
ListSessionsRequest, ListSessionsResponse, ListSessionsPagedResponse>
listSessionsSettings() {
return getStubSettingsBuilder().listSessionsSettings();
}
/** Returns the builder for the settings used for calls to deleteSession. */
public UnaryCallSettings.Builder deleteSessionSettings() {
return getStubSettingsBuilder().deleteSessionSettings();
}
/** Returns the builder for the settings used for calls to executeSql. */
public UnaryCallSettings.Builder executeSqlSettings() {
return getStubSettingsBuilder().executeSqlSettings();
}
/** Returns the builder for the settings used for calls to executeStreamingSql. */
public ServerStreamingCallSettings.Builder
executeStreamingSqlSettings() {
return getStubSettingsBuilder().executeStreamingSqlSettings();
}
/** Returns the builder for the settings used for calls to executeBatchDml. */
public UnaryCallSettings.Builder
executeBatchDmlSettings() {
return getStubSettingsBuilder().executeBatchDmlSettings();
}
/** Returns the builder for the settings used for calls to read. */
public UnaryCallSettings.Builder readSettings() {
return getStubSettingsBuilder().readSettings();
}
/** Returns the builder for the settings used for calls to streamingRead. */
public ServerStreamingCallSettings.Builder
streamingReadSettings() {
return getStubSettingsBuilder().streamingReadSettings();
}
/** Returns the builder for the settings used for calls to beginTransaction. */
public UnaryCallSettings.Builder
beginTransactionSettings() {
return getStubSettingsBuilder().beginTransactionSettings();
}
/** Returns the builder for the settings used for calls to commit. */
public UnaryCallSettings.Builder commitSettings() {
return getStubSettingsBuilder().commitSettings();
}
/** Returns the builder for the settings used for calls to rollback. */
public UnaryCallSettings.Builder rollbackSettings() {
return getStubSettingsBuilder().rollbackSettings();
}
/** Returns the builder for the settings used for calls to partitionQuery. */
public UnaryCallSettings.Builder
partitionQuerySettings() {
return getStubSettingsBuilder().partitionQuerySettings();
}
/** Returns the builder for the settings used for calls to partitionRead. */
public UnaryCallSettings.Builder
partitionReadSettings() {
return getStubSettingsBuilder().partitionReadSettings();
}
/** Returns the builder for the settings used for calls to batchWrite. */
public ServerStreamingCallSettings.Builder
batchWriteSettings() {
return getStubSettingsBuilder().batchWriteSettings();
}
@Override
public SpannerSettings build() throws IOException {
return new SpannerSettings(this);
}
}
}