Class RunQueryResponse.Builder (3.1.0)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunQueryResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunQueryResponse.Builder
Overrides

build()

public RunQueryResponse build()
Returns
TypeDescription
RunQueryResponse

buildPartial()

public RunQueryResponse buildPartial()
Returns
TypeDescription
RunQueryResponse

clear()

public RunQueryResponse.Builder clear()
Returns
TypeDescription
RunQueryResponse.Builder
Overrides

clearDocument()

public RunQueryResponse.Builder clearDocument()

A query result, not set when reporting partial progress.

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

Returns
TypeDescription
RunQueryResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public RunQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunQueryResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RunQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunQueryResponse.Builder
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;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RunQueryResponse.Builder

This builder for chaining.

clone()

public RunQueryResponse.Builder clone()
Returns
TypeDescription
RunQueryResponse.Builder
Overrides

getDefaultInstanceForType()

public RunQueryResponse getDefaultInstanceForType()
Returns
TypeDescription
RunQueryResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocument()

public Document getDocument()

A query result, not set when reporting partial progress.

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

Returns
TypeDescription
Document

The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

A query result, not set when reporting partial progress.

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

Returns
TypeDescription
Document.Builder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

A query result, not set when reporting partial progress.

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

Returns
TypeDescription
DocumentOrBuilder

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.

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
TypeDescription
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
TypeDescription
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
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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
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;

Parameter
NameDescription
valueDocument
Returns
TypeDescription
RunQueryResponse.Builder

mergeFrom(RunQueryResponse other)

public RunQueryResponse.Builder mergeFrom(RunQueryResponse other)
Parameter
NameDescription
otherRunQueryResponse
Returns
TypeDescription
RunQueryResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunQueryResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunQueryResponse.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunQueryResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RunQueryResponse.Builder
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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RunQueryResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunQueryResponse.Builder
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;

Parameter
NameDescription
valueDocument
Returns
TypeDescription
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
NameDescription
builderForValueDocument.Builder
Returns
TypeDescription
RunQueryResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunQueryResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunQueryResponse.Builder
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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
RunQueryResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunQueryResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunQueryResponse.Builder
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;

Parameter
NameDescription
valueint

The skippedResults to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The transaction to set.

Returns
TypeDescription
RunQueryResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RunQueryResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunQueryResponse.Builder
Overrides