Class DocumentRemove.Builder (3.22.0)

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

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentRemove.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DocumentRemove.Builder
Overrides

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

getDefaultInstanceForType()

public DocumentRemove getDefaultInstanceForType()
Returns
Type Description
DocumentRemove

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DocumentRemove.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DocumentRemove.Builder
Overrides

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentRemove.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentRemove.Builder
Overrides