Send feedback
Class Target (3.0.21)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.0.21 keyboard_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
ONCE_FIELD_NUMBER
public static final int ONCE_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
TARGET_ID_FIELD_NUMBER
public static final int TARGET_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Target getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Target . Builder newBuilder ()
Returns
newBuilder(Target prototype)
public static Target . Builder newBuilder ( Target prototype )
Parameter
Name Description prototype Target
Returns
public static Target parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Target parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Target parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Target parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Target parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Target parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Target parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Target parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Target parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Target parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Target> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Target getDefaultInstanceForType ()
Returns
getDocuments()
public Target . DocumentsTarget getDocuments ()
A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
Returns
getDocumentsOrBuilder()
public Target . DocumentsTargetOrBuilder getDocumentsOrBuilder ()
A target specified by a set of document names.
.google.firestore.v1.Target.DocumentsTarget documents = 3;
Returns
getOnce()
If the target should be removed once it is current and consistent.
bool once = 6;
Returns
getParserForType()
public Parser<Target> getParserForType ()
Returns
Overrides
getQuery()
public Target . QueryTarget getQuery ()
A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
Returns
getQueryOrBuilder()
public Target . QueryTargetOrBuilder getQueryOrBuilder ()
A target specified by a query.
.google.firestore.v1.Target.QueryTarget query = 2;
Returns
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
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
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
getResumeTypeCase()
public Target . ResumeTypeCase getResumeTypeCase ()
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
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 ()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
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.
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Target . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Target . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Target . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
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-02-14 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-14 UTC."],[],[]]