public final class DocumentChange extends GeneratedMessageV3 implements DocumentChangeOrBuilder
A Document has changed.
May be the result of multiple writes, including deletes, that
ultimately resulted in a new value for the Document.
Multiple DocumentChange messages may be returned for the same logical
change, if multiple targets are affected.
Protobuf type google.firestore.v1.DocumentChange
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
REMOVED_TARGET_IDS_FIELD_NUMBER
public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
Field Value
TARGET_IDS_FIELD_NUMBER
public static final int TARGET_IDS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentChange getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DocumentChange.Builder newBuilder()
Returns
newBuilder(DocumentChange prototype)
public static DocumentChange.Builder newBuilder(DocumentChange prototype)
Parameter
Returns
public static DocumentChange parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentChange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentChange parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentChange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentChange parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentChange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentChange parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DocumentChange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentChange parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentChange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentChange parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentChange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentChange> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentChange getDefaultInstanceForType()
Returns
getDocument()
public Document getDocument()
The new state of the Document.
If mask
is set, contains only fields that were updated or added.
.google.firestore.v1.Document document = 1;
Returns
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()
The new state of the Document.
If mask
is set, contains only fields that were updated or added.
.google.firestore.v1.Document document = 1;
Returns
getParserForType()
public Parser<DocumentChange> getParserForType()
Returns
Overrides
getRemovedTargetIds(int index)
public int getRemovedTargetIds(int index)
A set of target IDs for targets that no longer match this document.
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 no longer match this document.
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 no longer match this document.
repeated int32 removed_target_ids = 6;
Returns
Type | Description |
List<Integer> | A list containing the removedTargetIds.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetIds(int index)
public int getTargetIds(int index)
A set of target IDs of targets that match this document.
repeated int32 target_ids = 5;
Parameter
Name | Description |
index | int
The index of the element to return.
|
Returns
Type | Description |
int | The targetIds at the given index.
|
getTargetIdsCount()
public int getTargetIdsCount()
A set of target IDs of targets that match this document.
repeated int32 target_ids = 5;
Returns
Type | Description |
int | The count of targetIds.
|
getTargetIdsList()
public List<Integer> getTargetIdsList()
A set of target IDs of targets that match this document.
repeated int32 target_ids = 5;
Returns
Type | Description |
List<Integer> | A list containing the targetIds.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDocument()
public boolean hasDocument()
The new state of the Document.
If mask
is set, contains only fields that were updated or added.
.google.firestore.v1.Document document = 1;
Returns
Type | Description |
boolean | Whether the document field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DocumentChange.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentChange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DocumentChange.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions