Class BatchGetDocumentsResponse.Builder (3.4.1)

Version 3.4.1

• 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 BatchGetDocumentsResponse.Builder extends GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder> implements BatchGetDocumentsResponseOrBuilder

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

Inheritance

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

Implements

BatchGetDocumentsResponseOrBuilder

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)

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)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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 BatchGetDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

build()

public BatchGetDocumentsResponse build()

Returns

Type	Description
BatchGetDocumentsResponse

buildPartial()

public BatchGetDocumentsResponse buildPartial()

Returns

Type	Description
BatchGetDocumentsResponse

clear()

public BatchGetDocumentsResponse.Builder clear()

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public BatchGetDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

clearFound()

public BatchGetDocumentsResponse.Builder clearFound()

A document that was requested.

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

Returns

Type	Description
BatchGetDocumentsResponse.Builder

clearMissing()

public BatchGetDocumentsResponse.Builder clearMissing()

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Returns

Type	Description
BatchGetDocumentsResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchGetDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

clearReadTime()

public BatchGetDocumentsResponse.Builder clearReadTime()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
BatchGetDocumentsResponse.Builder

clearResult()

public BatchGetDocumentsResponse.Builder clearResult()

Returns

Type	Description
BatchGetDocumentsResponse.Builder

clearTransaction()

public BatchGetDocumentsResponse.Builder clearTransaction()

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

bytes transaction = 3;

Returns

Type	Description
BatchGetDocumentsResponse.Builder	This builder for chaining.

clone()

public BatchGetDocumentsResponse.Builder clone()

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public BatchGetDocumentsResponse getDefaultInstanceForType()

Returns

Type	Description
BatchGetDocumentsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFound()

public Document getFound()

A document that was requested.

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

Returns

Type	Description
Document	The found.

getFoundBuilder()

public Document.Builder getFoundBuilder()

A document that was requested.

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

Returns

Type	Description
Document.Builder

getFoundOrBuilder()

public DocumentOrBuilder getFoundOrBuilder()

A document that was requested.

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

Returns

Type	Description
DocumentOrBuilder

getMissing()

public String getMissing()

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Returns

Type	Description
String	The missing.

getMissingBytes()

public ByteString getMissingBytes()

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Returns

Type	Description
ByteString	The bytes for missing.

getReadTime()

public Timestamp getReadTime()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
Timestamp	The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
TimestampOrBuilder

getResultCase()

public BatchGetDocumentsResponse.ResultCase getResultCase()

Returns

Type	Description
BatchGetDocumentsResponse.ResultCase

getTransaction()

public ByteString getTransaction()

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

bytes transaction = 3;

Returns

Type	Description
ByteString	The transaction.

hasFound()

public boolean hasFound()

A document that was requested.

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

Returns

Type	Description
boolean	Whether the found field is set.

hasMissing()

public boolean hasMissing()

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Returns

Type	Description
boolean	Whether the missing field is set.

hasReadTime()

public boolean hasReadTime()

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

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()

mergeFound(Document value)

public BatchGetDocumentsResponse.Builder mergeFound(Document value)

A document that was requested.

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

Parameter

Name	Description
value	Document

Returns

Type	Description
BatchGetDocumentsResponse.Builder

mergeFrom(BatchGetDocumentsResponse other)

public BatchGetDocumentsResponse.Builder mergeFrom(BatchGetDocumentsResponse other)

Parameter

Name	Description
other	BatchGetDocumentsResponse

Returns

Type	Description
BatchGetDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchGetDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public BatchGetDocumentsResponse.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

mergeReadTime(Timestamp value)

public BatchGetDocumentsResponse.Builder mergeReadTime(Timestamp value)

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
BatchGetDocumentsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchGetDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

public BatchGetDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

setFound(Document value)

public BatchGetDocumentsResponse.Builder setFound(Document value)

A document that was requested.

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

Parameter

Name	Description
value	Document

Returns

Type	Description
BatchGetDocumentsResponse.Builder

setFound(Document.Builder builderForValue)

public BatchGetDocumentsResponse.Builder setFound(Document.Builder builderForValue)

A document that was requested.

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

Parameter

Name	Description
builderForValue	Document.Builder

Returns

Type	Description
BatchGetDocumentsResponse.Builder

setMissing(String value)

public BatchGetDocumentsResponse.Builder setMissing(String value)

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Parameter

Name	Description
value	String The missing to set.

Returns

Type	Description
BatchGetDocumentsResponse.Builder	This builder for chaining.

setMissingBytes(ByteString value)

public BatchGetDocumentsResponse.Builder setMissingBytes(ByteString value)

A document name that was requested but does not exist. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string missing = 2;

Parameter

Name	Description
value	ByteString The bytes for missing to set.

Returns

Type	Description
BatchGetDocumentsResponse.Builder	This builder for chaining.

setReadTime(Timestamp value)

public BatchGetDocumentsResponse.Builder setReadTime(Timestamp value)

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
BatchGetDocumentsResponse.Builder

setReadTime(Timestamp.Builder builderForValue)

public BatchGetDocumentsResponse.Builder setReadTime(Timestamp.Builder builderForValue)

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
BatchGetDocumentsResponse.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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

setTransaction(ByteString value)

public BatchGetDocumentsResponse.Builder setTransaction(ByteString value)

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

bytes transaction = 3;

Parameter

Name	Description
value	ByteString The transaction to set.

Returns

Type	Description
BatchGetDocumentsResponse.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchGetDocumentsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
BatchGetDocumentsResponse.Builder

Overrides

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