public static final class RunQueryResponse.Builder extends GeneratedMessageV3.Builder<RunQueryResponse.Builder> implements RunQueryResponseOrBuilder
The response for Firestore.RunQuery.
Protobuf type google.firestore.v1.RunQueryResponse
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RunQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public RunQueryResponse build()
Returns
buildPartial()
public RunQueryResponse buildPartial()
Returns
clear()
public RunQueryResponse.Builder clear()
Returns
Overrides
clearDocument()
public RunQueryResponse.Builder clearDocument()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
clearField(Descriptors.FieldDescriptor field)
public RunQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public RunQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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;
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;
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;
clone()
public RunQueryResponse.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public RunQueryResponse getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getDocument()
public Document getDocument()
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
getDocumentBuilder()
public Document.Builder getDocumentBuilder()
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;
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;
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;
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;
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;
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeDocument(Document value)
public RunQueryResponse.Builder mergeDocument(Document value)
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
mergeFrom(RunQueryResponse other)
public RunQueryResponse.Builder mergeFrom(RunQueryResponse other)
Parameter
Returns
public RunQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public RunQueryResponse.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setDocument(Document value)
public RunQueryResponse.Builder setDocument(Document value)
A query result, not set when reporting partial progress.
.google.firestore.v1.Document document = 1;
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;
setField(Descriptors.FieldDescriptor field, Object value)
public RunQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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;
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;
| Name | Description |
| builderForValue | Builder
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RunQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
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;
| Name | Description |
| value | int
The skippedResults to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The transaction to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final RunQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
