Class Target.DocumentsTarget.Builder (3.5.0)

public static final class Target.DocumentsTarget.Builder extends GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder> implements Target.DocumentsTargetOrBuilder

A target specified by a set of documents names.

Protobuf type google.firestore.v1.Target.DocumentsTarget

Static Methods

getDescriptor()

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

Methods

addAllDocuments(Iterable<String> values)

public Target.DocumentsTarget.Builder addAllDocuments(Iterable<String> values)

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
valuesIterable<String>

The documents to add.

Returns
TypeDescription
Target.DocumentsTarget.Builder

This builder for chaining.

addDocuments(String value)

public Target.DocumentsTarget.Builder addDocuments(String value)

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
valueString

The documents to add.

Returns
TypeDescription
Target.DocumentsTarget.Builder

This builder for chaining.

addDocumentsBytes(ByteString value)

public Target.DocumentsTarget.Builder addDocumentsBytes(ByteString value)

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
valueByteString

The bytes of the documents to add.

Returns
TypeDescription
Target.DocumentsTarget.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Target.DocumentsTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

build()

public Target.DocumentsTarget build()
Returns
TypeDescription
Target.DocumentsTarget

buildPartial()

public Target.DocumentsTarget buildPartial()
Returns
TypeDescription
Target.DocumentsTarget

clear()

public Target.DocumentsTarget.Builder clear()
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

clearDocuments()

public Target.DocumentsTarget.Builder clearDocuments()

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
Target.DocumentsTarget.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Target.DocumentsTarget.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Target.DocumentsTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

clone()

public Target.DocumentsTarget.Builder clone()
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

getDefaultInstanceForType()

public Target.DocumentsTarget getDefaultInstanceForType()
Returns
TypeDescription
Target.DocumentsTarget

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Target.DocumentsTarget other)

public Target.DocumentsTarget.Builder mergeFrom(Target.DocumentsTarget other)
Parameter
NameDescription
otherTarget.DocumentsTarget
Returns
TypeDescription
Target.DocumentsTarget.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Target.DocumentsTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Target.DocumentsTarget.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Target.DocumentsTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

setDocuments(int index, String value)

public Target.DocumentsTarget.Builder setDocuments(int index, String value)

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;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The documents to set.

Returns
TypeDescription
Target.DocumentsTarget.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Target.DocumentsTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Target.DocumentsTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Target.DocumentsTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Target.DocumentsTarget.Builder
Overrides