com.google.firestore.v1beta1

Interface RunQueryResponseOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

RunQueryResponse, RunQueryResponse.Builder

public interface RunQueryResponseOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Document	getDocument() A query result.
DocumentOrBuilder	getDocumentOrBuilder() A query result.
Timestamp	getReadTime() The time at which the document was read.
TimestampOrBuilder	getReadTimeOrBuilder() The time at which the document was read.
int	getSkippedResults() The number of results that have been skipped due to an offset between the last response and the current response.
ByteString	getTransaction() The transaction that was started as part of this request.
boolean	hasDocument() A query result.
boolean	hasReadTime() The time at which the document was read.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTransaction

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.v1beta1.RunQueryRequest.new_transaction] was set in the request.
 If set, no other fields will be set in this response.
 

bytes transaction = 2;

hasDocument

boolean hasDocument()

 A query result.
 Not set when reporting partial progress.
 

.google.firestore.v1beta1.Document document = 1;

getDocument

Document getDocument()

 A query result.
 Not set when reporting partial progress.
 

.google.firestore.v1beta1.Document document = 1;

getDocumentOrBuilder

DocumentOrBuilder getDocumentOrBuilder()

 A query result.
 Not set when reporting partial progress.
 

.google.firestore.v1beta1.Document document = 1;

hasReadTime

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;

getReadTime

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;

getReadTimeOrBuilder

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;

getSkippedResults

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;