com.google.firestore.v1

Class RunQueryResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.RunQueryResponse

All Implemented Interfaces:

RunQueryResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RunQueryResponse
extends com.google.protobuf.GeneratedMessageV3
implements RunQueryResponseOrBuilder

 The response for
 [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
 

Protobuf type google.firestore.v1.RunQueryResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunQueryResponse.Builder The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
static class	RunQueryResponse.ContinuationSelectorCase

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 and Description
static int	DOCUMENT_FIELD_NUMBER
static int	DONE_FIELD_NUMBER
static int	READ_TIME_FIELD_NUMBER
static int	SKIPPED_RESULTS_FIELD_NUMBER
static int	TRANSACTION_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 and Description
boolean	equals(Object obj)
RunQueryResponse.ContinuationSelectorCase	getContinuationSelectorCase()
static RunQueryResponse	getDefaultInstance()
RunQueryResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getDocument() A query result, not set when reporting partial progress.
DocumentOrBuilder	getDocumentOrBuilder() A query result, not set when reporting partial progress.
boolean	getDone() If present, Firestore has completely finished the request and no more documents will be returned.
com.google.protobuf.Parser<RunQueryResponse>	getParserForType()
com.google.protobuf.Timestamp	getReadTime() The time at which the document was read.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() The time at which the document was read.
int	getSerializedSize()
int	getSkippedResults() The number of results that have been skipped due to an offset between the last response and the current response.
com.google.protobuf.ByteString	getTransaction() The transaction that was started as part of this request.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDocument() A query result, not set when reporting partial progress.
boolean	hasDone() If present, Firestore has completely finished the request and no more documents will be returned.
int	hashCode()
boolean	hasReadTime() The time at which the document was read.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunQueryResponse.Builder	newBuilder()
static RunQueryResponse.Builder	newBuilder(RunQueryResponse prototype)
RunQueryResponse.Builder	newBuilderForType()
protected RunQueryResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RunQueryResponse	parseDelimitedFrom(InputStream input)
static RunQueryResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryResponse	parseFrom(byte[] data)
static RunQueryResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryResponse	parseFrom(ByteBuffer data)
static RunQueryResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryResponse	parseFrom(com.google.protobuf.ByteString data)
static RunQueryResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static RunQueryResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunQueryResponse	parseFrom(InputStream input)
static RunQueryResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunQueryResponse>	parser()
RunQueryResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

See Also:

Constant Field Values

SKIPPED_RESULTS_FIELD_NUMBER

public static final int SKIPPED_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

DONE_FIELD_NUMBER

public static final int DONE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getContinuationSelectorCase

public RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()

Specified by:

getContinuationSelectorCase in interface RunQueryResponseOrBuilder

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.

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.

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.

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.

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.

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 RunQueryResponse parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryResponse parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryResponse parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunQueryResponse parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RunQueryResponse parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static RunQueryResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunQueryResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunQueryResponse.Builder newBuilder()

newBuilder

public static RunQueryResponse.Builder newBuilder(RunQueryResponse prototype)

toBuilder

public RunQueryResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RunQueryResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunQueryResponse getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RunQueryResponse> 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 RunQueryResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder