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

Interface UpdateDatabaseDdlRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    UpdateDatabaseDdlRequest, UpdateDatabaseDdlRequest.Builder
    public interface UpdateDatabaseDdlRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDatabase()
      Required.
      com.google.protobuf.ByteString getDatabaseBytes()
      Required.
      String getOperationId()
      If empty, the new update request is assigned an automatically-generated operation ID.
      com.google.protobuf.ByteString getOperationIdBytes()
      If empty, the new update request is assigned an automatically-generated operation ID.
      String getStatements​(int index)
      Required.
      com.google.protobuf.ByteString getStatementsBytes​(int index)
      Required.
      int getStatementsCount()
      Required.
      List<String> getStatementsList()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDatabase

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

      • getDatabaseBytes

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

      • getStatementsList

        List<String> getStatementsList()
         Required. DDL statements to be applied to the database.
        repeated string statements = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        A list containing the statements.

      • getStatementsCount

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

      • getStatements

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

      • getStatementsBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the statements at the given index.

      • getOperationId

        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;
        Returns:
        The operationId.

      • getOperationIdBytes

        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;
        Returns:
        The bytes for operationId.