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