public final class TargetChange extends GeneratedMessageV3 implements TargetChangeOrBuilder
Targets being watched have changed.
Protobuf type google.firestore.v1.TargetChange
Static Fields
CAUSE_FIELD_NUMBER
public static final int CAUSE_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
TARGET_CHANGE_TYPE_FIELD_NUMBER
public static final int TARGET_CHANGE_TYPE_FIELD_NUMBER
Field Value
TARGET_IDS_FIELD_NUMBER
public static final int TARGET_IDS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TargetChange getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TargetChange.Builder newBuilder()
Returns
newBuilder(TargetChange prototype)
public static TargetChange.Builder newBuilder(TargetChange prototype)
Parameter
Returns
public static TargetChange parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TargetChange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TargetChange parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TargetChange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TargetChange parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TargetChange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TargetChange parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TargetChange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TargetChange parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TargetChange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TargetChange parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TargetChange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TargetChange> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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
getParserForType()
public Parser<TargetChange> getParserForType()
Returns
Overrides
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
getReadTimeOrBuilder()
public 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
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetChangeType()
public TargetChange.TargetChangeType getTargetChangeType()
The type of change that occurred.
.google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;
Returns
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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).
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TargetChange.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TargetChange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TargetChange.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions