Class Target.Builder

public static final class Target.Builder extends GeneratedMessageV3.Builder<Target.Builder> implements TargetOrBuilder

A specification of a set of documents to listen to.

Protobuf type google.firestore.v1.Target

Implements

TargetOrBuilder

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Target.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Target.Builder
Overrides

build()

public Target build()
Returns
TypeDescription
Target

buildPartial()

public Target buildPartial()
Returns
TypeDescription
Target

clear()

public Target.Builder clear()
Returns
TypeDescription
Target.Builder
Overrides

clearDocuments()

public Target.Builder clearDocuments()

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Returns
TypeDescription
Target.Builder

clearField(Descriptors.FieldDescriptor field)

public Target.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Target.Builder
Overrides

clearOnce()

public Target.Builder clearOnce()

If the target should be removed once it is current and consistent.

bool once = 6;

Returns
TypeDescription
Target.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Target.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Target.Builder
Overrides

clearQuery()

public Target.Builder clearQuery()

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Returns
TypeDescription
Target.Builder

clearReadTime()

public Target.Builder clearReadTime()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Returns
TypeDescription
Target.Builder

clearResumeToken()

public Target.Builder clearResumeToken()

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.

bytes resume_token = 4;

Returns
TypeDescription
Target.Builder

This builder for chaining.

clearResumeType()

public Target.Builder clearResumeType()
Returns
TypeDescription
Target.Builder

clearTargetId()

public Target.Builder clearTargetId()

The target ID that identifies the target on the stream. Must be a positive number and non-zero.

int32 target_id = 5;

Returns
TypeDescription
Target.Builder

This builder for chaining.

clearTargetType()

public Target.Builder clearTargetType()
Returns
TypeDescription
Target.Builder

clone()

public Target.Builder clone()
Returns
TypeDescription
Target.Builder
Overrides

getDefaultInstanceForType()

public Target getDefaultInstanceForType()
Returns
TypeDescription
Target

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocuments()

public Target.DocumentsTarget getDocuments()

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Returns
TypeDescription
Target.DocumentsTarget

The documents.

getDocumentsBuilder()

public Target.DocumentsTarget.Builder getDocumentsBuilder()

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Returns
TypeDescription
Target.DocumentsTarget.Builder

getDocumentsOrBuilder()

public Target.DocumentsTargetOrBuilder getDocumentsOrBuilder()

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Returns
TypeDescription
Target.DocumentsTargetOrBuilder

getOnce()

public boolean getOnce()

If the target should be removed once it is current and consistent.

bool once = 6;

Returns
TypeDescription
boolean

The once.

getQuery()

public Target.QueryTarget getQuery()

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Returns
TypeDescription
Target.QueryTarget

The query.

getQueryBuilder()

public Target.QueryTarget.Builder getQueryBuilder()

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Returns
TypeDescription
Target.QueryTarget.Builder

getQueryOrBuilder()

public Target.QueryTargetOrBuilder getQueryOrBuilder()

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Returns
TypeDescription
Target.QueryTargetOrBuilder

getReadTime()

public Timestamp getReadTime()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Returns
TypeDescription
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Returns
TypeDescription
TimestampOrBuilder

getResumeToken()

public ByteString getResumeToken()

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.

bytes resume_token = 4;

Returns
TypeDescription
ByteString

The resumeToken.

getResumeTypeCase()

public Target.ResumeTypeCase getResumeTypeCase()
Returns
TypeDescription
Target.ResumeTypeCase

getTargetId()

public int getTargetId()

The target ID that identifies the target on the stream. Must be a positive number and non-zero.

int32 target_id = 5;

Returns
TypeDescription
int

The targetId.

getTargetTypeCase()

public Target.TargetTypeCase getTargetTypeCase()
Returns
TypeDescription
Target.TargetTypeCase

hasDocuments()

public boolean hasDocuments()

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Returns
TypeDescription
boolean

Whether the documents field is set.

hasQuery()

public boolean hasQuery()

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Returns
TypeDescription
boolean

Whether the query field is set.

hasReadTime()

public boolean hasReadTime()

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hasResumeToken()

public boolean hasResumeToken()

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.

bytes resume_token = 4;

Returns
TypeDescription
boolean

Whether the resumeToken field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDocuments(Target.DocumentsTarget value)

public Target.Builder mergeDocuments(Target.DocumentsTarget value)

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Parameter
NameDescription
valueTarget.DocumentsTarget
Returns
TypeDescription
Target.Builder

mergeFrom(Target other)

public Target.Builder mergeFrom(Target other)
Parameter
NameDescription
otherTarget
Returns
TypeDescription
Target.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Target.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Target.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Target.Builder
Overrides

mergeQuery(Target.QueryTarget value)

public Target.Builder mergeQuery(Target.QueryTarget value)

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Parameter
NameDescription
valueTarget.QueryTarget
Returns
TypeDescription
Target.Builder

mergeReadTime(Timestamp value)

public Target.Builder mergeReadTime(Timestamp value)

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Target.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Target.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Target.Builder
Overrides

setDocuments(Target.DocumentsTarget value)

public Target.Builder setDocuments(Target.DocumentsTarget value)

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Parameter
NameDescription
valueTarget.DocumentsTarget
Returns
TypeDescription
Target.Builder

setDocuments(Target.DocumentsTarget.Builder builderForValue)

public Target.Builder setDocuments(Target.DocumentsTarget.Builder builderForValue)

A target specified by a set of document names.

.google.firestore.v1.Target.DocumentsTarget documents = 3;

Parameter
NameDescription
builderForValueTarget.DocumentsTarget.Builder
Returns
TypeDescription
Target.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Target.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Target.Builder
Overrides

setOnce(boolean value)

public Target.Builder setOnce(boolean value)

If the target should be removed once it is current and consistent.

bool once = 6;

Parameter
NameDescription
valueboolean

The once to set.

Returns
TypeDescription
Target.Builder

This builder for chaining.

setQuery(Target.QueryTarget value)

public Target.Builder setQuery(Target.QueryTarget value)

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Parameter
NameDescription
valueTarget.QueryTarget
Returns
TypeDescription
Target.Builder

setQuery(Target.QueryTarget.Builder builderForValue)

public Target.Builder setQuery(Target.QueryTarget.Builder builderForValue)

A target specified by a query.

.google.firestore.v1.Target.QueryTarget query = 2;

Parameter
NameDescription
builderForValueTarget.QueryTarget.Builder
Returns
TypeDescription
Target.Builder

setReadTime(Timestamp value)

public Target.Builder setReadTime(Timestamp value)

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Target.Builder

setReadTime(Timestamp.Builder builderForValue)

public Target.Builder setReadTime(Timestamp.Builder builderForValue)

Start listening after a specific read_time. The client must know the state of matching documents at this time.

.google.protobuf.Timestamp read_time = 11;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Target.Builder

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

public Target.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Target.Builder
Overrides

setResumeToken(ByteString value)

public Target.Builder setResumeToken(ByteString value)

A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.

bytes resume_token = 4;

Parameter
NameDescription
valueByteString

The resumeToken to set.

Returns
TypeDescription
Target.Builder

This builder for chaining.

setTargetId(int value)

public Target.Builder setTargetId(int value)

The target ID that identifies the target on the stream. Must be a positive number and non-zero.

int32 target_id = 5;

Parameter
NameDescription
valueint

The targetId to set.

Returns
TypeDescription
Target.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Target.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Target.Builder
Overrides