Class DocumentChange (3.22.0)

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
Type Description
int

REMOVED_TARGET_IDS_FIELD_NUMBER

public static final int REMOVED_TARGET_IDS_FIELD_NUMBER
Field Value
Type Description
int

TARGET_IDS_FIELD_NUMBER

public static final int TARGET_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentChange getDefaultInstance()
Returns
Type Description
DocumentChange

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentChange.Builder newBuilder()
Returns
Type Description
DocumentChange.Builder

newBuilder(DocumentChange prototype)

public static DocumentChange.Builder newBuilder(DocumentChange prototype)
Parameter
Name Description
prototype DocumentChange
Returns
Type Description
DocumentChange.Builder

parseDelimitedFrom(InputStream input)

public static DocumentChange parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentChange parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentChange parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentChange parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentChange parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentChange parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentChange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentChange
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentChange> parser()
Returns
Type Description
Parser<DocumentChange>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DocumentChange getDefaultInstanceForType()
Returns
Type Description
DocumentChange

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
Type Description
Document

The document.

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
Type Description
DocumentOrBuilder

getParserForType()

public Parser<DocumentChange> getParserForType()
Returns
Type Description
Parser<DocumentChange>
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
Type Description
int
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.

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentChange.Builder newBuilderForType()
Returns
Type Description
DocumentChange.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentChange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentChange.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentChange.Builder toBuilder()
Returns
Type Description
DocumentChange.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException