Struct gapi_grpc::google::firestore::admin::v1::field::IndexConfig

pub struct IndexConfig {
    pub indexes: Vec<Index>,
    pub uses_ancestor_config: bool,
    pub ancestor_field: String,
    pub reverting: bool,
}

The index configuration for this field.

Fields

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.

Trait Implementations

impl Clone for IndexConfig

fn clone(&self) -> IndexConfig

Returns a copy of the value.

pub 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 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<IndexConfig> for IndexConfig

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

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

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

This method tests for !=.

impl StructuralPartialEq for IndexConfig