Package com.google.spanner.admin.database.v1

Interface CreateDatabaseRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateDatabaseRequest, CreateDatabaseRequest.Builder
public interface CreateDatabaseRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getParent

      String getParent()
       Required. The name of the instance that will serve the new database.
 Values are of the form `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The name of the instance that will serve the new database.
 Values are of the form `projects/<project>/instances/<instance>`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getCreateStatement

      String getCreateStatement()
       Required. A `CREATE DATABASE` statement, which specifies the ID of the
 new database.  The database ID must conform to the regular expression
 `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
 If the database ID is a reserved word or if it contains a hyphen, the
 database ID must be enclosed in backticks (`` ` ``).
      string create_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The createStatement.

    • getCreateStatementBytes

      com.google.protobuf.ByteString getCreateStatementBytes()
       Required. A `CREATE DATABASE` statement, which specifies the ID of the
 new database.  The database ID must conform to the regular expression
 `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
 If the database ID is a reserved word or if it contains a hyphen, the
 database ID must be enclosed in backticks (`` ` ``).
      string create_statement = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for createStatement.

    • getExtraStatementsList

      List<String> getExtraStatementsList()
       Optional. A list of DDL statements to run inside the newly created
 database. Statements can create tables, indexes, etc. These
 statements execute atomically with the creation of the database:
 if there is an error in any statement, the database is not created.
      repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the extraStatements.

    • getExtraStatementsCount

      int getExtraStatementsCount()
       Optional. A list of DDL statements to run inside the newly created
 database. Statements can create tables, indexes, etc. These
 statements execute atomically with the creation of the database:
 if there is an error in any statement, the database is not created.
      repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of extraStatements.

    • getExtraStatements

      String getExtraStatements(int index)
       Optional. A list of DDL statements to run inside the newly created
 database. Statements can create tables, indexes, etc. These
 statements execute atomically with the creation of the database:
 if there is an error in any statement, the database is not created.
      repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The extraStatements at the given index.

    • getExtraStatementsBytes

      com.google.protobuf.ByteString getExtraStatementsBytes(int index)
       Optional. A list of DDL statements to run inside the newly created
 database. Statements can create tables, indexes, etc. These
 statements execute atomically with the creation of the database:
 if there is an error in any statement, the database is not created.
      repeated string extra_statements = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extraStatements at the given index.

    • hasEncryptionConfig

      boolean hasEncryptionConfig()
       Optional. The encryption configuration for the database. If this field is not
 specified, Cloud Spanner will encrypt/decrypt all data at rest using
 Google default encryption.
      .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the encryptionConfig field is set.

    • getEncryptionConfig

      EncryptionConfig getEncryptionConfig()
       Optional. The encryption configuration for the database. If this field is not
 specified, Cloud Spanner will encrypt/decrypt all data at rest using
 Google default encryption.
      .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The encryptionConfig.

    • getEncryptionConfigOrBuilder

      EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()
       Optional. The encryption configuration for the database. If this field is not
 specified, Cloud Spanner will encrypt/decrypt all data at rest using
 Google default encryption.
      .google.spanner.admin.database.v1.EncryptionConfig encryption_config = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getDatabaseDialectValue

      int getDatabaseDialectValue()
       Optional. The dialect of the Cloud Spanner Database.
      .google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for databaseDialect.

    • getDatabaseDialect

      DatabaseDialect getDatabaseDialect()
       Optional. The dialect of the Cloud Spanner Database.
      .google.spanner.admin.database.v1.DatabaseDialect database_dialect = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The databaseDialect.

    • getProtoDescriptors

      com.google.protobuf.ByteString getProtoDescriptors()
       Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in
 'extra_statements' above.
 Contains a protobuf-serialized
 [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
 To generate it, [install](https://grpc.io/docs/protoc-installation/) and
 run `protoc` with --include_imports and --descriptor_set_out. For example,
 to generate for moon/shot/app.proto, run
 ```
 $protoc  --proto_path=/app_path --proto_path=/lib_path \
          --include_imports \
          --descriptor_set_out=descriptors.data \
          moon/shot/app.proto
 ```
 For more details, see protobuffer [self
 description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
      bytes proto_descriptors = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The protoDescriptors.