Class ImportDocumentsRequest.Builder

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

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

The collectionIds to add.

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

The collectionIds to add.

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

The bytes of the collectionIds to add.

Returns
TypeDescription
ImportDocumentsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ImportDocumentsRequest build()
Returns
TypeDescription
ImportDocumentsRequest

buildPartial()

public ImportDocumentsRequest buildPartial()
Returns
TypeDescription
ImportDocumentsRequest

clear()

public ImportDocumentsRequest.Builder clear()
Returns
TypeDescription
ImportDocumentsRequest.Builder
Overrides

clearCollectionIds()

public ImportDocumentsRequest.Builder clearCollectionIds()

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

repeated string collection_ids = 2;

Returns
TypeDescription
ImportDocumentsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

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
TypeDescription
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
TypeDescription
ImportDocumentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public ImportDocumentsRequest.Builder clone()
Returns
TypeDescription
ImportDocumentsRequest.Builder
Overrides

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

The index of the element to return.

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

The index of the value to return.

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

A list containing the collectionIds.

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportDocumentsRequest

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInputUriPrefix()

public String getInputUriPrefix()

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

The inputUriPrefix.

getInputUriPrefixBytes()

public ByteString getInputUriPrefixBytes()

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

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ImportDocumentsRequest other)

public ImportDocumentsRequest.Builder mergeFrom(ImportDocumentsRequest other)
Parameter
NameDescription
otherImportDocumentsRequest
Returns
TypeDescription
ImportDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

The index to set the value at.

valueString

The collectionIds to set.

Returns
TypeDescription
ImportDocumentsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInputUriPrefix(String value)

public ImportDocumentsRequest.Builder setInputUriPrefix(String value)

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;

Parameter
NameDescription
valueString

The inputUriPrefix to set.

Returns
TypeDescription
ImportDocumentsRequest.Builder

This builder for chaining.

setInputUriPrefixBytes(ByteString value)

public ImportDocumentsRequest.Builder setInputUriPrefixBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for inputUriPrefix to set.

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

The name to set.

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

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ImportDocumentsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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