Class TargetChange.Builder (3.25.1)

public static final class TargetChange.Builder extends GeneratedMessageV3.Builder<TargetChange.Builder> implements TargetChangeOrBuilder

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllTargetIds(Iterable<? extends Integer> values)

public TargetChange.Builder addAllTargetIds(Iterable<? extends Integer> values)

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
values Iterable<? extends java.lang.Integer>

The targetIds to add.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetChange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetChange.Builder
Overrides

addTargetIds(int value)

public TargetChange.Builder addTargetIds(int value)

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
value int

The targetIds to add.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

build()

public TargetChange build()
Returns
Type Description
TargetChange

buildPartial()

public TargetChange buildPartial()
Returns
Type Description
TargetChange

clear()

public TargetChange.Builder clear()
Returns
Type Description
TargetChange.Builder
Overrides

clearCause()

public TargetChange.Builder clearCause()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type Description
TargetChange.Builder

clearField(Descriptors.FieldDescriptor field)

public TargetChange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TargetChange.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetChange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TargetChange.Builder
Overrides

clearReadTime()

public TargetChange.Builder clearReadTime()

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
TargetChange.Builder

clearResumeToken()

public TargetChange.Builder clearResumeToken()

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
TargetChange.Builder

This builder for chaining.

clearTargetChangeType()

public TargetChange.Builder clearTargetChangeType()

The type of change that occurred.

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

Returns
Type Description
TargetChange.Builder

This builder for chaining.

clearTargetIds()

public TargetChange.Builder clearTargetIds()

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
TargetChange.Builder

This builder for chaining.

clone()

public TargetChange.Builder clone()
Returns
Type Description
TargetChange.Builder
Overrides

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.

getCauseBuilder()

public Status.Builder getCauseBuilder()

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Returns
Type Description
com.google.rpc.Status.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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
Type Description
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

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
Builder

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

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCause(Status value)

public TargetChange.Builder mergeCause(Status value)

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
TargetChange.Builder

mergeFrom(TargetChange other)

public TargetChange.Builder mergeFrom(TargetChange other)
Parameter
Name Description
other TargetChange
Returns
Type Description
TargetChange.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetChange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetChange.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TargetChange.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TargetChange.Builder
Overrides

mergeReadTime(Timestamp value)

public TargetChange.Builder mergeReadTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
TargetChange.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetChange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetChange.Builder
Overrides

setCause(Status value)

public TargetChange.Builder setCause(Status value)

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
TargetChange.Builder

setCause(Status.Builder builderForValue)

public TargetChange.Builder setCause(Status.Builder builderForValue)

The error that resulted in this change, if applicable.

.google.rpc.Status cause = 3;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
TargetChange.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TargetChange.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetChange.Builder
Overrides

setReadTime(Timestamp value)

public TargetChange.Builder setReadTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
TargetChange.Builder

setReadTime(Timestamp.Builder builderForValue)

public TargetChange.Builder setReadTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TargetChange.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TargetChange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TargetChange.Builder
Overrides

setResumeToken(ByteString value)

public TargetChange.Builder setResumeToken(ByteString value)

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;

Parameter
Name Description
value ByteString

The resumeToken to set.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

setTargetChangeType(TargetChange.TargetChangeType value)

public TargetChange.Builder setTargetChangeType(TargetChange.TargetChangeType value)

The type of change that occurred.

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

Parameter
Name Description
value TargetChange.TargetChangeType

The targetChangeType to set.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

setTargetChangeTypeValue(int value)

public TargetChange.Builder setTargetChangeTypeValue(int value)

The type of change that occurred.

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

Parameter
Name Description
value int

The enum numeric value on the wire for targetChangeType to set.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

setTargetIds(int index, int value)

public TargetChange.Builder setTargetIds(int index, int value)

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
Name Description
index int

The index to set the value at.

value int

The targetIds to set.

Returns
Type Description
TargetChange.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetChange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetChange.Builder
Overrides