Struct ExportEntitiesRequest 

#[non_exhaustive]
pub struct ExportEntitiesRequest {
    pub project_id: String,
    pub labels: HashMap<String, String>,
    pub entity_filter: Option<EntityFilter>,
    pub output_url_prefix: String,
    /* private fields */
}

The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

project_id: String

Required. Project ID against which to make the request.

labels: HashMap<String, String>

Client-assigned labels.

entity_filter: Option<EntityFilter>

Description of what data from the project is included in the export.

output_url_prefix: String

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.

Implementations

impl ExportEntitiesRequest

pub fn new() -> Self

Creates a new default instance.

pub fn set_project_id<T: Into<String>>(self, v: T) -> Self

Sets the value of project_id.

Example

let x = ExportEntitiesRequest::new().set_project_id("example");

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = ExportEntitiesRequest::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_entity_filter<T>(self, v: T) -> Self

where T: Into<EntityFilter>,

Sets the value of entity_filter.

Example

use google_cloud_datastore_admin_v1::model::EntityFilter;
let x = ExportEntitiesRequest::new().set_entity_filter(EntityFilter::default()/* use setters */);

pub fn set_or_clear_entity_filter<T>(self, v: Option<T>) -> Self

where T: Into<EntityFilter>,

Sets or clears the value of entity_filter.

Example

use google_cloud_datastore_admin_v1::model::EntityFilter;
let x = ExportEntitiesRequest::new().set_or_clear_entity_filter(Some(EntityFilter::default()/* use setters */));
let x = ExportEntitiesRequest::new().set_or_clear_entity_filter(None::<EntityFilter>);

pub fn set_output_url_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of output_url_prefix.

Example

let x = ExportEntitiesRequest::new().set_output_url_prefix("example");

Trait Implementations

impl Clone for ExportEntitiesRequest

fn clone(&self) -> ExportEntitiesRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExportEntitiesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExportEntitiesRequest

fn default() -> ExportEntitiesRequest

Returns the “default value” for a type.

impl Message for ExportEntitiesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExportEntitiesRequest

fn eq(&self, other: &ExportEntitiesRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ExportEntitiesRequest