Package com.google.cloud.spanner

Class DatabaseInfo.Builder

java.lang.Object
com.google.cloud.spanner.DatabaseInfo.Builder
Direct Known Subclasses:
Database.Builder
Enclosing class:
DatabaseInfo
public abstract static class DatabaseInfo.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • setEncryptionConfig

      public abstract DatabaseInfo.Builder setEncryptionConfig(CustomerManagedEncryption encryptionConfig)
      Optional for creating a new backup.

      The encryption configuration to be used for the database. The only encryption, other than Google's default encryption, is a customer managed encryption with a provided key. If no encryption is provided, Google's default encryption will be used.

    • setDefaultLeader

      public DatabaseInfo.Builder setDefaultLeader(String defaultLeader)
      The read-write region which will be used for the database's leader replicas. This can be one of the values as specified in https://cloud.google.com/spanner/docs/instances#available-configurations-multi-region.

    • setDialect

      public DatabaseInfo.Builder setDialect(Dialect dialect)

    • enableDropProtection

      public DatabaseInfo.Builder enableDropProtection()

    • disableDropProtection

      public DatabaseInfo.Builder disableDropProtection()

    • setReconciling

      protected DatabaseInfo.Builder setReconciling(boolean reconciling)

    • setProtoDescriptors

      public abstract DatabaseInfo.Builder setProtoDescriptors(@Nonnull byte[] protoDescriptors)
      Optional for creating a new database.

      It is used by CREATE/ALTER PROTO BUNDLE statements which are part of DDL statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet]. To generate a proto descriptors file run protoc --include_imports --descriptor_set_out=DESCRIPTOR_OUTPUT_LOCATION LOCATION-OF-PROTO-FILES

      Parameters:
      protoDescriptors - The proto descriptors input as byte[] to be used for the database.
      Returns:
      DatabaseInfo.Builder

    • setProtoDescriptors

      public abstract DatabaseInfo.Builder setProtoDescriptors(@Nonnull InputStream inputStream) throws IOException
      Optional for creating a new database.

      It is used by CREATE/ALTER PROTO BUNDLE statements which are part of DDL statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet]. To generate a proto descriptors file run protoc --include_imports --descriptor_set_out=DESCRIPTOR_OUTPUT_LOCATION LOCATION-OF-PROTO-FILES

      Parameters:
      inputStream - The proto descriptors input as InputStream to be used for the database.
      Returns:
      DatabaseInfo.Builder
      Throws:
      IOException - if there is a problem reading the underlying stream.

    • build

      public abstract Database build()
      Builds the database from this builder.