Class DocumentDelete.Builder (3.25.1)

public static final class DocumentDelete.Builder extends GeneratedMessageV3.Builder<DocumentDelete.Builder> implements DocumentDeleteOrBuilder

A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document.

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

Protobuf type google.firestore.v1.DocumentDelete

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRemovedTargetIds(Iterable<? extends Integer> values)

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

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

repeated int32 removed_target_ids = 6;

Parameter
Name Description
values Iterable<? extends java.lang.Integer>

The removedTargetIds to add.

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

addRemovedTargetIds(int value)

public DocumentDelete.Builder addRemovedTargetIds(int value)

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

repeated int32 removed_target_ids = 6;

Parameter
Name Description
value int

The removedTargetIds to add.

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentDelete.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentDelete.Builder
Overrides

build()

public DocumentDelete build()
Returns
Type Description
DocumentDelete

buildPartial()

public DocumentDelete buildPartial()
Returns
Type Description
DocumentDelete

clear()

public DocumentDelete.Builder clear()
Returns
Type Description
DocumentDelete.Builder
Overrides

clearDocument()

public DocumentDelete.Builder clearDocument()

The resource name of the Document that was deleted.

string document = 1;

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DocumentDelete.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DocumentDelete.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReadTime()

public DocumentDelete.Builder clearReadTime()

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
DocumentDelete.Builder

clearRemovedTargetIds()

public DocumentDelete.Builder clearRemovedTargetIds()

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

repeated int32 removed_target_ids = 6;

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

clone()

public DocumentDelete.Builder clone()
Returns
Type Description
DocumentDelete.Builder
Overrides

getDefaultInstanceForType()

public DocumentDelete getDefaultInstanceForType()
Returns
Type Description
DocumentDelete

getDescriptorForType()

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

getDocument()

public String getDocument()

The resource name of the Document that was deleted.

string document = 1;

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

The resource name of the Document that was deleted.

string document = 1;

Returns
Type Description
ByteString

The bytes for document.

getReadTime()

public Timestamp getReadTime()

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Returns
Type Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.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 entity.

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

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

repeated int32 removed_target_ids = 6;

Returns
Type Description
List<Integer>

A list containing the removedTargetIds.

hasReadTime()

public boolean hasReadTime()

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

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

public DocumentDelete.Builder mergeFrom(DocumentDelete other)
Parameter
Name Description
other DocumentDelete
Returns
Type Description
DocumentDelete.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentDelete.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentDelete.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeReadTime(Timestamp value)

public DocumentDelete.Builder mergeReadTime(Timestamp value)

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
DocumentDelete.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentDelete.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentDelete.Builder
Overrides

setDocument(String value)

public DocumentDelete.Builder setDocument(String value)

The resource name of the Document that was deleted.

string document = 1;

Parameter
Name Description
value String

The document to set.

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

setDocumentBytes(ByteString value)

public DocumentDelete.Builder setDocumentBytes(ByteString value)

The resource name of the Document that was deleted.

string document = 1;

Parameter
Name Description
value ByteString

The bytes for document to set.

Returns
Type Description
DocumentDelete.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentDelete.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentDelete.Builder
Overrides

setReadTime(Timestamp value)

public DocumentDelete.Builder setReadTime(Timestamp value)

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
DocumentDelete.Builder

setReadTime(Timestamp.Builder builderForValue)

public DocumentDelete.Builder setReadTime(Timestamp.Builder builderForValue)

The read timestamp at which the delete was observed.

Greater or equal to the commit_time of the delete.

.google.protobuf.Timestamp read_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DocumentDelete.Builder

setRemovedTargetIds(int index, int value)

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

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

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
DocumentDelete.Builder

This builder for chaining.

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

public DocumentDelete.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DocumentDelete.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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