Class DocumentRemove.Builder (3.5.0)

Version 3.5.0

• 3.30.2 (latest)
• 3.30.0
• 3.28.0
• 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 DocumentRemove.Builder extends GeneratedMessageV3.Builder<DocumentRemove.Builder> implements DocumentRemoveOrBuilder

A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

Inheritance

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

Implements

DocumentRemoveOrBuilder

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

addAllRemovedTargetIds(Iterable<? extends Integer> values)

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

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

Parameter

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

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

addRemovedTargetIds(int value)

public DocumentRemove.Builder addRemovedTargetIds(int value)

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

Parameter

Name	Description
value	int The removedTargetIds to add.

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

build()

public DocumentRemove build()

Returns

Type	Description
DocumentRemove

buildPartial()

public DocumentRemove buildPartial()

Returns

Type	Description
DocumentRemove

clear()

public DocumentRemove.Builder clear()

Returns

Type	Description
DocumentRemove.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocument()

public DocumentRemove.Builder clearDocument()

The resource name of the Document that has gone out of view.

string document = 1;

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentRemove.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentRemove.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

clearReadTime()

public DocumentRemove.Builder clearReadTime()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
DocumentRemove.Builder

clearRemovedTargetIds()

public DocumentRemove.Builder clearRemovedTargetIds()

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

clone()

public DocumentRemove.Builder clone()

Returns

Type	Description
DocumentRemove.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentRemove getDefaultInstanceForType()

Returns

Type	Description
DocumentRemove

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocument()

public String getDocument()

The resource name of the Document that has gone out of view.

string document = 1;

Returns

Type	Description
String	The document.

getDocumentBytes()

public ByteString getDocumentBytes()

The resource name of the Document that has gone out of view.

string document = 1;

Returns

Type	Description
ByteString	The bytes for document.

getReadTime()

public Timestamp getReadTime()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
Timestamp	The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Returns

Type	Description
TimestampOrBuilder

getRemovedTargetIds(int index)

public int getRemovedTargetIds(int index)

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

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 previously matched this document.

repeated int32 removed_target_ids = 2;

Returns

Type	Description
int	The count of removedTargetIds.

getRemovedTargetIdsList()

public List<Integer> getRemovedTargetIdsList()

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

Returns

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

hasReadTime()

public boolean hasReadTime()

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

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

mergeFrom(DocumentRemove other)

public DocumentRemove.Builder mergeFrom(DocumentRemove other)

Parameter

Name	Description
other	DocumentRemove

Returns

Type	Description
DocumentRemove.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public DocumentRemove.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

mergeReadTime(Timestamp value)

public DocumentRemove.Builder mergeReadTime(Timestamp value)

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
DocumentRemove.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentRemove.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

setDocument(String value)

public DocumentRemove.Builder setDocument(String value)

The resource name of the Document that has gone out of view.

string document = 1;

Parameter

Name	Description
value	String The document to set.

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

setDocumentBytes(ByteString value)

public DocumentRemove.Builder setDocumentBytes(ByteString value)

The resource name of the Document that has gone out of view.

string document = 1;

Parameter

Name	Description
value	ByteString The bytes for document to set.

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

setReadTime(Timestamp value)

public DocumentRemove.Builder setReadTime(Timestamp value)

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
DocumentRemove.Builder

setReadTime(Timestamp.Builder builderForValue)

public DocumentRemove.Builder setReadTime(Timestamp.Builder builderForValue)

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove.

.google.protobuf.Timestamp read_time = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
DocumentRemove.Builder

setRemovedTargetIds(int index, int value)

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

A set of target IDs for targets that previously matched this document.

repeated int32 removed_target_ids = 2;

Parameters

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

Returns

Type	Description
DocumentRemove.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
DocumentRemove.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentRemove.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
DocumentRemove.Builder

Overrides

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