Struct Field 

#[non_exhaustive]
pub struct Field {
    pub name: String,
    pub index_config: Option<IndexConfig>,
    pub ttl_config: Option<TtlConfig>,
    /* private fields */
}

Represents a single field in the database.

Fields are grouped by their “Collection Group”, which represent all collections in the database with the same ID.

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.

name: String

Required. A field name of the form: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

A field path can be a simple field name, e.g. address or a path to fields within map_value , e.g. address.city, or a special field path. The only valid special field is *, which represents any field.

Field paths can be quoted using ` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: *, ., ` (backtick), [, ], as well as any ascii symbolic characters.

Examples: `address.city` represents a field named address.city, not the map key city in the field address. `*` represents a field named *, not any field.

A special Field contains the default indexing settings for all fields. This field’s resource name is: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indexes defined on this Field will be applied to all fields which do not have their own Field index configuration.

index_config: Option<IndexConfig>

The index configuration for this field. If unset, field indexing will revert to the configuration defined by the ancestor_field. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.

ttl_config: Option<TtlConfig>

The TTL configuration for this Field. Setting or unsetting this will enable or disable the TTL for documents that have this Field.

Implementations

impl Field

pub fn new() -> Self

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

Sets the value of name.

Example

let x = Field::new().set_name("example");

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

where T: Into<IndexConfig>,

Sets the value of index_config.

Example

use google_cloud_firestore_admin_v1::model::field::IndexConfig;
let x = Field::new().set_index_config(IndexConfig::default()/* use setters */);

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

where T: Into<IndexConfig>,

Sets or clears the value of index_config.

Example

use google_cloud_firestore_admin_v1::model::field::IndexConfig;
let x = Field::new().set_or_clear_index_config(Some(IndexConfig::default()/* use setters */));
let x = Field::new().set_or_clear_index_config(None::<IndexConfig>);

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

where T: Into<TtlConfig>,

Sets the value of ttl_config.

Example

use google_cloud_firestore_admin_v1::model::field::TtlConfig;
let x = Field::new().set_ttl_config(TtlConfig::default()/* use setters */);

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

where T: Into<TtlConfig>,

Sets or clears the value of ttl_config.

Example

use google_cloud_firestore_admin_v1::model::field::TtlConfig;
let x = Field::new().set_or_clear_ttl_config(Some(TtlConfig::default()/* use setters */));
let x = Field::new().set_or_clear_ttl_config(None::<TtlConfig>);

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl Message for Field

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Field

fn eq(&self, other: &Field) -> 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 Field