public final class RunQueryResponse extends GeneratedMessageV3 implements RunQueryResponseOrBuilder
The response for
Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DONE_FIELD_NUMBER
public static final int DONE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXPLAIN_METRICS_FIELD_NUMBER
public static final int EXPLAIN_METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SKIPPED_RESULTS_FIELD_NUMBER
public static final int SKIPPED_RESULTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RunQueryResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RunQueryResponse.Builder newBuilder()
newBuilder(RunQueryResponse prototype)
public static RunQueryResponse.Builder newBuilder(RunQueryResponse prototype)
public static RunQueryResponse parseDelimitedFrom(InputStream input)
public static RunQueryResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RunQueryResponse parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RunQueryResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(CodedInputStream input)
public static RunQueryResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(InputStream input)
public static RunQueryResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RunQueryResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RunQueryResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RunQueryResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getContinuationSelectorCase()
public RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()
getDefaultInstanceForType()
public RunQueryResponse getDefaultInstanceForType()
getDocument()
public Document getDocument()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Returns |
|---|
| Type | Description |
Document | The document.
|
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
getDone()
If present, Firestore has completely finished the request and no more
documents will be returned.
bool done = 6;
| Returns |
|---|
| Type | Description |
boolean | The done.
|
getExplainMetrics()
public ExplainMetrics getExplainMetrics()
Query explain metrics. This is only present when the
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
is provided, and it is sent only once with the last response in the stream.
.google.firestore.v1.ExplainMetrics explain_metrics = 11;
getParserForType()
public Parser<RunQueryResponse> getParserForType()
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 |
|---|
| Type | Description |
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 |
|---|
| 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;
hasDocument()
public boolean hasDocument()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the document field is set.
|
hasDone()
If present, Firestore has completely finished the request and no more
documents will be returned.
bool done = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the done field is set.
|
hasExplainMetrics()
public boolean hasExplainMetrics()
Query explain metrics. This is only present when the
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the explainMetrics 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 |
|---|
| Type | Description |
boolean | Whether the readTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RunQueryResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RunQueryResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RunQueryResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
