Class Target.DocumentsTarget (3.21.0)

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

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()
Returns
Type Description
Target.DocumentsTarget

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Target.DocumentsTarget.Builder newBuilder()
Returns
Type Description
Target.DocumentsTarget.Builder

newBuilder(Target.DocumentsTarget prototype)

public static Target.DocumentsTarget.Builder newBuilder(Target.DocumentsTarget prototype)
Parameter
Name Description
prototype Target.DocumentsTarget
Returns
Type Description
Target.DocumentsTarget.Builder

parseDelimitedFrom(InputStream input)

public static Target.DocumentsTarget parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Target.DocumentsTarget parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Target.DocumentsTarget parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Target.DocumentsTarget parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Target.DocumentsTarget parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Target.DocumentsTarget parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Target.DocumentsTarget
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Target.DocumentsTarget> parser()
Returns
Type Description
Parser<DocumentsTarget>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Target.DocumentsTarget getDefaultInstanceForType()
Returns
Type Description
Target.DocumentsTarget

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;

Returns
Type Description
ProtocolStringList

A list containing the documents.

getParserForType()

public Parser<Target.DocumentsTarget> getParserForType()
Returns
Type Description
Parser<DocumentsTarget>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Target.DocumentsTarget.Builder newBuilderForType()
Returns
Type Description
Target.DocumentsTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Target.DocumentsTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Target.DocumentsTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Target.DocumentsTarget.Builder toBuilder()
Returns
Type Description
Target.DocumentsTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException