Package com.google.firestore.v1

Class WriteRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.WriteRequest
All Implemented Interfaces:
WriteRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class WriteRequest extends com.google.protobuf.GeneratedMessageV3 implements WriteRequestOrBuilder
 The request for [Firestore.Write][google.firestore.v1.Firestore.Write].

 The first request creates a stream, or resumes an existing one from a token.

 When creating a new stream, the server replies with a response containing
 only an ID and a token, to use in the next request.

 When resuming a stream, the server first streams any responses later than the
 given token, then a response containing only an up-to-date token, to use in
 the next request.
Protobuf type google.firestore.v1.WriteRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WriteRequest.Builder
    The request for [Firestore.Write][google.firestore.v1.Firestore.Write].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATABASE_FIELD_NUMBER
     
    static final int
    LABELS_FIELD_NUMBER
     
    static final int
    STREAM_ID_FIELD_NUMBER
     
    static final int
    STREAM_TOKEN_FIELD_NUMBER
     
    static final int
    WRITES_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsLabels(String key)
    Labels associated with this write request.
    boolean
    equals(Object obj)
     
    String
    getDatabase()
    Required.
    com.google.protobuf.ByteString
    getDatabaseBytes()
    Required.
    static WriteRequest
    getDefaultInstance()
     
    WriteRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Map<String,String>
    getLabels()
    Deprecated.
    int
    getLabelsCount()
    Labels associated with this write request.
    Map<String,String>
    getLabelsMap()
    Labels associated with this write request.
    String
    getLabelsOrDefault(String key, String defaultValue)
    Labels associated with this write request.
    String
    getLabelsOrThrow(String key)
    Labels associated with this write request.
    com.google.protobuf.Parser<WriteRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getStreamId()
    The ID of the write stream to resume.
    com.google.protobuf.ByteString
    getStreamIdBytes()
    The ID of the write stream to resume.
    com.google.protobuf.ByteString
    getStreamToken()
    A stream token that was previously sent by the server.
    Write
    getWrites(int index)
    The writes to apply.
    int
    getWritesCount()
    The writes to apply.
    List<Write>
    getWritesList()
    The writes to apply.
    WriteOrBuilder
    getWritesOrBuilder(int index)
    The writes to apply.
    List<? extends WriteOrBuilder>
    getWritesOrBuilderList()
    The writes to apply.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static WriteRequest.Builder
    newBuilder()
     
    static WriteRequest.Builder
    newBuilder(WriteRequest prototype)
     
    WriteRequest.Builder
    newBuilderForType()
     
    protected WriteRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static WriteRequest
    parseDelimitedFrom(InputStream input)
     
    static WriteRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRequest
    parseFrom(byte[] data)
     
    static WriteRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static WriteRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WriteRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRequest
    parseFrom(InputStream input)
     
    static WriteRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteRequest
    parseFrom(ByteBuffer data)
     
    static WriteRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WriteRequest>
    parser()
     
    WriteRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • getDatabase

      public String getDatabase()
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 This is only required in the first message.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabase in interface WriteRequestOrBuilder
      Returns:
      The database.

    • getDatabaseBytes

      public com.google.protobuf.ByteString getDatabaseBytes()
       Required. The database name. In the format:
 `projects/{project_id}/databases/{database_id}`.
 This is only required in the first message.
      string database = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDatabaseBytes in interface WriteRequestOrBuilder
      Returns:
      The bytes for database.

    • getStreamId

      public String getStreamId()
       The ID of the write stream to resume.
 This may only be set in the first message. When left empty, a new write
 stream will be created.
      string stream_id = 2;
      Specified by:
      getStreamId in interface WriteRequestOrBuilder
      Returns:
      The streamId.

    • getStreamIdBytes

      public com.google.protobuf.ByteString getStreamIdBytes()
       The ID of the write stream to resume.
 This may only be set in the first message. When left empty, a new write
 stream will be created.
      string stream_id = 2;
      Specified by:
      getStreamIdBytes in interface WriteRequestOrBuilder
      Returns:
      The bytes for streamId.

    • getWritesList

      public List<Write> getWritesList()
       The writes to apply.

 Always executed atomically and in order.
 This must be empty on the first request.
 This may be empty on the last request.
 This must not be empty on all other requests.
      repeated .google.firestore.v1.Write writes = 3;
      Specified by:
      getWritesList in interface WriteRequestOrBuilder

    • getWritesOrBuilderList

      public List<? extends WriteOrBuilder> getWritesOrBuilderList()
       The writes to apply.

 Always executed atomically and in order.
 This must be empty on the first request.
 This may be empty on the last request.
 This must not be empty on all other requests.
      repeated .google.firestore.v1.Write writes = 3;
      Specified by:
      getWritesOrBuilderList in interface WriteRequestOrBuilder

    • getWritesCount

      public int getWritesCount()
       The writes to apply.

 Always executed atomically and in order.
 This must be empty on the first request.
 This may be empty on the last request.
 This must not be empty on all other requests.
      repeated .google.firestore.v1.Write writes = 3;
      Specified by:
      getWritesCount in interface WriteRequestOrBuilder

    • getWrites

      public Write getWrites(int index)
       The writes to apply.

 Always executed atomically and in order.
 This must be empty on the first request.
 This may be empty on the last request.
 This must not be empty on all other requests.
      repeated .google.firestore.v1.Write writes = 3;
      Specified by:
      getWrites in interface WriteRequestOrBuilder

    • getWritesOrBuilder

      public WriteOrBuilder getWritesOrBuilder(int index)
       The writes to apply.

 Always executed atomically and in order.
 This must be empty on the first request.
 This may be empty on the last request.
 This must not be empty on all other requests.
      repeated .google.firestore.v1.Write writes = 3;
      Specified by:
      getWritesOrBuilder in interface WriteRequestOrBuilder

    • getStreamToken

      public com.google.protobuf.ByteString getStreamToken()
       A stream token that was previously sent by the server.

 The client should set this field to the token from the most recent
 [WriteResponse][google.firestore.v1.WriteResponse] it has received. This
 acknowledges that the client has received responses up to this token. After
 sending this token, earlier tokens may not be used anymore.

 The server may close the stream if there are too many unacknowledged
 responses.

 Leave this field unset when creating a new stream. To resume a stream at
 a specific point, set this field and the `stream_id` field.

 Leave this field unset when creating a new stream.
      bytes stream_token = 4;
      Specified by:
      getStreamToken in interface WriteRequestOrBuilder
      Returns:
      The streamToken.

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: WriteRequestOrBuilder
       Labels associated with this write request.
      map<string, string> labels = 5;
      Specified by:
      getLabelsCount in interface WriteRequestOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Labels associated with this write request.
      map<string, string> labels = 5;
      Specified by:
      containsLabels in interface WriteRequestOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface WriteRequestOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Labels associated with this write request.
      map<string, string> labels = 5;
      Specified by:
      getLabelsMap in interface WriteRequestOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Labels associated with this write request.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrDefault in interface WriteRequestOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Labels associated with this write request.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrThrow in interface WriteRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WriteRequest.Builder newBuilder()

    • newBuilder

      public static WriteRequest.Builder newBuilder(WriteRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WriteRequest getDefaultInstance()

    • parser

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

    • getParserForType

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