Class DocumentDelete (3.17.0)

public final class DocumentDelete extends GeneratedMessageV3 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 Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

REMOVED_TARGET_IDS_FIELD_NUMBER

public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentDelete getDefaultInstance()
Returns
TypeDescription
DocumentDelete

getDescriptor()

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

newBuilder()

public static DocumentDelete.Builder newBuilder()
Returns
TypeDescription
DocumentDelete.Builder

newBuilder(DocumentDelete prototype)

public static DocumentDelete.Builder newBuilder(DocumentDelete prototype)
Parameter
NameDescription
prototypeDocumentDelete
Returns
TypeDescription
DocumentDelete.Builder

parseDelimitedFrom(InputStream input)

public static DocumentDelete parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentDelete parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentDelete parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentDelete parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentDelete parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentDelete parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentDelete parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentDelete
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentDelete> parser()
Returns
TypeDescription
Parser<DocumentDelete>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DocumentDelete getDefaultInstanceForType()
Returns
TypeDescription
DocumentDelete

getDocument()

public String getDocument()

The resource name of the Document that was deleted.

string document = 1;

Returns
TypeDescription
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

The resource name of the Document that was deleted.

string document = 1;

Returns
TypeDescription
ByteString

The bytes for document.

getParserForType()

public Parser<DocumentDelete> getParserForType()
Returns
TypeDescription
Parser<DocumentDelete>
Overrides

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
TypeDescription
Timestamp

The readTime.

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

repeated int32 removed_target_ids = 6;

Returns
TypeDescription
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
TypeDescription
List<Integer>

A list containing the removedTargetIds.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentDelete.Builder newBuilderForType()
Returns
TypeDescription
DocumentDelete.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentDelete.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentDelete.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentDelete.Builder toBuilder()
Returns
TypeDescription
DocumentDelete.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException