Class Target.DocumentsTarget (3.8.2)

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
TypeDescription
int

Static Methods

getDefaultInstance()

public static Target.DocumentsTarget getDefaultInstance()
Returns
TypeDescription
Target.DocumentsTarget

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Target.DocumentsTarget.Builder newBuilder()
Returns
TypeDescription
Target.DocumentsTarget.Builder

newBuilder(Target.DocumentsTarget prototype)

public static Target.DocumentsTarget.Builder newBuilder(Target.DocumentsTarget prototype)
Parameter
NameDescription
prototypeTarget.DocumentsTarget
Returns
TypeDescription
Target.DocumentsTarget.Builder

parseDelimitedFrom(InputStream input)

public static Target.DocumentsTarget parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Target.DocumentsTarget parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Target.DocumentsTarget parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Target.DocumentsTarget parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Target.DocumentsTarget parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Target.DocumentsTarget parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Target.DocumentsTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Target.DocumentsTarget getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the documents.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Target.DocumentsTarget.Builder newBuilderForType()
Returns
TypeDescription
Target.DocumentsTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Target.DocumentsTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Target.DocumentsTarget.Builder toBuilder()
Returns
TypeDescription
Target.DocumentsTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException