Class TargetChange.Builder (3.4.2)

Version 3.4.2

• 3.20.0 (latest)
• 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 static final class TargetChange.Builder extends GeneratedMessageV3.Builder<TargetChange.Builder> implements TargetChangeOrBuilder

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TargetChange.Builder

Implements

TargetChangeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetChange.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
TargetChange.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TargetChange.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
TargetChange.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)