Class RunQueryResponse.Builder (3.10.0)

Version 3.10.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class RunQueryResponse.Builder extends GeneratedMessageV3.Builder<RunQueryResponse.Builder> implements RunQueryResponseOrBuilder

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RunQueryResponse.Builder

Implements

RunQueryResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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.

clearField(Descriptors.FieldDescriptor field)

public RunQueryResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
RunQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public RunQueryResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
RunQueryResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RunQueryResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RunQueryResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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	boolean The done to set.

Returns
Type	Description
RunQueryResponse.Builder	This builder for chaining.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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	int The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)