Package com.google.firestore.v1

Interface WriteResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WriteResponse, WriteResponse.Builder
public interface WriteResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCommitTime()
    The time at which the commit occurred.
    com.google.protobuf.TimestampOrBuilder
    getCommitTimeOrBuilder()
    The time at which the commit occurred.
    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.

    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 Details

    • getStreamId

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

    • getStreamIdBytes

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

    • getStreamToken

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

    • getWriteResultsList

      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;

    • getWriteResults

      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;

    • getWriteResultsCount

      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;

    • getWriteResultsOrBuilderList

      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;

    • getWriteResultsOrBuilder

      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;

    • hasCommitTime

      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;
      Returns:
      Whether the commitTime field is set.

    • getCommitTime

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

    • getCommitTimeOrBuilder

      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;