Struct FirestoreSource 

#[non_exhaustive]
pub struct FirestoreSource {
    pub project_id: String,
    pub database_id: String,
    pub collection_id: String,
    pub gcs_staging_dir: String,
    /* private fields */
}

Available on crate feature document-service only.

Firestore source import data from.

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

The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.

database_id: String

Required. The Firestore database to copy the data from with a length limit of 256 characters.

collection_id: String

Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.

gcs_staging_dir: String

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.

Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

Implementations

impl FirestoreSource

pub fn new() -> Self

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

Sets the value of project_id.

Example

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

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

Sets the value of database_id.

Example

let x = FirestoreSource::new().set_database_id("example");

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

Sets the value of collection_id.

Example

let x = FirestoreSource::new().set_collection_id("example");

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

Sets the value of gcs_staging_dir.

Example

let x = FirestoreSource::new().set_gcs_staging_dir("example");

Trait Implementations

impl Clone for FirestoreSource

fn clone(&self) -> FirestoreSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreSource

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

Formats the value using the given formatter.

impl Default for FirestoreSource

fn default() -> FirestoreSource

Returns the “default value” for a type.

impl Message for FirestoreSource

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FirestoreSource

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FirestoreSource