Interface TargetChangeOrBuilder (3.30.0)

Version 3.30.0

• 3.30.2 (latest)
• 3.30.0
• 3.28.0
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public interface TargetChangeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCause()

public abstract 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 abstract StatusOrBuilder getCauseOrBuilder()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type	Description
com.google.rpc.StatusOrBuilder

getReadTime()

public abstract 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 abstract TimestampOrBuilder getReadTimeOrBuilder()

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
TimestampOrBuilder

getResumeToken()

public abstract 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.

getTargetChangeType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasReadTime()

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
boolean	Whether the readTime field is set.