Class TargetChange (3.25.1)

public final class TargetChange extends GeneratedMessageV3 implements TargetChangeOrBuilder

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TargetChange

Implements

TargetChangeOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CAUSE_FIELD_NUMBER

public static final int CAUSE_FIELD_NUMBER

Field Value
Type	Description
`int`

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_CHANGE_TYPE_FIELD_NUMBER

public static final int TARGET_CHANGE_TYPE_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 TargetChange getDefaultInstance()

Returns
Type	Description
`TargetChange`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static TargetChange.Builder newBuilder()

Returns
Type	Description
`TargetChange.Builder`

newBuilder(TargetChange prototype)

public static TargetChange.Builder newBuilder(TargetChange prototype)

Parameter
Name	Description
`prototype`	`TargetChange`

Returns
Type	Description
`TargetChange.Builder`

parseDelimitedFrom(InputStream input)

public static TargetChange parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static TargetChange parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static TargetChange parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static TargetChange parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static TargetChange parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static TargetChange parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TargetChange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TargetChange`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<TargetChange> parser()

Returns
Type	Description
`Parser<TargetChange>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCause()

public Status getCause()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type	Description
`com.google.rpc.Status`	The cause.

getCauseOrBuilder()

public StatusOrBuilder getCauseOrBuilder()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type	Description
`com.google.rpc.StatusOrBuilder`

getDefaultInstanceForType()

public TargetChange getDefaultInstanceForType()

Returns
Type	Description
`TargetChange`

getParserForType()

public Parser<TargetChange> getParserForType()

Returns
Type	Description
`Parser<TargetChange>`

Overrides

GeneratedMessageV3.getParserForType()

getReadTime()

public Timestamp getReadTime()

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

For a given stream, read_time is guaranteed to be monotonically increasing.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`Timestamp`	The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

For a given stream, read_time is guaranteed to be monotonically increasing.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getResumeToken()

public ByteString getResumeToken()

A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty.

Not set on every target change.

bytes resume_token = 4;

Returns
Type	Description
`ByteString`	The resumeToken.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTargetChangeType()

public TargetChange.TargetChangeType getTargetChangeType()

The type of change that occurred.

.google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;

Returns
Type	Description
`TargetChange.TargetChangeType`	The targetChangeType.

getTargetChangeTypeValue()

public int getTargetChangeTypeValue()

The type of change that occurred.

.google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;

Returns
Type	Description
`int`	The enum numeric value on the wire for targetChangeType.

getTargetIds(int index)

public int getTargetIds(int index)

The target IDs of targets that have changed.

If empty, the change applies to all targets.

The order of the target IDs is not defined.

repeated int32 target_ids = 2;

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

The target IDs of targets that have changed.

If empty, the change applies to all targets.

The order of the target IDs is not defined.

repeated int32 target_ids = 2;

Returns
Type	Description
`int`	The count of targetIds.

getTargetIdsList()

public List<Integer> getTargetIdsList()

The target IDs of targets that have changed.

If empty, the change applies to all targets.

The order of the target IDs is not defined.

repeated int32 target_ids = 2;

Returns
Type	Description
`List<Integer>`	A list containing the targetIds.

hasCause()

public boolean hasCause()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type	Description
`boolean`	Whether the cause field is set.

hasReadTime()

public boolean hasReadTime()

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

For a given stream, read_time is guaranteed to be monotonically increasing.

.google.protobuf.Timestamp read_time = 6;

Returns
Type	Description
`boolean`	Whether the readTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TargetChange.Builder newBuilderForType()

Returns
Type	Description
`TargetChange.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TargetChange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`TargetChange.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TargetChange.Builder toBuilder()

Returns
Type	Description
`TargetChange.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`