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
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
REMOVED_TARGET_IDS_FIELD_NUMBER
public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentDelete getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DocumentDelete.Builder newBuilder()
Returns
newBuilder(DocumentDelete prototype)
public static DocumentDelete.Builder newBuilder(DocumentDelete prototype)
Parameter
Returns
public static DocumentDelete parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentDelete parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentDelete parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentDelete parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentDelete parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DocumentDelete parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentDelete parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentDelete parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentDelete parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentDelete parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentDelete> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentDelete getDefaultInstanceForType()
Returns
getDocument()
public String getDocument()
The resource name of the Document that was deleted.
string document = 1;
| Type | Description |
| String | The document.
|
getDocumentBytes()
public ByteString getDocumentBytes()
The resource name of the Document that was deleted.
string document = 1;
getParserForType()
public Parser<DocumentDelete> getParserForType()
Returns
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;
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;
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;
| 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;
| 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;
| Type | Description |
| List<Integer> | A list containing the removedTargetIds.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| Type | Description |
| boolean | Whether the readTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DocumentDelete.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentDelete.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DocumentDelete.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
