Class Target (3.11.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 3.11.0keyboard_arrow_down
public final class Target extends GeneratedMessageV3 implements TargetOrBuilder
A specification of a set of documents to listen to.
Protobuf type google.firestore.v1.Target
Static Fields
DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int
EXPECTED_COUNT_FIELD_NUMBER
public static final int EXPECTED_COUNT_FIELD_NUMBER
Field Value
Type Description
int
ONCE_FIELD_NUMBER
public static final int ONCE_FIELD_NUMBER
Field Value
Type Description
int
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Target getDefaultInstance ()
Returns
Type Description
Target
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Target . Builder newBuilder ()
newBuilder(Target prototype)
public static Target . Builder newBuilder ( Target prototype )
Parameter
Name Description
prototypeTarget
public static Target parseDelimitedFrom ( InputStream input )
Returns
Type Description
Target
public static Target parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
parseFrom(byte[] data)
public static Target parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Target
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
parseFrom(ByteString data)
public static Target parseFrom ( ByteString data )
Returns
Type Description
Target
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
public static Target parseFrom ( CodedInputStream input )
Returns
Type Description
Target
public static Target parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
public static Target parseFrom ( InputStream input )
Returns
Type Description
Target
public static Target parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
parseFrom(ByteBuffer data)
public static Target parseFrom ( ByteBuffer data )
Returns
Type Description
Target
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Target
parser()
public static Parser<Target> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Target getDefaultInstanceForType ()
Returns
Type Description
Target
getDocuments()
public Target . DocumentsTarget getDocuments ()
A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
getDocumentsOrBuilder()
public Target . DocumentsTargetOrBuilder getDocumentsOrBuilder ()
A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
getExpectedCount()
public 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 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;
getOnce()
If the target should be removed once it is current and consistent.
bool once = 6;
Returns
Type Description
boolean The once.
getParserForType()
public Parser<Target> getParserForType ()
Overrides
getQuery()
public Target . QueryTarget getQuery ()
A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
getQueryOrBuilder()
public Target . QueryTargetOrBuilder getQueryOrBuilder ()
A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
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
Type Description
Timestamp The readTime.
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;
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
Type Description
ByteString The resumeToken.
getResumeTypeCase()
public Target . ResumeTypeCase getResumeTypeCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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 Target . TargetTypeCase getTargetTypeCase ()
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasDocuments()
public 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 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 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 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 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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Target . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Target . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Target . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-18 UTC."],[],[]]
