Package com.google.datastore.v1

Class CommitRequest

  • All Implemented Interfaces:
    CommitRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CommitRequest
extends com.google.protobuf.GeneratedMessageV3
implements CommitRequestOrBuilder
     The request for [Datastore.Commit][google.datastore.v1.Datastore.Commit].
    Protobuf type google.datastore.v1.CommitRequest
    See Also:
    Serialized Form

    • Method Detail

      • 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

      • getProjectId

        public String getProjectId()
         Required. The ID of the project against which to make the request.
        string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProjectId in interface CommitRequestOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         Required. The ID of the project against which to make the request.
        string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProjectIdBytes in interface CommitRequestOrBuilder
        Returns:
        The bytes for projectId.

      • getDatabaseId

        public String getDatabaseId()
         The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
        string database_id = 9;
        Specified by:
        getDatabaseId in interface CommitRequestOrBuilder
        Returns:
        The databaseId.

      • getDatabaseIdBytes

        public com.google.protobuf.ByteString getDatabaseIdBytes()
         The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
        string database_id = 9;
        Specified by:
        getDatabaseIdBytes in interface CommitRequestOrBuilder
        Returns:
        The bytes for databaseId.

      • getModeValue

        public int getModeValue()
         The type of commit to perform. Defaults to `TRANSACTIONAL`.
        .google.datastore.v1.CommitRequest.Mode mode = 5;
        Specified by:
        getModeValue in interface CommitRequestOrBuilder
        Returns:
        The enum numeric value on the wire for mode.

      • getMode

        public CommitRequest.Mode getMode()
         The type of commit to perform. Defaults to `TRANSACTIONAL`.
        .google.datastore.v1.CommitRequest.Mode mode = 5;
        Specified by:
        getMode in interface CommitRequestOrBuilder
        Returns:
        The mode.

      • hasTransaction

        public boolean hasTransaction()
         The identifier of the transaction associated with the commit. A
 transaction identifier is returned by a call to
 [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
        bytes transaction = 1;
        Specified by:
        hasTransaction in interface CommitRequestOrBuilder
        Returns:
        Whether the transaction field is set.

      • getTransaction

        public com.google.protobuf.ByteString getTransaction()
         The identifier of the transaction associated with the commit. A
 transaction identifier is returned by a call to
 [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
        bytes transaction = 1;
        Specified by:
        getTransaction in interface CommitRequestOrBuilder
        Returns:
        The transaction.

      • hasSingleUseTransaction

        public boolean hasSingleUseTransaction()
         Options for beginning a new transaction for this request.
 The transaction is committed when the request completes. If specified,
 [TransactionOptions.mode][google.datastore.v1.TransactionOptions] must be
 [TransactionOptions.ReadWrite][google.datastore.v1.TransactionOptions.ReadWrite].
        .google.datastore.v1.TransactionOptions single_use_transaction = 10;
        Specified by:
        hasSingleUseTransaction in interface CommitRequestOrBuilder
        Returns:
        Whether the singleUseTransaction field is set.

      • getSingleUseTransaction

        public TransactionOptions getSingleUseTransaction()
         Options for beginning a new transaction for this request.
 The transaction is committed when the request completes. If specified,
 [TransactionOptions.mode][google.datastore.v1.TransactionOptions] must be
 [TransactionOptions.ReadWrite][google.datastore.v1.TransactionOptions.ReadWrite].
        .google.datastore.v1.TransactionOptions single_use_transaction = 10;
        Specified by:
        getSingleUseTransaction in interface CommitRequestOrBuilder
        Returns:
        The singleUseTransaction.

      • getSingleUseTransactionOrBuilder

        public TransactionOptionsOrBuilder getSingleUseTransactionOrBuilder()
         Options for beginning a new transaction for this request.
 The transaction is committed when the request completes. If specified,
 [TransactionOptions.mode][google.datastore.v1.TransactionOptions] must be
 [TransactionOptions.ReadWrite][google.datastore.v1.TransactionOptions.ReadWrite].
        .google.datastore.v1.TransactionOptions single_use_transaction = 10;
        Specified by:
        getSingleUseTransactionOrBuilder in interface CommitRequestOrBuilder

      • getMutationsList

        public List<Mutation> getMutationsList()
         The mutations to perform.

 When mode is `TRANSACTIONAL`, mutations affecting a single entity are
 applied in order. The following sequences of mutations affecting a single
 entity are not permitted in a single `Commit` request:

 - `insert` followed by `insert`
 - `update` followed by `insert`
 - `upsert` followed by `insert`
 - `delete` followed by `update`

 When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
 entity.
        repeated .google.datastore.v1.Mutation mutations = 6;
        Specified by:
        getMutationsList in interface CommitRequestOrBuilder

      • getMutationsOrBuilderList

        public List<? extends MutationOrBuilder> getMutationsOrBuilderList()
         The mutations to perform.

 When mode is `TRANSACTIONAL`, mutations affecting a single entity are
 applied in order. The following sequences of mutations affecting a single
 entity are not permitted in a single `Commit` request:

 - `insert` followed by `insert`
 - `update` followed by `insert`
 - `upsert` followed by `insert`
 - `delete` followed by `update`

 When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
 entity.
        repeated .google.datastore.v1.Mutation mutations = 6;
        Specified by:
        getMutationsOrBuilderList in interface CommitRequestOrBuilder

      • getMutationsCount

        public int getMutationsCount()
         The mutations to perform.

 When mode is `TRANSACTIONAL`, mutations affecting a single entity are
 applied in order. The following sequences of mutations affecting a single
 entity are not permitted in a single `Commit` request:

 - `insert` followed by `insert`
 - `update` followed by `insert`
 - `upsert` followed by `insert`
 - `delete` followed by `update`

 When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
 entity.
        repeated .google.datastore.v1.Mutation mutations = 6;
        Specified by:
        getMutationsCount in interface CommitRequestOrBuilder

      • getMutations

        public Mutation getMutations​(int index)
         The mutations to perform.

 When mode is `TRANSACTIONAL`, mutations affecting a single entity are
 applied in order. The following sequences of mutations affecting a single
 entity are not permitted in a single `Commit` request:

 - `insert` followed by `insert`
 - `update` followed by `insert`
 - `upsert` followed by `insert`
 - `delete` followed by `update`

 When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
 entity.
        repeated .google.datastore.v1.Mutation mutations = 6;
        Specified by:
        getMutations in interface CommitRequestOrBuilder

      • getMutationsOrBuilder

        public MutationOrBuilder getMutationsOrBuilder​(int index)
         The mutations to perform.

 When mode is `TRANSACTIONAL`, mutations affecting a single entity are
 applied in order. The following sequences of mutations affecting a single
 entity are not permitted in a single `Commit` request:

 - `insert` followed by `insert`
 - `update` followed by `insert`
 - `upsert` followed by `insert`
 - `delete` followed by `update`

 When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
 entity.
        repeated .google.datastore.v1.Mutation mutations = 6;
        Specified by:
        getMutationsOrBuilder in interface CommitRequestOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static CommitRequest getDefaultInstance()

      • parser

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

      • getParserForType

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