Package com.google.firestore.v1

Class WriteResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.WriteResponse
All Implemented Interfaces:
WriteResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class WriteResponse extends com.google.protobuf.GeneratedMessageV3 implements WriteResponseOrBuilder
 The response for [Firestore.Write][google.firestore.v1.Firestore.Write].
Protobuf type google.firestore.v1.WriteResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    WriteResponse.Builder
    The response 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
    COMMIT_TIME_FIELD_NUMBER
     
    static final int
    STREAM_ID_FIELD_NUMBER
     
    static final int
    STREAM_TOKEN_FIELD_NUMBER
     
    static final int
    WRITE_RESULTS_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
    equals(Object obj)
     
    com.google.protobuf.Timestamp
    getCommitTime()
    The time at which the commit occurred.
    com.google.protobuf.TimestampOrBuilder
    getCommitTimeOrBuilder()
    The time at which the commit occurred.
    static WriteResponse
    getDefaultInstance()
     
    WriteResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<WriteResponse>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getStreamId()
    The ID of the stream.
    com.google.protobuf.ByteString
    getStreamIdBytes()
    The ID of the stream.
    com.google.protobuf.ByteString
    getStreamToken()
    A token that represents the position of this response in the stream.
    WriteResult
    getWriteResults(int index)
    The result of applying the writes.
    int
    getWriteResultsCount()
    The result of applying the writes.
    List<WriteResult>
    getWriteResultsList()
    The result of applying the writes.
    WriteResultOrBuilder
    getWriteResultsOrBuilder(int index)
    The result of applying the writes.
    List<? extends WriteResultOrBuilder>
    getWriteResultsOrBuilderList()
    The result of applying the writes.
    boolean
    hasCommitTime()
    The time at which the commit occurred.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static WriteResponse.Builder
    newBuilder()
     
    static WriteResponse.Builder
    newBuilder(WriteResponse prototype)
     
    WriteResponse.Builder
    newBuilderForType()
     
    protected WriteResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static WriteResponse
    parseDelimitedFrom(InputStream input)
     
    static WriteResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteResponse
    parseFrom(byte[] data)
     
    static WriteResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static WriteResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static WriteResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteResponse
    parseFrom(InputStream input)
     
    static WriteResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static WriteResponse
    parseFrom(ByteBuffer data)
     
    static WriteResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<WriteResponse>
    parser()
     
    WriteResponse.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, internalGetMapFieldReflection, 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

    • STREAM_ID_FIELD_NUMBER

      public static final int STREAM_ID_FIELD_NUMBER
      See Also:

    • STREAM_TOKEN_FIELD_NUMBER

      public static final int STREAM_TOKEN_FIELD_NUMBER
      See Also:

    • WRITE_RESULTS_FIELD_NUMBER

      public static final int WRITE_RESULTS_FIELD_NUMBER
      See Also:

    • COMMIT_TIME_FIELD_NUMBER

      public static final int COMMIT_TIME_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

    • getStreamId

      public String getStreamId()
       The ID of the stream.
 Only set on the first message, when a new stream was created.
      string stream_id = 1;
      Specified by:
      getStreamId in interface WriteResponseOrBuilder
      Returns:
      The streamId.

    • getStreamIdBytes

      public com.google.protobuf.ByteString getStreamIdBytes()
       The ID of the stream.
 Only set on the first message, when a new stream was created.
      string stream_id = 1;
      Specified by:
      getStreamIdBytes in interface WriteResponseOrBuilder
      Returns:
      The bytes for streamId.

    • getStreamToken

      public com.google.protobuf.ByteString getStreamToken()
       A token that represents the position of this response in the stream.
 This can be used by a client to resume the stream at this point.

 This field is always set.
      bytes stream_token = 2;
      Specified by:
      getStreamToken in interface WriteResponseOrBuilder
      Returns:
      The streamToken.

    • getWriteResultsList

      public List<WriteResult> getWriteResultsList()
       The result of applying the writes.

 This i-th write result corresponds to the i-th write in the
 request.
      repeated .google.firestore.v1.WriteResult write_results = 3;
      Specified by:
      getWriteResultsList in interface WriteResponseOrBuilder

    • getWriteResultsOrBuilderList

      public List<? extends WriteResultOrBuilder> getWriteResultsOrBuilderList()
       The result of applying the writes.

 This i-th write result corresponds to the i-th write in the
 request.
      repeated .google.firestore.v1.WriteResult write_results = 3;
      Specified by:
      getWriteResultsOrBuilderList in interface WriteResponseOrBuilder

    • getWriteResultsCount

      public int getWriteResultsCount()
       The result of applying the writes.

 This i-th write result corresponds to the i-th write in the
 request.
      repeated .google.firestore.v1.WriteResult write_results = 3;
      Specified by:
      getWriteResultsCount in interface WriteResponseOrBuilder

    • getWriteResults

      public WriteResult getWriteResults(int index)
       The result of applying the writes.

 This i-th write result corresponds to the i-th write in the
 request.
      repeated .google.firestore.v1.WriteResult write_results = 3;
      Specified by:
      getWriteResults in interface WriteResponseOrBuilder

    • getWriteResultsOrBuilder

      public WriteResultOrBuilder getWriteResultsOrBuilder(int index)
       The result of applying the writes.

 This i-th write result corresponds to the i-th write in the
 request.
      repeated .google.firestore.v1.WriteResult write_results = 3;
      Specified by:
      getWriteResultsOrBuilder in interface WriteResponseOrBuilder

    • hasCommitTime

      public boolean hasCommitTime()
       The time at which the commit occurred. Any read with an equal or greater
 `read_time` is guaranteed to see the effects of the write.
      .google.protobuf.Timestamp commit_time = 4;
      Specified by:
      hasCommitTime in interface WriteResponseOrBuilder
      Returns:
      Whether the commitTime field is set.

    • getCommitTime

      public com.google.protobuf.Timestamp getCommitTime()
       The time at which the commit occurred. Any read with an equal or greater
 `read_time` is guaranteed to see the effects of the write.
      .google.protobuf.Timestamp commit_time = 4;
      Specified by:
      getCommitTime in interface WriteResponseOrBuilder
      Returns:
      The commitTime.

    • getCommitTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCommitTimeOrBuilder()
       The time at which the commit occurred. Any read with an equal or greater
 `read_time` is guaranteed to see the effects of the write.
      .google.protobuf.Timestamp commit_time = 4;
      Specified by:
      getCommitTimeOrBuilder in interface WriteResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WriteResponse.Builder newBuilder()

    • newBuilder

      public static WriteResponse.Builder newBuilder(WriteResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WriteResponse getDefaultInstance()

    • parser

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

    • getParserForType

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