Struct Index 

#[non_exhaustive]
pub struct Index {
    pub name: String,
    pub query_scope: QueryScope,
    pub api_scope: ApiScope,
    pub fields: Vec<IndexField>,
    pub state: State,
    pub density: Density,
    pub multikey: bool,
    pub shard_count: i32,
    /* private fields */
}

Cloud Firestore indexes enable simple and complex queries against documents in a database.

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

Output only. A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.

query_scope: QueryScope

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID.

Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index.

api_scope: ApiScope

The API scope supported by this index.

fields: Vec<IndexField>

The fields supported by this index.

For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path __name__. If, on creation, __name__ was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the __name__ will be ordered ASCENDING (unless explicitly specified).

For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.

state: State

Output only. The serving state of the index.

density: Density

Immutable. The density configuration of the index.

multikey: bool

Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors.

Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.

shard_count: i32

Optional. The number of shards for the index.

Implementations

impl Index

pub fn new() -> Self

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

Sets the value of name.

Example

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

pub fn set_query_scope<T: Into<QueryScope>>(self, v: T) -> Self

Sets the value of query_scope.

Example

use google_cloud_firestore_admin_v1::model::index::QueryScope;
let x0 = Index::new().set_query_scope(QueryScope::Collection);
let x1 = Index::new().set_query_scope(QueryScope::CollectionGroup);
let x2 = Index::new().set_query_scope(QueryScope::CollectionRecursive);

pub fn set_api_scope<T: Into<ApiScope>>(self, v: T) -> Self

Sets the value of api_scope.

Example

use google_cloud_firestore_admin_v1::model::index::ApiScope;
let x0 = Index::new().set_api_scope(ApiScope::DatastoreModeApi);
let x1 = Index::new().set_api_scope(ApiScope::MongodbCompatibleApi);

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

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

Sets the value of fields.

Example

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

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_firestore_admin_v1::model::index::State;
let x0 = Index::new().set_state(State::Creating);
let x1 = Index::new().set_state(State::Ready);
let x2 = Index::new().set_state(State::NeedsRepair);

pub fn set_density<T: Into<Density>>(self, v: T) -> Self

Sets the value of density.

Example

use google_cloud_firestore_admin_v1::model::index::Density;
let x0 = Index::new().set_density(Density::SparseAll);
let x1 = Index::new().set_density(Density::SparseAny);
let x2 = Index::new().set_density(Density::Dense);

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

Sets the value of multikey.

Example

let x = Index::new().set_multikey(true);

pub fn set_shard_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of shard_count.

Example

let x = Index::new().set_shard_count(42);

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl Message for Index

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Index

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