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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
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;
| Name | Description |
value | String
The documents to add.
|
Returns
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;
| Name | Description |
value | ByteString
The bytes of the documents to add.
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Target.DocumentsTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public Target.DocumentsTarget build()
Returns
buildPartial()
public Target.DocumentsTarget buildPartial()
Returns
clear()
public Target.DocumentsTarget.Builder clear()
Returns
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;
clearField(Descriptors.FieldDescriptor field)
public Target.DocumentsTarget.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Target.DocumentsTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public Target.DocumentsTarget.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Target.DocumentsTarget getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| 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;
| 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;
| 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;
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Target.DocumentsTarget other)
public Target.DocumentsTarget.Builder mergeFrom(Target.DocumentsTarget other)
Parameter
Returns
public Target.DocumentsTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Target.DocumentsTarget.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Target.DocumentsTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
| Name | Description |
index | int
The index to set the value at.
|
value | String
The documents to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Target.DocumentsTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Target.DocumentsTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Target.DocumentsTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
