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.
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() A client provided target ID.
Target.TargetTypeCase	getTargetTypeCase()
boolean	hasDocuments() A target specified by a set of document names.
boolean	hasQuery() A target specified by a query.
boolean	hasReadTime() Start listening after a specific `read_time`.

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;

getQuery

Target.QueryTarget getQuery()

 A target specified by a query.
 

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

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;

getDocuments

Target.DocumentsTarget getDocuments()

 A target specified by a set of document names.
 

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

getDocumentsOrBuilder

Target.DocumentsTargetOrBuilder getDocumentsOrBuilder()

 A target specified by a set of document names.
 

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

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;

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;

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;

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

 A client provided target ID.
 If not set, the server will assign an ID for the target.
 Used for resuming a target without changing IDs. The IDs can either be
 client-assigned or be server-assigned in a previous stream. All targets
 with client provided IDs must be added before adding a target that needs
 a server-assigned id.
 

int32 target_id = 5;

getOnce

boolean getOnce()

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

bool once = 6;

getTargetTypeCase

Target.TargetTypeCase getTargetTypeCase()

getResumeTypeCase

Target.ResumeTypeCase getResumeTypeCase()