public static final class BatchGetDocumentsResponse.Builder extends GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder> implements BatchGetDocumentsResponseOrBuilderThe streamed response for Firestore.BatchGetDocuments.
Protobuf type google.firestore.v1.BatchGetDocumentsResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchGetDocumentsResponse.BuilderImplements
BatchGetDocumentsResponseOrBuilderStatic 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 |
|
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 |
|
clearField(Descriptors.FieldDescriptor field)
public BatchGetDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsResponse.Builder |
|
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 |
|
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 |
|
getDefaultInstanceForType()
public BatchGetDocumentsResponse getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsResponse |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BatchGetDocumentsResponse.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BatchGetDocumentsResponse.Builder |
|
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 |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
ByteStringThe 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 |
|