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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentDeleteImplements
DocumentDeleteOrBuilderStatic Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
REMOVED_TARGET_IDS_FIELD_NUMBER
public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static DocumentDelete getDefaultInstance()
Returns | |
---|---|
Type | Description |
DocumentDelete |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static DocumentDelete.Builder newBuilder()
Returns | |
---|---|
Type | Description |
DocumentDelete.Builder |
newBuilder(DocumentDelete prototype)
public static DocumentDelete.Builder newBuilder(DocumentDelete prototype)
Parameter | |
---|---|
Name | Description |
prototype | DocumentDelete |
Returns | |
---|---|
Type | Description |
DocumentDelete.Builder |
parseDelimitedFrom(InputStream input)
public static DocumentDelete parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static DocumentDelete parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static DocumentDelete parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static DocumentDelete parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static DocumentDelete parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static DocumentDelete parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
DocumentDelete |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<DocumentDelete> parser()
Returns | |
---|---|
Type | Description |
Parser<DocumentDelete> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public DocumentDelete getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
DocumentDelete |
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. |
getParserForType()
public Parser<DocumentDelete> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<DocumentDelete> |
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. |
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. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public DocumentDelete.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
DocumentDelete.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentDelete.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
DocumentDelete.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public DocumentDelete.Builder toBuilder()
Returns | |
---|---|
Type | Description |
DocumentDelete.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |