Class DocumentRemove.Builder

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

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
NameDescription
valuesIterable<? extends java.lang.Integer>

The removedTargetIds to add.

Returns
TypeDescription
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
NameDescription
valueint

The removedTargetIds to add.

Returns
TypeDescription
DocumentRemove.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentRemove.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DocumentRemove.Builder
Overrides

build()

public DocumentRemove build()
Returns
TypeDescription
DocumentRemove

buildPartial()

public DocumentRemove buildPartial()
Returns
TypeDescription
DocumentRemove

clear()

public DocumentRemove.Builder clear()
Returns
TypeDescription
DocumentRemove.Builder
Overrides

clearDocument()

public DocumentRemove.Builder clearDocument()

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

string document = 1;

Returns
TypeDescription
DocumentRemove.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentRemove.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DocumentRemove.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentRemove.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DocumentRemove.Builder

This builder for chaining.

clone()

public DocumentRemove.Builder clone()
Returns
TypeDescription
DocumentRemove.Builder
Overrides

getDefaultInstanceForType()

public DocumentRemove getDefaultInstanceForType()
Returns
TypeDescription
DocumentRemove

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocument()

public String getDocument()

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

string document = 1;

Returns
TypeDescription
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

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

string document = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DocumentRemove other)

public DocumentRemove.Builder mergeFrom(DocumentRemove other)
Parameter
NameDescription
otherDocumentRemove
Returns
TypeDescription
DocumentRemove.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentRemove.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentRemove.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DocumentRemove.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
DocumentRemove.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentRemove.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The document to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for document to set.

Returns
TypeDescription
DocumentRemove.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentRemove.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueint

The removedTargetIds to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DocumentRemove.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentRemove.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DocumentRemove.Builder
Overrides