Optionally specify which kinds/namespaces are to be imported. If provided,
the list must be a subset of the EntityFilter used in creating the export,
otherwise a FAILED_PRECONDITION error will be returned. If no filter is
specified then all entities from the export are imported.
Optionally specify which kinds/namespaces are to be imported. If provided,
the list must be a subset of the EntityFilter used in creating the export,
otherwise a FAILED_PRECONDITION error will be returned. If no filter is
specified then all entities from the export are imported.
Required. The full resource URL of the external storage location.
Currently, only Google Cloud Storage is supported. So input_url should be
of the form:
gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where
BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is
an optional Cloud Storage namespace path (this is not a Cloud Datastore
namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written
by the ExportEntities operation. For more information about Cloud Storage
namespace paths, see
Object name
considerations.
For more information, see
google.datastore.admin.v1.ExportEntitiesResponse.output_url.
Required. The full resource URL of the external storage location.
Currently, only Google Cloud Storage is supported. So input_url should be
of the form:
gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where
BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is
an optional Cloud Storage namespace path (this is not a Cloud Datastore
namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written
by the ExportEntities operation. For more information about Cloud Storage
namespace paths, see
Object name
considerations.
For more information, see
google.datastore.admin.v1.ExportEntitiesResponse.output_url.
Optionally specify which kinds/namespaces are to be imported. If provided,
the list must be a subset of the EntityFilter used in creating the export,
otherwise a FAILED_PRECONDITION error will be returned. If no filter is
specified then all entities from the export are imported.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Interface ImportEntitiesRequestOrBuilder (2.31.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.2 (latest)](/java/docs/reference/google-cloud-datastore/latest/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.31.1](/java/docs/reference/google-cloud-datastore/2.31.1/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.30.0](/java/docs/reference/google-cloud-datastore/2.30.0/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.29.1](/java/docs/reference/google-cloud-datastore/2.29.1/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.28.2](/java/docs/reference/google-cloud-datastore/2.28.2/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.27.1](/java/docs/reference/google-cloud-datastore/2.27.1/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.26.4](/java/docs/reference/google-cloud-datastore/2.26.4/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.25.2](/java/docs/reference/google-cloud-datastore/2.25.2/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.24.3](/java/docs/reference/google-cloud-datastore/2.24.3/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-datastore/2.23.0/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.22.0](/java/docs/reference/google-cloud-datastore/2.22.0/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.21.3](/java/docs/reference/google-cloud-datastore/2.21.3/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.20.2](/java/docs/reference/google-cloud-datastore/2.20.2/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.19.2](/java/docs/reference/google-cloud-datastore/2.19.2/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.18.5](/java/docs/reference/google-cloud-datastore/2.18.5/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder)\n- [2.17.6](/java/docs/reference/google-cloud-datastore/2.17.6/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder) \n\n public interface ImportEntitiesRequestOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### containsLabels(String key)\n\n public abstract boolean containsLabels(String key)\n\nClient-assigned labels.\n\n`map\u003cstring, string\u003e labels = 2;`\n\n### getEntityFilter()\n\n public abstract EntityFilter getEntityFilter()\n\nOptionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 4;`\n\n### getEntityFilterOrBuilder()\n\n public abstract EntityFilterOrBuilder getEntityFilterOrBuilder()\n\nOptionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 4;`\n\n### getInputUrl()\n\n public abstract String getInputUrl()\n\nRequired. The full resource URL of the external storage location.\nCurrently, only Google Cloud Storage is supported. So input_url should be\nof the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.\n\n`string input_url = 3 [(.google.api.field_behavior) = REQUIRED];`\n\n### getInputUrlBytes()\n\n public abstract ByteString getInputUrlBytes()\n\nRequired. The full resource URL of the external storage location.\nCurrently, only Google Cloud Storage is supported. So input_url should be\nof the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url.\n\n`string input_url = 3 [(.google.api.field_behavior) = REQUIRED];`\n\n### getLabels() (deprecated)\n\n public abstract Map\u003cString,String\u003e getLabels()\n\nUse [#getLabelsMap()](/java/docs/reference/google-cloud-datastore/latest/com.google.datastore.admin.v1.ImportEntitiesRequestOrBuilder#com_google_datastore_admin_v1_ImportEntitiesRequestOrBuilder_getLabelsMap__) instead.\n\n### getLabelsCount()\n\n public abstract int getLabelsCount()\n\nClient-assigned labels.\n\n`map\u003cstring, string\u003e labels = 2;`\n\n### getLabelsMap()\n\n public abstract Map\u003cString,String\u003e getLabelsMap()\n\nClient-assigned labels.\n\n`map\u003cstring, string\u003e labels = 2;`\n\n### getLabelsOrDefault(String key, String defaultValue)\n\n public abstract String getLabelsOrDefault(String key, String defaultValue)\n\nClient-assigned labels.\n\n`map\u003cstring, string\u003e labels = 2;`\n\n### getLabelsOrThrow(String key)\n\n public abstract String getLabelsOrThrow(String key)\n\nClient-assigned labels.\n\n`map\u003cstring, string\u003e labels = 2;`\n\n### getProjectId()\n\n public abstract String getProjectId()\n\nRequired. Project ID against which to make the request.\n\n`string project_id = 1 [(.google.api.field_behavior) = REQUIRED];`\n\n### getProjectIdBytes()\n\n public abstract ByteString getProjectIdBytes()\n\nRequired. Project ID against which to make the request.\n\n`string project_id = 1 [(.google.api.field_behavior) = REQUIRED];`\n\n### hasEntityFilter()\n\n public abstract boolean hasEntityFilter()\n\nOptionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 4;`"]]
