public final class DocumentRemove extends GeneratedMessageV3 implements DocumentRemoveOrBuilder
A [Document][google.firestore.v1beta1.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][google.firestore.v1beta1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.Protobuf type
google.firestore.v1beta1.DocumentRemove| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentRemove.Builder
A [Document][google.firestore.v1beta1.Document] has been removed from the view of the targets.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENT_FIELD_NUMBER |
static int |
READ_TIME_FIELD_NUMBER |
static int |
REMOVED_TARGET_IDS_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
static DocumentRemove |
getDefaultInstance() |
DocumentRemove |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getDocument()
The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
|
ByteString |
getDocumentBytes()
The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
|
Parser<DocumentRemove> |
getParserForType() |
Timestamp |
getReadTime()
The read timestamp at which the remove was observed.
|
TimestampOrBuilder |
getReadTimeOrBuilder()
The read timestamp at which the remove was observed.
|
int |
getRemovedTargetIds(int index)
A set of target IDs for targets that previously matched this document.
|
int |
getRemovedTargetIdsCount()
A set of target IDs for targets that previously matched this document.
|
java.util.List<java.lang.Integer> |
getRemovedTargetIdsList()
A set of target IDs for targets that previously matched this document.
|
int |
getSerializedSize() |
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasReadTime()
The read timestamp at which the remove was observed.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DocumentRemove.Builder |
newBuilder() |
static DocumentRemove.Builder |
newBuilder(DocumentRemove prototype) |
DocumentRemove.Builder |
newBuilderForType() |
protected DocumentRemove.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static DocumentRemove |
parseDelimitedFrom(java.io.InputStream input) |
static DocumentRemove |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static DocumentRemove |
parseFrom(byte[] data) |
static DocumentRemove |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static DocumentRemove |
parseFrom(java.nio.ByteBuffer data) |
static DocumentRemove |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static DocumentRemove |
parseFrom(ByteString data) |
static DocumentRemove |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static DocumentRemove |
parseFrom(CodedInputStream input) |
static DocumentRemove |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static DocumentRemove |
parseFrom(java.io.InputStream input) |
static DocumentRemove |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<DocumentRemove> |
parser() |
DocumentRemove.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int DOCUMENT_FIELD_NUMBER
public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public java.lang.String getDocument()
The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
string document = 1;getDocument in interface DocumentRemoveOrBuilderpublic ByteString getDocumentBytes()
The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
string document = 1;getDocumentBytes in interface DocumentRemoveOrBuilderpublic java.util.List<java.lang.Integer> getRemovedTargetIdsList()
A set of target IDs for targets that previously matched this document.
repeated int32 removed_target_ids = 2;getRemovedTargetIdsList in interface DocumentRemoveOrBuilderpublic int getRemovedTargetIdsCount()
A set of target IDs for targets that previously matched this document.
repeated int32 removed_target_ids = 2;getRemovedTargetIdsCount in interface DocumentRemoveOrBuilderpublic int getRemovedTargetIds(int index)
A set of target IDs for targets that previously matched this document.
repeated int32 removed_target_ids = 2;getRemovedTargetIds in interface DocumentRemoveOrBuilderpublic 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;hasReadTime in interface DocumentRemoveOrBuilderpublic 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;getReadTime in interface DocumentRemoveOrBuilderpublic 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;getReadTimeOrBuilder in interface DocumentRemoveOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static DocumentRemove parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static DocumentRemove parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DocumentRemove parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static DocumentRemove parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DocumentRemove parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static DocumentRemove parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static DocumentRemove parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic DocumentRemove.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static DocumentRemove.Builder newBuilder()
public static DocumentRemove.Builder newBuilder(DocumentRemove prototype)
public DocumentRemove.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected DocumentRemove.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static DocumentRemove getDefaultInstance()
public static Parser<DocumentRemove> parser()
public Parser<DocumentRemove> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public DocumentRemove getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder