Interface ImportDocumentsRequestOrBuilder (3.30.0) 

public interface ImportDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollectionIds(int index)

public abstract String getCollectionIds(int index)

Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.

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 abstract ByteString getCollectionIdsBytes(int index)

Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.

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 abstract int getCollectionIdsCount()

Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Returns
Type Description
int

The count of collectionIds.

getCollectionIdsList()

public abstract List<String> getCollectionIdsList()

Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique.

repeated string collection_ids = 2;

Returns
Type Description
List<String>

A list containing the collectionIds.

getInputUriPrefix()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the namespaceIds.