Class DocumentChange.Builder (3.20.0)

Version latest

• 3.20.0 (latest)
• 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 DocumentChange.Builder extends GeneratedMessageV3.Builder<DocumentChange.Builder> implements DocumentChangeOrBuilder

A Document has changed.

May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document.

Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentChange

Inheritance

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

Implements

DocumentChangeOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(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

addAllRemovedTargetIds(Iterable<? extends Integer> values)

public DocumentChange.Builder addAllRemovedTargetIds(Iterable<? extends Integer> values)

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Parameter
Name	Description
values	Iterable<? extends java.lang.Integer> The removedTargetIds to add.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

addAllTargetIds(Iterable<? extends Integer> values)

public DocumentChange.Builder addAllTargetIds(Iterable<? extends Integer> values)

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Parameter
Name	Description
values	Iterable<? extends java.lang.Integer> The targetIds to add.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

addRemovedTargetIds(int value)

public DocumentChange.Builder addRemovedTargetIds(int value)

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Parameter
Name	Description
value	int The removedTargetIds to add.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentChange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentChange.Builder

Overrides

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

addTargetIds(int value)

public DocumentChange.Builder addTargetIds(int value)

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Parameter
Name	Description
value	int The targetIds to add.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

build()

public DocumentChange build()

Returns
Type	Description
DocumentChange

buildPartial()

public DocumentChange buildPartial()

Returns
Type	Description
DocumentChange

clear()

public DocumentChange.Builder clear()

Returns
Type	Description
DocumentChange.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocument()

public DocumentChange.Builder clearDocument()

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Returns
Type	Description
DocumentChange.Builder

clearField(Descriptors.FieldDescriptor field)

public DocumentChange.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
DocumentChange.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentChange.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
DocumentChange.Builder

Overrides

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

clearRemovedTargetIds()

public DocumentChange.Builder clearRemovedTargetIds()

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

clearTargetIds()

public DocumentChange.Builder clearTargetIds()

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

clone()

public DocumentChange.Builder clone()

Returns
Type	Description
DocumentChange.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentChange getDefaultInstanceForType()

Returns
Type	Description
DocumentChange

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocument()

public Document getDocument()

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Returns
Type	Description
Document	The document.

getDocumentBuilder()

public Document.Builder getDocumentBuilder()

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Returns
Type	Description
Document.Builder

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Returns
Type	Description
DocumentOrBuilder

getRemovedTargetIds(int index)

public int getRemovedTargetIds(int index)

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
int	The removedTargetIds at the given index.

getRemovedTargetIdsCount()

public int getRemovedTargetIdsCount()

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Returns
Type	Description
int	The count of removedTargetIds.

getRemovedTargetIdsList()

public List<Integer> getRemovedTargetIdsList()

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Returns
Type	Description
List<Integer>	A list containing the removedTargetIds.

getTargetIds(int index)

public int getTargetIds(int index)

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
int	The targetIds at the given index.

getTargetIdsCount()

public int getTargetIdsCount()

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Returns
Type	Description
int	The count of targetIds.

getTargetIdsList()

public List<Integer> getTargetIdsList()

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Returns
Type	Description
List<Integer>	A list containing the targetIds.

hasDocument()

public boolean hasDocument()

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Returns
Type	Description
boolean	Whether the document 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 DocumentChange.Builder mergeDocument(Document value)

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Parameter
Name	Description
value	Document

Returns
Type	Description
DocumentChange.Builder

mergeFrom(DocumentChange other)

public DocumentChange.Builder mergeFrom(DocumentChange other)

Parameter
Name	Description
other	DocumentChange

Returns
Type	Description
DocumentChange.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentChange.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public DocumentChange.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
DocumentChange.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentChange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentChange.Builder

Overrides

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

setDocument(Document value)

public DocumentChange.Builder setDocument(Document value)

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Parameter
Name	Description
value	Document

Returns
Type	Description
DocumentChange.Builder

setDocument(Document.Builder builderForValue)

public DocumentChange.Builder setDocument(Document.Builder builderForValue)

The new state of the Document.

If mask is set, contains only fields that were updated or added.

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

Parameter
Name	Description
builderForValue	Document.Builder

Returns
Type	Description
DocumentChange.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DocumentChange.Builder

Overrides

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

setRemovedTargetIds(int index, int value)

public DocumentChange.Builder setRemovedTargetIds(int index, int value)

A set of target IDs for targets that no longer match this document.

repeated int32 removed_target_ids = 6;

Parameters
Name	Description
index	int The index to set the value at.
value	int The removedTargetIds to set.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
DocumentChange.Builder

Overrides

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

setTargetIds(int index, int value)

public DocumentChange.Builder setTargetIds(int index, int value)

A set of target IDs of targets that match this document.

repeated int32 target_ids = 5;

Parameters
Name	Description
index	int The index to set the value at.
value	int The targetIds to set.

Returns
Type	Description
DocumentChange.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentChange.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DocumentChange.Builder

Overrides

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