Class BatchGetDocumentsResponse.Builder

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public BatchGetDocumentsResponse build()
Returns
TypeDescription
BatchGetDocumentsResponse

buildPartial()

public BatchGetDocumentsResponse buildPartial()
Returns
TypeDescription
BatchGetDocumentsResponse

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFound()

public BatchGetDocumentsResponse.Builder clearFound()

A document that was requested.

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

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchGetDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BatchGetDocumentsResponse.Builder
Overrides

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

clearResult()

public BatchGetDocumentsResponse.Builder clearResult()
Returns
TypeDescription
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
TypeDescription
BatchGetDocumentsResponse.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public BatchGetDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
BatchGetDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFound()

public Document getFound()

A document that was requested.

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

Returns
TypeDescription
Document

The found.

getFoundBuilder()

public Document.Builder getFoundBuilder()

A document that was requested.

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

Returns
TypeDescription
Document.Builder

getFoundOrBuilder()

public DocumentOrBuilder getFoundOrBuilder()

A document that was requested.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getResultCase()

public BatchGetDocumentsResponse.ResultCase getResultCase()
Returns
TypeDescription
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
TypeDescription
ByteString

The transaction.

hasFound()

public boolean hasFound()

A document that was requested.

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

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

mergeFound(Document value)

public BatchGetDocumentsResponse.Builder mergeFound(Document value)

A document that was requested.

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

Parameter
NameDescription
valueDocument
Returns
TypeDescription
BatchGetDocumentsResponse.Builder

mergeFrom(BatchGetDocumentsResponse other)

public BatchGetDocumentsResponse.Builder mergeFrom(BatchGetDocumentsResponse other)
Parameter
NameDescription
otherBatchGetDocumentsResponse
Returns
TypeDescription
BatchGetDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public BatchGetDocumentsResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BatchGetDocumentsResponse.Builder
Overrides

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
NameDescription
valueTimestamp
Returns
TypeDescription
BatchGetDocumentsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchGetDocumentsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchGetDocumentsResponse.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setFound(Document value)

public BatchGetDocumentsResponse.Builder setFound(Document value)

A document that was requested.

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

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

The missing to set.

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

The bytes for missing to set.

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

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

public BatchGetDocumentsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BatchGetDocumentsResponse.Builder
Overrides

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

The transaction to set.

Returns
TypeDescription
BatchGetDocumentsResponse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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