public sealed class ExportEntitiesRequest : IMessage<ExportEntitiesRequest>, IEquatable<ExportEntitiesRequest>, IDeepCloneable<ExportEntitiesRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Datastore v1 API class ExportEntitiesRequest.
The request for [google.datastore.admin.v1.DatastoreAdmin.ExportEntities][google.datastore.admin.v1.DatastoreAdmin.ExportEntities].
Implements
IMessageExportEntitiesRequest, IEquatableExportEntitiesRequest, IDeepCloneableExportEntitiesRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Datastore.Admin.V1Assembly
Google.Cloud.Datastore.Admin.V1.dll
Constructors
ExportEntitiesRequest()
public ExportEntitiesRequest()
ExportEntitiesRequest(ExportEntitiesRequest)
public ExportEntitiesRequest(ExportEntitiesRequest other)
Parameter | |
---|---|
Name | Description |
other | ExportEntitiesRequest |
Properties
EntityFilter
public EntityFilter EntityFilter { get; set; }
Description of what data from the project is included in the export.
Property Value | |
---|---|
Type | Description |
EntityFilter |
Labels
public MapField<string, string> Labels { get; }
Client-assigned labels.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
OutputUrlPrefix
public string OutputUrlPrefix { get; set; }
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][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.
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; set; }
Required. Project ID against which to make the request.
Property Value | |
---|---|
Type | Description |
string |