com.google.firestore.v1

Interface TargetOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Target, Target.Builder

public interface TargetOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Target.DocumentsTarget	getDocuments() A target specified by a set of document names.
Target.DocumentsTargetOrBuilder	getDocumentsOrBuilder() A target specified by a set of document names.
com.google.protobuf.Int32Value	getExpectedCount() The number of documents that last matched the query at the resume token or read time.
com.google.protobuf.Int32ValueOrBuilder	getExpectedCountOrBuilder() The number of documents that last matched the query at the resume token or read time.
boolean	getOnce() If the target should be removed once it is current and consistent.
Target.QueryTarget	getQuery() A target specified by a query.
Target.QueryTargetOrBuilder	getQueryOrBuilder() A target specified by a query.
com.google.protobuf.Timestamp	getReadTime() Start listening after a specific `read_time`.
com.google.protobuf.TimestampOrBuilder	getReadTimeOrBuilder() Start listening after a specific `read_time`.
com.google.protobuf.ByteString	getResumeToken() A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target.
Target.ResumeTypeCase	getResumeTypeCase()
int	getTargetId() The target ID that identifies the target on the stream.
Target.TargetTypeCase	getTargetTypeCase()
boolean	hasDocuments() A target specified by a set of document names.
boolean	hasExpectedCount() The number of documents that last matched the query at the resume token or read time.
boolean	hasQuery() A target specified by a query.
boolean	hasReadTime() Start listening after a specific `read_time`.
boolean	hasResumeToken() A resume token from a prior [TargetChange][google.firestore.v1.TargetChange] for an identical target.

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

hasQuery

boolean hasQuery()

 A target specified by a query.
 

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

Returns:

Whether the query field is set.

getQuery

Target.QueryTarget getQuery()

 A target specified by a query.
 

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

Returns:

The query.

getQueryOrBuilder

Target.QueryTargetOrBuilder getQueryOrBuilder()

 A target specified by a query.
 

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

hasDocuments

boolean hasDocuments()

 A target specified by a set of document names.
 

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

Returns:

Whether the documents field is set.

getDocuments

Target.DocumentsTarget getDocuments()

 A target specified by a set of document names.
 

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

Returns:

The documents.

getDocumentsOrBuilder

Target.DocumentsTargetOrBuilder getDocumentsOrBuilder()

 A target specified by a set of document names.
 

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

hasResumeToken

boolean hasResumeToken()

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

bytes resume_token = 4;

Returns:

Whether the resumeToken field is set.

getResumeToken

com.google.protobuf.ByteString getResumeToken()

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

bytes resume_token = 4;

Returns:

The resumeToken.

hasReadTime

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:

Whether the readTime field is set.

getReadTime

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

The readTime.

getReadTimeOrBuilder

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

getTargetId

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:

The targetId.

getOnce

boolean getOnce()

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

bool once = 6;

Returns:

The once.

hasExpectedCount

boolean hasExpectedCount()

 The number of documents that last matched the query at the resume token or
 read time.
 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
 

.google.protobuf.Int32Value expected_count = 12;

Returns:

Whether the expectedCount field is set.

getExpectedCount

com.google.protobuf.Int32Value getExpectedCount()

 The number of documents that last matched the query at the resume token or
 read time.
 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
 

.google.protobuf.Int32Value expected_count = 12;

Returns:

The expectedCount.

getExpectedCountOrBuilder

com.google.protobuf.Int32ValueOrBuilder getExpectedCountOrBuilder()

 The number of documents that last matched the query at the resume token or
 read time.
 This value is only relevant when a `resume_type` is provided. This value
 being present and greater than zero signals that the client wants
 `ExistenceFilter.unchanged_names` to be included in the response.
 

.google.protobuf.Int32Value expected_count = 12;

getTargetTypeCase

Target.TargetTypeCase getTargetTypeCase()

getResumeTypeCase

Target.ResumeTypeCase getResumeTypeCase()