Struct gapi_grpc::google::firestore::admin::v1::Index

[+] Show declaration

pub struct Index {
    pub name: String,
    pub query_scope: i32,
    pub fields: Vec<IndexField>,
    pub state: i32,
}

[−] Expand description

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

Fields

name: String

[−] Expand description

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: i32

[−] Expand description

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.

fields: Vec<IndexField>

[−] Expand description

The fields supported by this index.

For composite indexes, this is always 2 or more 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: i32

[−] Expand description

Output only. The serving state of the index.

Implementations

impl Index[−]

pub fn query_scope(&self) -> QueryScope[−]

Returns the enum value of query_scope, or the default if the field is set to an invalid enum value.

pub fn set_query_scope(&mut self, value: QueryScope)[−]

Sets query_scope to the provided enum value.

pub fn state(&self) -> State[−]

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)[−]

Sets state to the provided enum value.

Trait Implementations

impl Clone for Index[+]

[+] Show hidden undocumented items

fn clone(&self) -> Index[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Index[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Index[+]

[+] Show hidden undocumented items

fn default() -> Index[−]

Returns the “default value” for a type.

impl Message for Index[+]

[+] Show hidden undocumented items

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize[−]

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)[−]

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, [−]

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Index> for Index[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Index) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Index) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for Index