Class RunQueryResponse

public final class RunQueryResponse extends GeneratedMessageV3 implements RunQueryResponseOrBuilder

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SKIPPED_RESULTS_FIELD_NUMBER

public static final int SKIPPED_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static RunQueryResponse getDefaultInstance()
Returns
TypeDescription
RunQueryResponse

getDefaultInstanceForType()

public RunQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
RunQueryResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDocument()

public Document getDocument()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
DocumentOrBuilder

getParserForType()

public Parser<RunQueryResponse> getParserForType()
Returns
TypeDescription
Parser<RunQueryResponse>
Overrides

getReadTime()

public 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;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public 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;

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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;

Returns
TypeDescription
int

The skippedResults.

getTransaction()

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

bytes transaction = 2;

Returns
TypeDescription
ByteString

The transaction.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDocument()

public boolean hasDocument()

A query result. Not set when reporting partial progress.

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

Returns
TypeDescription
boolean

Whether the document field is set.

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;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static RunQueryResponse.Builder newBuilder()
Returns
TypeDescription
RunQueryResponse.Builder

newBuilder(RunQueryResponse prototype)

public static RunQueryResponse.Builder newBuilder(RunQueryResponse prototype)
Parameter
NameDescription
prototypeRunQueryResponse
Returns
TypeDescription
RunQueryResponse.Builder

newBuilderForType()

public RunQueryResponse.Builder newBuilderForType()
Returns
TypeDescription
RunQueryResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RunQueryResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static RunQueryResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RunQueryResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunQueryResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunQueryResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RunQueryResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RunQueryResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RunQueryResponse> parser()
Returns
TypeDescription
Parser<RunQueryResponse>

toBuilder()

public RunQueryResponse.Builder toBuilder()
Returns
TypeDescription
RunQueryResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException