Required. Location for the export metadata and data files.
The full resource URL of the external storage location. Currently, only
Google Cloud Storage is supported. So output_url_prefix should be of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the
name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud
Storage namespace path (this is not a Cloud Datastore namespace). For more
information about Cloud Storage namespace paths, see
Object name
considerations.
The resulting files will be nested deeper than the specified URL prefix.
The final output URL will be provided in the
google.datastore.admin.v1.ExportEntitiesResponse.output_url
field. That value should be used for subsequent ImportEntities operations.
By nesting the data files deeper, the same Cloud Storage bucket can be used
in multiple ExportEntities operations without conflict.
Required. Location for the export metadata and data files.
The full resource URL of the external storage location. Currently, only
Google Cloud Storage is supported. So output_url_prefix should be of the
form: gs://BUCKET_NAME[/NAMESPACE_PATH], where BUCKET_NAME is the
name of the Cloud Storage bucket and NAMESPACE_PATH is an optional Cloud
Storage namespace path (this is not a Cloud Datastore namespace). For more
information about Cloud Storage namespace paths, see
Object name
considerations.
The resulting files will be nested deeper than the specified URL prefix.
The final output URL will be provided in the
google.datastore.admin.v1.ExportEntitiesResponse.output_url
field. That value should be used for subsequent ImportEntities operations.
By nesting the data files deeper, the same Cloud Storage bucket can be used
in multiple ExportEntities operations without conflict.
[[["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 ExportEntitiesRequestOrBuilder (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.ExportEntitiesRequestOrBuilder)\n- [2.31.1](/java/docs/reference/google-cloud-datastore/2.31.1/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.30.0](/java/docs/reference/google-cloud-datastore/2.30.0/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.29.1](/java/docs/reference/google-cloud-datastore/2.29.1/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.28.2](/java/docs/reference/google-cloud-datastore/2.28.2/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.27.1](/java/docs/reference/google-cloud-datastore/2.27.1/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.26.4](/java/docs/reference/google-cloud-datastore/2.26.4/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.25.2](/java/docs/reference/google-cloud-datastore/2.25.2/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.24.3](/java/docs/reference/google-cloud-datastore/2.24.3/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.23.0](/java/docs/reference/google-cloud-datastore/2.23.0/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.22.0](/java/docs/reference/google-cloud-datastore/2.22.0/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.21.3](/java/docs/reference/google-cloud-datastore/2.21.3/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.20.2](/java/docs/reference/google-cloud-datastore/2.20.2/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.19.2](/java/docs/reference/google-cloud-datastore/2.19.2/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.18.5](/java/docs/reference/google-cloud-datastore/2.18.5/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder)\n- [2.17.6](/java/docs/reference/google-cloud-datastore/2.17.6/com.google.datastore.admin.v1.ExportEntitiesRequestOrBuilder) \n\n public interface ExportEntitiesRequestOrBuilder 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\nDescription of what data from the project is included in the export.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 3;`\n\n### getEntityFilterOrBuilder()\n\n public abstract EntityFilterOrBuilder getEntityFilterOrBuilder()\n\nDescription of what data from the project is included in the export.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 3;`\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.ExportEntitiesRequestOrBuilder#com_google_datastore_admin_v1_ExportEntitiesRequestOrBuilder_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### getOutputUrlPrefix()\n\n public abstract String getOutputUrlPrefix()\n\nRequired. Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.\n\n`string output_url_prefix = 4 [(.google.api.field_behavior) = REQUIRED];`\n\n### getOutputUrlPrefixBytes()\n\n public abstract ByteString getOutputUrlPrefixBytes()\n\nRequired. Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.\n\n`string output_url_prefix = 4 [(.google.api.field_behavior) = REQUIRED];`\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\nDescription of what data from the project is included in the export.\n\n`.google.datastore.admin.v1.EntityFilter entity_filter = 3;`"]]
