Struct IndexConfig 

#[non_exhaustive]
pub struct IndexConfig {
    pub indexes: Vec<Index>,
    pub uses_ancestor_config: bool,
    pub ancestor_field: String,
    pub reverting: bool,
    /* private fields */
}

The index configuration for this field.

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.

indexes: Vec<Index>

The indexes supported for this field.

uses_ancestor_config: bool

Output only. When true, the Field’s index configuration is set from the configuration specified by the ancestor_field. When false, the Field’s index configuration is defined explicitly.

ancestor_field: String

Output only. Specifies the resource name of the Field from which this field’s index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

reverting: bool

Output only When true, the Field’s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

Implementations

impl IndexConfig

pub fn new() -> Self

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

where T: IntoIterator<Item = V>, V: Into<Index>,

Sets the value of indexes.

Example

use google_cloud_firestore_admin_v1::model::Index;
let x = IndexConfig::new()
    .set_indexes([
        Index::default()/* use setters */,
        Index::default()/* use (different) setters */,
    ]);

pub fn set_uses_ancestor_config<T: Into<bool>>(self, v: T) -> Self

Sets the value of uses_ancestor_config.

Example

let x = IndexConfig::new().set_uses_ancestor_config(true);

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

Sets the value of ancestor_field.

Example

let x = IndexConfig::new().set_ancestor_field("example");

pub fn set_reverting<T: Into<bool>>(self, v: T) -> Self

Sets the value of reverting.

Example

let x = IndexConfig::new().set_reverting(true);

Trait Implementations

impl Clone for IndexConfig

fn clone(&self) -> IndexConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexConfig

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

Formats the value using the given formatter.

impl Default for IndexConfig

fn default() -> IndexConfig

Returns the “default value” for a type.

impl Message for IndexConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for IndexConfig

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