com.google.firestore.v1

Class Target.DocumentsTarget.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

com.google.firestore.v1.Target.DocumentsTarget.Builder

All Implemented Interfaces:

Target.DocumentsTargetOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Target.DocumentsTarget

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

 A target specified by a set of documents names.
 

Protobuf type google.firestore.v1.Target.DocumentsTarget

Method Summary

Modifier and Type	Method and Description
Target.DocumentsTarget.Builder	addAllDocuments(Iterable<String> values) The names of the documents to retrieve.
Target.DocumentsTarget.Builder	addDocuments(String value) The names of the documents to retrieve.
Target.DocumentsTarget.Builder	addDocumentsBytes(com.google.protobuf.ByteString value) The names of the documents to retrieve.
Target.DocumentsTarget.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Target.DocumentsTarget	build()
Target.DocumentsTarget	buildPartial()
Target.DocumentsTarget.Builder	clear()
Target.DocumentsTarget.Builder	clearDocuments() The names of the documents to retrieve.
Target.DocumentsTarget.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Target.DocumentsTarget.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Target.DocumentsTarget.Builder	clone()
Target.DocumentsTarget	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getDocuments(int index) The names of the documents to retrieve.
com.google.protobuf.ByteString	getDocumentsBytes(int index) The names of the documents to retrieve.
int	getDocumentsCount() The names of the documents to retrieve.
com.google.protobuf.ProtocolStringList	getDocumentsList() The names of the documents to retrieve.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Target.DocumentsTarget.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Target.DocumentsTarget.Builder	mergeFrom(com.google.protobuf.Message other)
Target.DocumentsTarget.Builder	mergeFrom(Target.DocumentsTarget other)
Target.DocumentsTarget.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Target.DocumentsTarget.Builder	setDocuments(int index, String value) The names of the documents to retrieve.
Target.DocumentsTarget.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Target.DocumentsTarget.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Target.DocumentsTarget.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

clear

public Target.DocumentsTarget.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

getDefaultInstanceForType

public Target.DocumentsTarget getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Target.DocumentsTarget build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Target.DocumentsTarget buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Target.DocumentsTarget.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

setField

public Target.DocumentsTarget.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

clearField

public Target.DocumentsTarget.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

clearOneof

public Target.DocumentsTarget.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

setRepeatedField

public Target.DocumentsTarget.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

addRepeatedField

public Target.DocumentsTarget.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

mergeFrom

public Target.DocumentsTarget.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Target.DocumentsTarget.Builder>

mergeFrom

public Target.DocumentsTarget.Builder mergeFrom(Target.DocumentsTarget other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

mergeFrom

public Target.DocumentsTarget.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Target.DocumentsTarget.Builder>

Throws:

IOException

getDocumentsList

public com.google.protobuf.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;

Specified by:

getDocumentsList in interface Target.DocumentsTargetOrBuilder

Returns:

A list containing the documents.

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;

Specified by:

getDocumentsCount in interface Target.DocumentsTargetOrBuilder

Returns:

The count of documents.

getDocuments

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;

Specified by:

getDocuments in interface Target.DocumentsTargetOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The documents at the given index.

getDocumentsBytes

public com.google.protobuf.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;

Specified by:

getDocumentsBytes in interface Target.DocumentsTargetOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the documents at the given index.

setDocuments

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:

index - The index to set the value at.

value - The documents to set.

Returns:

This builder for chaining.

addDocuments

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;

Parameters:

value - The documents to add.

Returns:

This builder for chaining.

addAllDocuments

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;

Parameters:

values - The documents to add.

Returns:

This builder for chaining.

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:

This builder for chaining.

addDocumentsBytes

public Target.DocumentsTarget.Builder addDocumentsBytes(com.google.protobuf.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;

Parameters:

value - The bytes of the documents to add.

Returns:

This builder for chaining.

setUnknownFields

public final Target.DocumentsTarget.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>

mergeUnknownFields

public final Target.DocumentsTarget.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Target.DocumentsTarget.Builder>