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

Class UpdateDatabaseDdlRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpdateDatabaseDdlRequestOrBuilder, Serializable
public final class UpdateDatabaseDdlRequest extends com.google.protobuf.GeneratedMessageV3 implements UpdateDatabaseDdlRequestOrBuilder
 Enqueues the given DDL statements to be applied, in order but not
 necessarily all at once, to the database schema at some point (or
 points) in the future. The server checks that the statements
 are executable (syntactically valid, name tables that exist, etc.)
 before enqueueing them, but they may still fail upon
 later execution (e.g., if a statement from another batch of
 statements is applied first and it conflicts in some way, or if
 there is some data-related problem like a `NULL` value in a column to
 which `NOT NULL` would be added). If a statement fails, all
 subsequent statements in the batch are automatically cancelled.

 Each batch of statements is assigned a name which can be used with
 the [Operations][google.longrunning.Operations] API to monitor
 progress. See the
 [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id]
 field for more details.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlRequest
See Also:

  • Field Details

    • DATABASE_FIELD_NUMBER

      public static final int DATABASE_FIELD_NUMBER
      See Also:

    • STATEMENTS_FIELD_NUMBER

      public static final int STATEMENTS_FIELD_NUMBER
      See Also:

    • OPERATION_ID_FIELD_NUMBER

      public static final int OPERATION_ID_FIELD_NUMBER
      See Also:

    • PROTO_DESCRIPTORS_FIELD_NUMBER

      public static final int PROTO_DESCRIPTORS_FIELD_NUMBER
      See Also:

    • THROUGHPUT_MODE_FIELD_NUMBER

      public static final int THROUGHPUT_MODE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getDatabase

      public String getDatabase()
       Required. The database to update.
      string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDatabase in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The database.

    • getDatabaseBytes

      public com.google.protobuf.ByteString getDatabaseBytes()
       Required. The database to update.
      string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDatabaseBytes in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The bytes for database.

    • getStatementsList

      public com.google.protobuf.ProtocolStringList getStatementsList()
       Required. DDL statements to be applied to the database.
      repeated string statements = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStatementsList in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      A list containing the statements.

    • getStatementsCount

      public int getStatementsCount()
       Required. DDL statements to be applied to the database.
      repeated string statements = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStatementsCount in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The count of statements.

    • getStatements

      public String getStatements(int index)
       Required. DDL statements to be applied to the database.
      repeated string statements = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStatements in interface UpdateDatabaseDdlRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The statements at the given index.

    • getStatementsBytes

      public com.google.protobuf.ByteString getStatementsBytes(int index)
       Required. DDL statements to be applied to the database.
      repeated string statements = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getStatementsBytes in interface UpdateDatabaseDdlRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the statements at the given index.

    • getOperationId

      public String getOperationId()
       If empty, the new update request is assigned an
 automatically-generated operation ID. Otherwise, `operation_id`
 is used to construct the name of the resulting
 [Operation][google.longrunning.Operation].

 Specifying an explicit operation ID simplifies determining
 whether the statements were executed in the event that the
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
 call is replayed, or the return value is otherwise lost: the
 [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database]
 and `operation_id` fields can be combined to form the
 [name][google.longrunning.Operation.name] of the resulting
 [longrunning.Operation][google.longrunning.Operation]:
 `<database>/operations/<operation_id>`.

 `operation_id` should be unique within the database, and must be
 a valid identifier: `[a-z][a-z0-9_]*`. Note that
 automatically-generated operation IDs always begin with an
 underscore. If the named operation already exists,
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
 returns `ALREADY_EXISTS`.
      string operation_id = 3;
      Specified by:
      getOperationId in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The operationId.

    • getOperationIdBytes

      public com.google.protobuf.ByteString getOperationIdBytes()
       If empty, the new update request is assigned an
 automatically-generated operation ID. Otherwise, `operation_id`
 is used to construct the name of the resulting
 [Operation][google.longrunning.Operation].

 Specifying an explicit operation ID simplifies determining
 whether the statements were executed in the event that the
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
 call is replayed, or the return value is otherwise lost: the
 [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database]
 and `operation_id` fields can be combined to form the
 [name][google.longrunning.Operation.name] of the resulting
 [longrunning.Operation][google.longrunning.Operation]:
 `<database>/operations/<operation_id>`.

 `operation_id` should be unique within the database, and must be
 a valid identifier: `[a-z][a-z0-9_]*`. Note that
 automatically-generated operation IDs always begin with an
 underscore. If the named operation already exists,
 [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]
 returns `ALREADY_EXISTS`.
      string operation_id = 3;
      Specified by:
      getOperationIdBytes in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The bytes for operationId.

    • getProtoDescriptors

      public com.google.protobuf.ByteString getProtoDescriptors()
       Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getProtoDescriptors in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The protoDescriptors.

    • getThroughputMode

      public boolean getThroughputMode()
       Optional. This field is exposed to be used by the Spanner Migration Tool.
 For more details, see
 [SMT](https://github.com/GoogleCloudPlatform/spanner-migration-tool).
      bool throughput_mode = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getThroughputMode in interface UpdateDatabaseDdlRequestOrBuilder
      Returns:
      The throughputMode.

    • 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 UpdateDatabaseDdlRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static UpdateDatabaseDdlRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDatabaseDdlRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateDatabaseDdlRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UpdateDatabaseDdlRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDatabaseDdlRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UpdateDatabaseDdlRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static UpdateDatabaseDdlRequest.Builder newBuilder()

    • newBuilder

      public static UpdateDatabaseDdlRequest.Builder newBuilder(UpdateDatabaseDdlRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static UpdateDatabaseDdlRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UpdateDatabaseDdlRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<UpdateDatabaseDdlRequest> 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 UpdateDatabaseDdlRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder