com.google.firestore.v1

Class BatchGetDocumentsResponse.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

com.google.firestore.v1.BatchGetDocumentsResponse.Builder

All Implemented Interfaces:

BatchGetDocumentsResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BatchGetDocumentsResponse

public static final class BatchGetDocumentsResponse.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>
implements BatchGetDocumentsResponseOrBuilder

 The streamed response for
 [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
 

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

Method Summary

Modifier and Type	Method and Description
BatchGetDocumentsResponse.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchGetDocumentsResponse	build()
BatchGetDocumentsResponse	buildPartial()
BatchGetDocumentsResponse.Builder	clear()
BatchGetDocumentsResponse.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BatchGetDocumentsResponse.Builder	clearFound() A document that was requested.
BatchGetDocumentsResponse.Builder	clearMissing() A document name that was requested but does not exist.
BatchGetDocumentsResponse.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BatchGetDocumentsResponse.Builder	clearReadTime() The time at which the document was read.
BatchGetDocumentsResponse.Builder	clearResult()
BatchGetDocumentsResponse.Builder	clearTransaction() The transaction that was started as part of this request.
BatchGetDocumentsResponse.Builder	clone()
BatchGetDocumentsResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Document	getFound() A document that was requested.
Document.Builder	getFoundBuilder() A document that was requested.
DocumentOrBuilder	getFoundOrBuilder() A document that was requested.
String	getMissing() A document name that was requested but does not exist.
com.google.protobuf.ByteString	getMissingBytes() A document name that was requested but does not exist.
com.google.protobuf.Timestamp	getReadTime() The time at which the document was read.
com.google.protobuf.Timestamp.Builder	getReadTimeBuilder() The time at which the document was read.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() The time at which the document was read.
BatchGetDocumentsResponse.ResultCase	getResultCase()
com.google.protobuf.ByteString	getTransaction() The transaction that was started as part of this request.
boolean	hasFound() A document that was requested.
boolean	hasMissing() A document name that was requested but does not exist.
boolean	hasReadTime() The time at which the document was read.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
BatchGetDocumentsResponse.Builder	mergeFound(Document value) A document that was requested.
BatchGetDocumentsResponse.Builder	mergeFrom(BatchGetDocumentsResponse other)
BatchGetDocumentsResponse.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BatchGetDocumentsResponse.Builder	mergeFrom(com.google.protobuf.Message other)
BatchGetDocumentsResponse.Builder	mergeReadTime(com.google.protobuf.Timestamp value) The time at which the document was read.
BatchGetDocumentsResponse.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BatchGetDocumentsResponse.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchGetDocumentsResponse.Builder	setFound(Document.Builder builderForValue) A document that was requested.
BatchGetDocumentsResponse.Builder	setFound(Document value) A document that was requested.
BatchGetDocumentsResponse.Builder	setMissing(String value) A document name that was requested but does not exist.
BatchGetDocumentsResponse.Builder	setMissingBytes(com.google.protobuf.ByteString value) A document name that was requested but does not exist.
BatchGetDocumentsResponse.Builder	setReadTime(com.google.protobuf.Timestamp.Builder builderForValue) The time at which the document was read.
BatchGetDocumentsResponse.Builder	setReadTime(com.google.protobuf.Timestamp value) The time at which the document was read.
BatchGetDocumentsResponse.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BatchGetDocumentsResponse.Builder	setTransaction(com.google.protobuf.ByteString value) The transaction that was started as part of this request.
BatchGetDocumentsResponse.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

clear

public BatchGetDocumentsResponse.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

getDefaultInstanceForType

public BatchGetDocumentsResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BatchGetDocumentsResponse build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public BatchGetDocumentsResponse buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public BatchGetDocumentsResponse.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

clearField

public BatchGetDocumentsResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

clearOneof

public BatchGetDocumentsResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

addRepeatedField

public BatchGetDocumentsResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

mergeFrom

public BatchGetDocumentsResponse.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchGetDocumentsResponse.Builder>

mergeFrom

public BatchGetDocumentsResponse.Builder mergeFrom(BatchGetDocumentsResponse other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

mergeFrom

public BatchGetDocumentsResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchGetDocumentsResponse.Builder>

Throws:

IOException

getResultCase

public BatchGetDocumentsResponse.ResultCase getResultCase()

Specified by:

getResultCase in interface BatchGetDocumentsResponseOrBuilder

clearResult

public BatchGetDocumentsResponse.Builder clearResult()

hasFound

public boolean hasFound()

 A document that was requested.
 

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

Specified by:

hasFound in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the found field is set.

getFound

public Document getFound()

 A document that was requested.
 

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

Specified by:

getFound in interface BatchGetDocumentsResponseOrBuilder

Returns:

The found.

setFound

public BatchGetDocumentsResponse.Builder setFound(Document value)

 A document that was requested.
 

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

setFound

public BatchGetDocumentsResponse.Builder setFound(Document.Builder builderForValue)

 A document that was requested.
 

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

mergeFound

public BatchGetDocumentsResponse.Builder mergeFound(Document value)

 A document that was requested.
 

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

clearFound

public BatchGetDocumentsResponse.Builder clearFound()

 A document that was requested.
 

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

getFoundBuilder

public Document.Builder getFoundBuilder()

 A document that was requested.
 

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

getFoundOrBuilder

public DocumentOrBuilder getFoundOrBuilder()

 A document that was requested.
 

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

Specified by:

getFoundOrBuilder in interface BatchGetDocumentsResponseOrBuilder

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;

Specified by:

hasMissing in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the missing field is set.

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;

Specified by:

getMissing in interface BatchGetDocumentsResponseOrBuilder

Returns:

The missing.

getMissingBytes

public com.google.protobuf.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;

Specified by:

getMissingBytes in interface BatchGetDocumentsResponseOrBuilder

Returns:

The bytes for missing.

setMissing

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;

Parameters:

value - The missing to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setMissingBytes

public BatchGetDocumentsResponse.Builder setMissingBytes(com.google.protobuf.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;

Parameters:

value - The bytes for missing to set.

Returns:

This builder for chaining.

getTransaction

public com.google.protobuf.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][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]
 was set in the request.
 

bytes transaction = 3;

Specified by:

getTransaction in interface BatchGetDocumentsResponseOrBuilder

Returns:

The transaction.

setTransaction

public BatchGetDocumentsResponse.Builder setTransaction(com.google.protobuf.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][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]
 was set in the request.
 

bytes transaction = 3;

Parameters:

value - The transaction to set.

Returns:

This builder for chaining.

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][google.firestore.v1.BatchGetDocumentsRequest.new_transaction]
 was set in the request.
 

bytes transaction = 3;

Returns:

This builder for chaining.

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;

Specified by:

hasReadTime in interface BatchGetDocumentsResponseOrBuilder

Returns:

Whether the readTime field is set.

getReadTime

public com.google.protobuf.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;

Specified by:

getReadTime in interface BatchGetDocumentsResponseOrBuilder

Returns:

The readTime.

setReadTime

public BatchGetDocumentsResponse.Builder setReadTime(com.google.protobuf.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;

setReadTime

public BatchGetDocumentsResponse.Builder setReadTime(com.google.protobuf.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;

mergeReadTime

public BatchGetDocumentsResponse.Builder mergeReadTime(com.google.protobuf.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;

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;

getReadTimeBuilder

public com.google.protobuf.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;

getReadTimeOrBuilder

public com.google.protobuf.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;

Specified by:

getReadTimeOrBuilder in interface BatchGetDocumentsResponseOrBuilder

setUnknownFields

public final BatchGetDocumentsResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>

mergeUnknownFields

public final BatchGetDocumentsResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchGetDocumentsResponse.Builder>