Enum IndexUsageMode 

#[non_exhaustive]
pub enum IndexUsageMode {
    Unspecified,
    Unused,
    PartiallyUsed,
    FullyUsed,
    UnknownValue(UnknownValue),
}

Indicates the type of vector index usage in the entire vector search query.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Index usage mode not specified.

Unused

No vector indexes were used in the vector search query. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for detailed reasons.

PartiallyUsed

Part of the vector search query used vector indexes. See [indexUnusedReasons] (/bigquery/docs/reference/rest/v2/Job#IndexUnusedReason) for why other parts of the query did not use vector indexes.

FullyUsed

The entire vector search query used vector indexes.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using IndexUsageMode::value or IndexUsageMode::name.

Implementations

impl IndexUsageMode

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for IndexUsageMode

fn clone(&self) -> IndexUsageMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexUsageMode

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

Formats the value using the given formatter.

impl Default for IndexUsageMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexUsageMode

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IndexUsageMode

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

Formats the value using the given formatter.

impl From<&str> for IndexUsageMode

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for IndexUsageMode

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for IndexUsageMode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for IndexUsageMode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IndexUsageMode