public static final class RunQueryResponse.Builder extends GeneratedMessageV3.Builder<RunQueryResponse.Builder> implements RunQueryResponseOrBuilderThe response for Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunQueryResponse.BuilderImplements
RunQueryResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
build()
public RunQueryResponse build()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse | |
buildPartial()
public RunQueryResponse buildPartial()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse | |
clear()
public RunQueryResponse.Builder clear()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
clearContinuationSelector()
public RunQueryResponse.Builder clearContinuationSelector()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
clearDocument()
public RunQueryResponse.Builder clearDocument()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
clearDone()
public RunQueryResponse.Builder clearDone()If present, Firestore has completely finished the request and no more documents will be returned.
bool done = 6;
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | This builder for chaining. |
clearExplainMetrics()
public RunQueryResponse.Builder clearExplainMetrics()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 |
RunQueryResponse.Builder | |
clearField(Descriptors.FieldDescriptor field)
public RunQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public RunQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
clearReadTime()
public RunQueryResponse.Builder clearReadTime() 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 |
RunQueryResponse.Builder | |
clearSkippedResults()
public RunQueryResponse.Builder clearSkippedResults()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 |
RunQueryResponse.Builder | This builder for chaining. |
clearTransaction()
public RunQueryResponse.Builder clearTransaction()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 | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | This builder for chaining. |
clone()
public RunQueryResponse.Builder clone()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
getContinuationSelectorCase()
public RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.ContinuationSelectorCase | |
getDefaultInstanceForType()
public RunQueryResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RunQueryResponse | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getDocumentBuilder()
public Document.Builder getDocumentBuilder()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Returns | |
|---|---|
| Type | Description |
Document.Builder | |
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Returns | |
|---|---|
| Type | Description |
DocumentOrBuilder | |
getDone()
public boolean 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;
| Returns | |
|---|---|
| Type | Description |
ExplainMetrics | The explainMetrics. |
getExplainMetricsBuilder()
public ExplainMetrics.Builder getExplainMetricsBuilder()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 |
ExplainMetrics.Builder | |
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;
| Returns | |
|---|---|
| Type | Description |
ExplainMetricsOrBuilder | |
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 | |
|---|---|
| Type | Description |
Timestamp | The readTime. |
getReadTimeBuilder()
public Timestamp.Builder getReadTimeBuilder() 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 |
Builder | |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The transaction. |
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()
public boolean 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDocument(Document value)
public RunQueryResponse.Builder mergeDocument(Document value)A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Parameter | |
|---|---|
| Name | Description |
value | Document |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
mergeExplainMetrics(ExplainMetrics value)
public RunQueryResponse.Builder mergeExplainMetrics(ExplainMetrics value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ExplainMetrics |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
mergeFrom(RunQueryResponse other)
public RunQueryResponse.Builder mergeFrom(RunQueryResponse other)| Parameter | |
|---|---|
| Name | Description |
other | RunQueryResponse |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RunQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public RunQueryResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
mergeReadTime(Timestamp value)
public RunQueryResponse.Builder mergeReadTime(Timestamp value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setDocument(Document value)
public RunQueryResponse.Builder setDocument(Document value)A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Parameter | |
|---|---|
| Name | Description |
value | Document |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setDocument(Document.Builder builderForValue)
public RunQueryResponse.Builder setDocument(Document.Builder builderForValue)A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Document.Builder |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setDone(boolean value)
public RunQueryResponse.Builder setDone(boolean value)If present, Firestore has completely finished the request and no more documents will be returned.
bool done = 6;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe done to set. |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | This builder for chaining. |
setExplainMetrics(ExplainMetrics value)
public RunQueryResponse.Builder setExplainMetrics(ExplainMetrics value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ExplainMetrics |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setExplainMetrics(ExplainMetrics.Builder builderForValue)
public RunQueryResponse.Builder setExplainMetrics(ExplainMetrics.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExplainMetrics.Builder |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public RunQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setReadTime(Timestamp value)
public RunQueryResponse.Builder setReadTime(Timestamp value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setReadTime(Timestamp.Builder builderForValue)
public RunQueryResponse.Builder setReadTime(Timestamp.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |
setSkippedResults(int value)
public RunQueryResponse.Builder setSkippedResults(int value)The number of results that have been skipped due to an offset between the last response and the current response.
int32 skipped_results = 4;
| Parameter | |
|---|---|
| Name | Description |
value | intThe skippedResults to set. |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | This builder for chaining. |
setTransaction(ByteString value)
public RunQueryResponse.Builder setTransaction(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe transaction to set. |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RunQueryResponse.Builder | |