public final class RunQueryResponse extends GeneratedMessageV3 implements RunQueryResponseOrBuilder
The response for Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryResponse
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
SKIPPED_RESULTS_FIELD_NUMBER
public static final int SKIPPED_RESULTS_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RunQueryResponse getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RunQueryResponse.Builder newBuilder()
Returns
newBuilder(RunQueryResponse prototype)
public static RunQueryResponse.Builder newBuilder(RunQueryResponse prototype)
Parameter
Returns
public static RunQueryResponse parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RunQueryResponse parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RunQueryResponse parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunQueryResponse parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RunQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RunQueryResponse parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RunQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RunQueryResponse parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RunQueryResponse> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public RunQueryResponse getDefaultInstanceForType()
Returns
getDocument()
public Document getDocument()
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;
getParserForType()
public Parser<RunQueryResponse> getParserForType()
Returns
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;
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;
getSerializedSize()
public int getSerializedSize()
Returns
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;
| Type | Description |
| 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDocument()
public boolean hasDocument()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the readTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RunQueryResponse.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RunQueryResponse.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
