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

Class CreateDatabaseRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CreateDatabaseRequestOrBuilder, Serializable
    public final class CreateDatabaseRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateDatabaseRequestOrBuilder
     The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
    Protobuf type google.spanner.admin.database.v1.CreateDatabaseRequest
    See Also:
    Serialized Form

    • Field Detail

      • CREATE_STATEMENT_FIELD_NUMBER

        public static final int CREATE_STATEMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTRA_STATEMENTS_FIELD_NUMBER

        public static final int EXTRA_STATEMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCRYPTION_CONFIG_FIELD_NUMBER

        public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATABASE_DIALECT_FIELD_NUMBER

        public static final int DATABASE_DIALECT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface CreateDatabaseRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface CreateDatabaseRequestOrBuilder
        Returns:
        The bytes for parent.

      • getCreateStatement

        public 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];
        Specified by:
        getCreateStatement in interface CreateDatabaseRequestOrBuilder
        Returns:
        The createStatement.

      • getCreateStatementBytes

        public 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];
        Specified by:
        getCreateStatementBytes in interface CreateDatabaseRequestOrBuilder
        Returns:
        The bytes for createStatement.

      • getExtraStatementsList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getExtraStatementsList in interface CreateDatabaseRequestOrBuilder
        Returns:
        A list containing the extraStatements.

      • getExtraStatementsCount

        public 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];
        Specified by:
        getExtraStatementsCount in interface CreateDatabaseRequestOrBuilder
        Returns:
        The count of extraStatements.

      • getExtraStatements

        public 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];
        Specified by:
        getExtraStatements in interface CreateDatabaseRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The extraStatements at the given index.

      • getExtraStatementsBytes

        public 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];
        Specified by:
        getExtraStatementsBytes in interface CreateDatabaseRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the extraStatements at the given index.

      • hasEncryptionConfig

        public 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];
        Specified by:
        hasEncryptionConfig in interface CreateDatabaseRequestOrBuilder
        Returns:
        Whether the encryptionConfig field is set.

      • getEncryptionConfig

        public 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];
        Specified by:
        getEncryptionConfig in interface CreateDatabaseRequestOrBuilder
        Returns:
        The encryptionConfig.

      • getEncryptionConfigOrBuilder

        public 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];
        Specified by:
        getEncryptionConfigOrBuilder in interface CreateDatabaseRequestOrBuilder

      • getDatabaseDialectValue

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

      • getDatabaseDialect

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateDatabaseRequest parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public CreateDatabaseRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CreateDatabaseRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CreateDatabaseRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CreateDatabaseRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CreateDatabaseRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder