Class ImportDocumentsRequest.Builder (3.21.3)

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

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.

addAllNamespaceIds(Iterable<String> values)

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

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name Description
values Iterable<String>

The namespaceIds 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.

addNamespaceIds(String value)

public ImportDocumentsRequest.Builder addNamespaceIds(String value)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name Description
value String

The namespaceIds to add.

Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

addNamespaceIdsBytes(ByteString value)

public ImportDocumentsRequest.Builder addNamespaceIdsBytes(ByteString value)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name Description
value ByteString

The bytes of the namespaceIds 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

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

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

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.

clearNamespaceIds()

public ImportDocumentsRequest.Builder clearNamespaceIds()

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

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

clone()

public ImportDocumentsRequest.Builder clone()
Returns
Type Description
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
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

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
Type Description
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
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.

getNamespaceIds(int index)

public String getNamespaceIds(int index)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The namespaceIds at the given index.

getNamespaceIdsBytes(int index)

public ByteString getNamespaceIdsBytes(int index)

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the namespaceIds at the given index.

getNamespaceIdsCount()

public int getNamespaceIdsCount()

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Returns
Type Description
int

The count of namespaceIds.

getNamespaceIdsList()

public ProtocolStringList getNamespaceIdsList()

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Returns
Type Description
ProtocolStringList

A list containing the namespaceIds.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportDocumentsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
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

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
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)

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
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.

setNamespaceIds(int index, String value)

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

An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.

An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.

repeated string namespace_ids = 4;

Parameters
Name Description
index int

The index to set the value at.

value String

The namespaceIds 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

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides