com.google.cloud.spring.autoconfigure.spanner.GcpSpannerProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-gcp-autoconfigure Show documentation
Spring Framework on Google Cloud
There is a newer version: 5.6.1
Show newest version
/*
 * Copyright 2017-2018 the original author or authors.
 *
 * 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.spring.autoconfigure.spanner;

import com.google.cloud.spring.core.Credentials;
import com.google.cloud.spring.core.CredentialsSupplier;
import com.google.cloud.spring.core.GcpScope;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;

/** Settings for Spring Data Cloud Spanner. */
@ConfigurationProperties("spring.cloud.gcp.spanner")
public class GcpSpannerProperties implements CredentialsSupplier {

  /** Overrides the GCP OAuth2 credentials specified in the Core module. */
  @NestedConfigurationProperty
  private final Credentials credentials =
      new Credentials(GcpScope.SPANNER_DATA.getUrl(), GcpScope.SPANNER_ADMIN.getUrl());

  private String projectId;

  private String instanceId;

  private String database;

  // If {@code true} then create-table statements generated will cascade on delete.
  // No-action on delete if {@code false}.
  private boolean createInterleavedTableDdlOnDeleteCascade = true;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int numRpcChannels = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int prefetchChunks = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int minSessions = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int maxSessions = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int maxIdleSessions = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private float writeSessionsFraction = -1;

  // Default value is negative to indicate to use Cloud Spanner default number.
  private int keepAliveIntervalMinutes = -1;

  // When {@code true}, if all sessions are in use, fail the request by throwing an exception.
  // Otherwise, by default, block until a session becomes available.
  private boolean failIfPoolExhausted = false;

  // Host:port used to connect to the emulator, when the emulator is enabled.
  private String emulatorHost = "localhost:9010";

  public Credentials getCredentials() {
    return this.credentials;
  }

  public String getProjectId() {
    return this.projectId;
  }

  public void setProjectId(String projectId) {
    this.projectId = projectId;
  }

  public String getInstanceId() {
    return this.instanceId;
  }

  public void setInstanceId(String instanceId) {
    this.instanceId = instanceId;
  }

  public String getDatabase() {
    return this.database;
  }

  public void setDatabase(String database) {
    this.database = database;
  }

  public int getNumRpcChannels() {
    return this.numRpcChannels;
  }

  public void setNumRpcChannels(int numRpcChannels) {
    this.numRpcChannels = numRpcChannels;
  }

  public int getPrefetchChunks() {
    return this.prefetchChunks;
  }

  public void setPrefetchChunks(int prefetchChunks) {
    this.prefetchChunks = prefetchChunks;
  }

  public int getMinSessions() {
    return this.minSessions;
  }

  public void setMinSessions(int minSessions) {
    this.minSessions = minSessions;
  }

  public int getMaxSessions() {
    return this.maxSessions;
  }

  public void setMaxSessions(int maxSessions) {
    this.maxSessions = maxSessions;
  }

  public int getMaxIdleSessions() {
    return this.maxIdleSessions;
  }

  public void setMaxIdleSessions(int maxIdleSessions) {
    this.maxIdleSessions = maxIdleSessions;
  }

  public float getWriteSessionsFraction() {
    return this.writeSessionsFraction;
  }

  public void setWriteSessionsFraction(float writeSessionsFraction) {
    this.writeSessionsFraction = writeSessionsFraction;
  }

  public int getKeepAliveIntervalMinutes() {
    return this.keepAliveIntervalMinutes;
  }

  public void setKeepAliveIntervalMinutes(int keepAliveIntervalMinutes) {
    this.keepAliveIntervalMinutes = keepAliveIntervalMinutes;
  }

  public boolean isCreateInterleavedTableDdlOnDeleteCascade() {
    return this.createInterleavedTableDdlOnDeleteCascade;
  }

  public void setCreateInterleavedTableDdlOnDeleteCascade(
      boolean createInterleavedTableDdlOnDeleteCascade) {
    this.createInterleavedTableDdlOnDeleteCascade = createInterleavedTableDdlOnDeleteCascade;
  }

  public boolean isFailIfPoolExhausted() {
    return failIfPoolExhausted;
  }

  public void setFailIfPoolExhausted(boolean failIfPoolExhausted) {
    this.failIfPoolExhausted = failIfPoolExhausted;
  }

  public String getEmulatorHost() {
    return this.emulatorHost;
  }

  public void setEmulatorHost(String emulatorHost) {
    this.emulatorHost = emulatorHost;
  }
}