com.google.firestore.v1

Interface TargetChangeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TargetChange, TargetChange.Builder

public interface TargetChangeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.rpc.Status	getCause() The error that resulted in this change, if applicable.
com.google.rpc.StatusOrBuilder	getCauseOrBuilder() The error that resulted in this change, if applicable.
com.google.protobuf.Timestamp	getReadTime() The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).
com.google.protobuf.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.
TargetChange.TargetChangeType	getTargetChangeType() The type of change that occurred.
int	getTargetChangeTypeValue() The type of change that occurred.
int	getTargetIds(int index) The target IDs of targets that have changed.
int	getTargetIdsCount() The target IDs of targets that have changed.
List<Integer>	getTargetIdsList() The target IDs of targets that have changed.
boolean	hasCause() The error that resulted in this change, if applicable.
boolean	hasReadTime() The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTargetChangeTypeValue

int getTargetChangeTypeValue()

 The type of change that occurred.
 

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

Returns:

The enum numeric value on the wire for targetChangeType.

getTargetChangeType

TargetChange.TargetChangeType getTargetChangeType()

 The type of change that occurred.
 

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

Returns:

The targetChangeType.

getTargetIdsList

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:

A list containing the targetIds.

getTargetIdsCount

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:

The count of targetIds.

getTargetIds

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;

Parameters:

index - The index of the element to return.

Returns:

The targetIds at the given index.

hasCause

boolean hasCause()

 The error that resulted in this change, if applicable.
 

.google.rpc.Status cause = 3;

Returns:

Whether the cause field is set.

getCause

com.google.rpc.Status getCause()

 The error that resulted in this change, if applicable.
 

.google.rpc.Status cause = 3;

Returns:

The cause.

getCauseOrBuilder

com.google.rpc.StatusOrBuilder getCauseOrBuilder()

 The error that resulted in this change, if applicable.
 

.google.rpc.Status cause = 3;

getResumeToken

com.google.protobuf.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:

The resumeToken.

hasReadTime

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:

Whether the readTime field is set.

getReadTime

com.google.protobuf.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:

The readTime.

getReadTimeOrBuilder

com.google.protobuf.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;