public final class DocumentRemove extends GeneratedMessageV3 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
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 DocumentRemove getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DocumentRemove.Builder newBuilder()
Returns
newBuilder(DocumentRemove prototype)
public static DocumentRemove.Builder newBuilder(DocumentRemove prototype)
Parameter
Returns
public static DocumentRemove parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentRemove parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentRemove parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentRemove parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentRemove parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentRemove parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentRemove parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DocumentRemove parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentRemove parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentRemove parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentRemove parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentRemove parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentRemove> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentRemove getDefaultInstanceForType()
Returns
getDocument()
public String getDocument()
The resource name of the Document that has gone out of view.
string document = 1;
| Type | Description |
| String | The document.
|
getDocumentBytes()
public ByteString getDocumentBytes()
The resource name of the Document that has gone out of view.
string document = 1;
getParserForType()
public Parser<DocumentRemove> getParserForType()
Returns
Overrides
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;
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;
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;
| 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 document.
repeated int32 removed_target_ids = 2;
| Type | Description |
| 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;
| 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 remove was observed.
Greater or equal to the commit_time of the change/delete/remove.
.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 DocumentRemove.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentRemove.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DocumentRemove.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
