public interface TargetChangeOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 |
intThe 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. |