public interface TargetOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDocuments()
public abstract Target.DocumentsTarget getDocuments()A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
| Returns | |
|---|---|
| Type | Description |
Target.DocumentsTarget | The documents. |
getDocumentsOrBuilder()
public abstract Target.DocumentsTargetOrBuilder getDocumentsOrBuilder()A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
| Returns | |
|---|---|
| Type | Description |
Target.DocumentsTargetOrBuilder | |
getExpectedCount()
public abstract 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 | |
|---|---|
| Type | Description |
Int32Value | The expectedCount. |
getExpectedCountOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Int32ValueOrBuilder | |
getOnce()
public abstract boolean getOnce()If the target should be removed once it is current and consistent.
bool once = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | The once. |
getQuery()
public abstract Target.QueryTarget getQuery()A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
| Returns | |
|---|---|
| Type | Description |
Target.QueryTarget | The query. |
getQueryOrBuilder()
public abstract Target.QueryTargetOrBuilder getQueryOrBuilder()A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
| Returns | |
|---|---|
| Type | Description |
Target.QueryTargetOrBuilder | |
getReadTime()
public abstract 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 | |
|---|---|
| Type | Description |
Timestamp | The readTime. |
getReadTimeOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getResumeToken()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString | The resumeToken. |
getResumeTypeCase()
public abstract Target.ResumeTypeCase getResumeTypeCase()| Returns | |
|---|---|
| Type | Description |
Target.ResumeTypeCase | |
getTargetId()
public abstract 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 | |
|---|---|
| Type | Description |
int | The targetId. |
getTargetTypeCase()
public abstract Target.TargetTypeCase getTargetTypeCase()| Returns | |
|---|---|
| Type | Description |
Target.TargetTypeCase | |
hasDocuments()
public abstract boolean hasDocuments()A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the documents field is set. |
hasExpectedCount()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the expectedCount field is set. |
hasQuery()
public abstract boolean hasQuery()A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the query field is set. |
hasReadTime()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the readTime field is set. |
hasResumeToken()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the resumeToken field is set. |