Class ImportDocumentsRequest.Builder (3.1.0)

public static final class ImportDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ImportDocumentsRequest.Builder> implements ImportDocumentsRequestOrBuilder

The request for FirestoreAdmin.ImportDocuments.

Protobuf type google.firestore.admin.v1.ImportDocumentsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportDocumentsRequest.Builder

Implements

ImportDocumentsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllCollectionIds(Iterable<String> values)

public ImportDocumentsRequest.Builder addAllCollectionIds(Iterable<String> values)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameter

Name	Description
values	`Iterable<String>` The collectionIds to add.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

addCollectionIds(String value)

public ImportDocumentsRequest.Builder addCollectionIds(String value)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameter

Name	Description
value	`String` The collectionIds to add.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

addCollectionIdsBytes(ByteString value)

public ImportDocumentsRequest.Builder addCollectionIdsBytes(ByteString value)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameter

Name	Description
value	`ByteString` The bytes of the collectionIds to add.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ImportDocumentsRequest build()

Returns

Type	Description
ImportDocumentsRequest

buildPartial()

public ImportDocumentsRequest buildPartial()

Returns

Type	Description
ImportDocumentsRequest

clear()

public ImportDocumentsRequest.Builder clear()

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCollectionIds()

public ImportDocumentsRequest.Builder clearCollectionIds()

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ImportDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInputUriPrefix()

public ImportDocumentsRequest.Builder clearInputUriPrefix()

Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string input_uri_prefix = 3;

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

clearName()

public ImportDocumentsRequest.Builder clearName()

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ImportDocumentsRequest.Builder clone()

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCollectionIds(int index)

public String getCollectionIds(int index)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The collectionIds at the given index.

getCollectionIdsBytes(int index)

public ByteString getCollectionIdsBytes(int index)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the collectionIds at the given index.

getCollectionIdsCount()

public int getCollectionIdsCount()

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Returns

Type	Description
int	The count of collectionIds.

getCollectionIdsList()

public ProtocolStringList getCollectionIdsList()

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Returns

Type	Description
ProtocolStringList	A list containing the collectionIds.

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()

Returns

Type	Description
ImportDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getInputUriPrefix()

public String getInputUriPrefix()

string input_uri_prefix = 3;

Returns

Type	Description
String	The inputUriPrefix.

getInputUriPrefixBytes()

public ByteString getInputUriPrefixBytes()

string input_uri_prefix = 3;

Returns

Type	Description
ByteString	The bytes for inputUriPrefix.

getName()

public String getName()

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ImportDocumentsRequest other)

public ImportDocumentsRequest.Builder mergeFrom(ImportDocumentsRequest other)

Parameter

Name	Description
other	`ImportDocumentsRequest`

Returns

Type	Description
ImportDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ImportDocumentsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCollectionIds(int index, String value)

public ImportDocumentsRequest.Builder setCollectionIds(int index, String value)

Which collection ids to import. Unspecified means all collections included in the import.

repeated string collection_ids = 2;

Parameters

Name	Description
index	`int` The index to set the value at.
value	`String` The collectionIds to set.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ImportDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInputUriPrefix(String value)

public ImportDocumentsRequest.Builder setInputUriPrefix(String value)

string input_uri_prefix = 3;

Parameter

Name	Description
value	`String` The inputUriPrefix to set.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

setInputUriPrefixBytes(ByteString value)

public ImportDocumentsRequest.Builder setInputUriPrefixBytes(ByteString value)

string input_uri_prefix = 3;

Parameter

Name	Description
value	`ByteString` The bytes for inputUriPrefix to set.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

setName(String value)

public ImportDocumentsRequest.Builder setName(String value)

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

setNameBytes(ByteString value)

public ImportDocumentsRequest.Builder setNameBytes(ByteString value)

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
ImportDocumentsRequest.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ImportDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)