Send feedback
Class Target.DocumentsTarget (3.25.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.25.1 keyboard_arrow_down
public static final class Target . DocumentsTarget extends GeneratedMessageV3 implements Target . DocumentsTargetOrBuilder
A target specified by a set of documents names.
Protobuf type google.firestore.v1.Target.DocumentsTarget
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENTS_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static Target . DocumentsTarget getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Target . DocumentsTarget . Builder newBuilder ()
newBuilder(Target.DocumentsTarget prototype)
public static Target . DocumentsTarget . Builder newBuilder ( Target . DocumentsTarget prototype )
public static Target . DocumentsTarget parseDelimitedFrom ( InputStream input )
public static Target . DocumentsTarget parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Target . DocumentsTarget parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Target . DocumentsTarget parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Target . DocumentsTarget parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Target . DocumentsTarget parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Target . DocumentsTarget parseFrom ( CodedInputStream input )
public static Target . DocumentsTarget parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Target . DocumentsTarget parseFrom ( InputStream input )
public static Target . DocumentsTarget parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Target . DocumentsTarget parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Target . DocumentsTarget parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Target . DocumentsTarget > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public Target . DocumentsTarget getDefaultInstanceForType ()
getDocuments(int index)
public String getDocuments ( int index )
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
The request will fail if any of the document is not a child resource of
the given database
. Duplicate names will be elided.
repeated string documents = 2;
Parameter
Name
Description
index
int
The index of the element to return.
Returns
Type
Description
String
The documents at the given index.
getDocumentsBytes(int index)
public ByteString getDocumentsBytes ( int index )
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
The request will fail if any of the document is not a child resource of
the given database
. Duplicate names will be elided.
repeated string documents = 2;
Parameter
Name
Description
index
int
The index of the value to return.
Returns
Type
Description
ByteString
The bytes of the documents at the given index.
getDocumentsCount()
public int getDocumentsCount ()
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
The request will fail if any of the document is not a child resource of
the given database
. Duplicate names will be elided.
repeated string documents = 2;
Returns
Type
Description
int
The count of documents.
getDocumentsList()
public ProtocolStringList getDocumentsList ()
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}
.
The request will fail if any of the document is not a child resource of
the given database
. Duplicate names will be elided.
repeated string documents = 2;
getParserForType()
public Parser<Target . DocumentsTarget > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Target . DocumentsTarget . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Target . DocumentsTarget . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public Target . DocumentsTarget . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-01-28 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-01-28 UTC."],[],[]]