Package com.google.firestore.v1

Class RunQueryResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>
com.google.firestore.v1.RunQueryResponse.Builder
All Implemented Interfaces:
RunQueryResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RunQueryResponse
public static final class RunQueryResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder> implements RunQueryResponseOrBuilder
 The response for
 [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
Protobuf type google.firestore.v1.RunQueryResponse

  • Method Details

    • 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.Builder<RunQueryResponse.Builder>

    • clear

      public RunQueryResponse.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • getDefaultInstanceForType

      public RunQueryResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public RunQueryResponse build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public RunQueryResponse buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public RunQueryResponse.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • setField

      public RunQueryResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • clearField

      public RunQueryResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • clearOneof

      public RunQueryResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • setRepeatedField

      public RunQueryResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • addRepeatedField

      public RunQueryResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • mergeFrom

      public RunQueryResponse.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunQueryResponse.Builder>

    • mergeFrom

      public RunQueryResponse.Builder mergeFrom(RunQueryResponse other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • mergeFrom

      public RunQueryResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunQueryResponse.Builder>
      Throws:
      IOException

    • getContinuationSelectorCase

      public RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()
      Specified by:
      getContinuationSelectorCase in interface RunQueryResponseOrBuilder

    • clearContinuationSelector

      public RunQueryResponse.Builder clearContinuationSelector()

    • getTransaction

      public com.google.protobuf.ByteString getTransaction()
       The transaction that was started as part of this request.
 Can only be set in the first response, and only if
 [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
 was set in the request. If set, no other fields will be set in this
 response.
      bytes transaction = 2;
      Specified by:
      getTransaction in interface RunQueryResponseOrBuilder
      Returns:
      The transaction.

    • setTransaction

      public RunQueryResponse.Builder setTransaction(com.google.protobuf.ByteString value)
       The transaction that was started as part of this request.
 Can only be set in the first response, and only if
 [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
 was set in the request. If set, no other fields will be set in this
 response.
      bytes transaction = 2;
      Parameters:
      value - The transaction to set.
      Returns:
      This builder for chaining.

    • clearTransaction

      public RunQueryResponse.Builder clearTransaction()
       The transaction that was started as part of this request.
 Can only be set in the first response, and only if
 [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
 was set in the request. If set, no other fields will be set in this
 response.
      bytes transaction = 2;
      Returns:
      This builder for chaining.

    • hasDocument

      public boolean hasDocument()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;
      Specified by:
      hasDocument in interface RunQueryResponseOrBuilder
      Returns:
      Whether the document field is set.

    • getDocument

      public Document getDocument()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;
      Specified by:
      getDocument in interface RunQueryResponseOrBuilder
      Returns:
      The document.

    • setDocument

      public RunQueryResponse.Builder setDocument(Document value)
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • setDocument

      public RunQueryResponse.Builder setDocument(Document.Builder builderForValue)
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • mergeDocument

      public RunQueryResponse.Builder mergeDocument(Document value)
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • clearDocument

      public RunQueryResponse.Builder clearDocument()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • getDocumentBuilder

      public Document.Builder getDocumentBuilder()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • getDocumentOrBuilder

      public DocumentOrBuilder getDocumentOrBuilder()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;
      Specified by:
      getDocumentOrBuilder in interface RunQueryResponseOrBuilder

    • hasReadTime

      public boolean hasReadTime()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      hasReadTime in interface RunQueryResponseOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTime in interface RunQueryResponseOrBuilder
      Returns:
      The readTime.

    • setReadTime

      public RunQueryResponse.Builder setReadTime(com.google.protobuf.Timestamp value)
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • setReadTime

      public RunQueryResponse.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • mergeReadTime

      public RunQueryResponse.Builder mergeReadTime(com.google.protobuf.Timestamp value)
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • clearReadTime

      public RunQueryResponse.Builder clearReadTime()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • getReadTimeBuilder

      public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents in the result stream are
 guaranteed not to have changed between their `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTimeOrBuilder in interface RunQueryResponseOrBuilder

    • getSkippedResults

      public int getSkippedResults()
       The number of results that have been skipped due to an offset between
 the last response and the current response.
      int32 skipped_results = 4;
      Specified by:
      getSkippedResults in interface RunQueryResponseOrBuilder
      Returns:
      The skippedResults.

    • setSkippedResults

      public RunQueryResponse.Builder setSkippedResults(int value)
       The number of results that have been skipped due to an offset between
 the last response and the current response.
      int32 skipped_results = 4;
      Parameters:
      value - The skippedResults to set.
      Returns:
      This builder for chaining.

    • clearSkippedResults

      public RunQueryResponse.Builder clearSkippedResults()
       The number of results that have been skipped due to an offset between
 the last response and the current response.
      int32 skipped_results = 4;
      Returns:
      This builder for chaining.

    • hasDone

      public boolean hasDone()
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Specified by:
      hasDone in interface RunQueryResponseOrBuilder
      Returns:
      Whether the done field is set.

    • getDone

      public boolean getDone()
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Specified by:
      getDone in interface RunQueryResponseOrBuilder
      Returns:
      The done.

    • setDone

      public RunQueryResponse.Builder setDone(boolean value)
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Parameters:
      value - The done to set.
      Returns:
      This builder for chaining.

    • clearDone

      public RunQueryResponse.Builder clearDone()
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Returns:
      This builder for chaining.

    • hasExplainMetrics

      public boolean hasExplainMetrics()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;
      Specified by:
      hasExplainMetrics in interface RunQueryResponseOrBuilder
      Returns:
      Whether the explainMetrics field is set.

    • getExplainMetrics

      public ExplainMetrics getExplainMetrics()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;
      Specified by:
      getExplainMetrics in interface RunQueryResponseOrBuilder
      Returns:
      The explainMetrics.

    • setExplainMetrics

      public RunQueryResponse.Builder setExplainMetrics(ExplainMetrics value)
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • setExplainMetrics

      public RunQueryResponse.Builder setExplainMetrics(ExplainMetrics.Builder builderForValue)
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • mergeExplainMetrics

      public RunQueryResponse.Builder mergeExplainMetrics(ExplainMetrics value)
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • clearExplainMetrics

      public RunQueryResponse.Builder clearExplainMetrics()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • getExplainMetricsBuilder

      public ExplainMetrics.Builder getExplainMetricsBuilder()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • getExplainMetricsOrBuilder

      public ExplainMetricsOrBuilder getExplainMetricsOrBuilder()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;
      Specified by:
      getExplainMetricsOrBuilder in interface RunQueryResponseOrBuilder

    • setUnknownFields

      public final RunQueryResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>

    • mergeUnknownFields

      public final RunQueryResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunQueryResponse.Builder>