Struct PartitionIndexDescriptor

#[non_exhaustive]
pub struct PartitionIndexDescriptor {
    pub index_name: String,
    pub keys: Vec<KeySchemaElement>,
    pub index_status: PartitionIndexStatus,
    pub backfill_errors: Option<Vec<BackfillError>>,
}

A descriptor for a partition index in a table.

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.

index_name: String

The name of the partition index.

keys: Vec<KeySchemaElement>

A list of one or more keys, as KeySchemaElement structures, for the partition index.

index_status: PartitionIndexStatus

The status of the partition index.

The possible statuses are:

• CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.

• ACTIVE: The index creation succeeds.

• FAILED: The index creation fails.

• DELETING: The index is deleted from the list of indexes.

backfill_errors: Option<Vec<BackfillError>>

A list of errors that can occur when registering partition indexes for an existing table.

Implementations

impl PartitionIndexDescriptor

pub fn index_name(&self) -> &str

The name of the partition index.

pub fn keys(&self) -> &[KeySchemaElement]

A list of one or more keys, as KeySchemaElement structures, for the partition index.

pub fn index_status(&self) -> &PartitionIndexStatus

The status of the partition index.

The possible statuses are:

• CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.

• ACTIVE: The index creation succeeds.

• FAILED: The index creation fails.

• DELETING: The index is deleted from the list of indexes.

pub fn backfill_errors(&self) -> &[BackfillError]

A list of errors that can occur when registering partition indexes for an existing table.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .backfill_errors.is_none().

impl PartitionIndexDescriptor

pub fn builder() -> PartitionIndexDescriptorBuilder

Creates a new builder-style object to manufacture PartitionIndexDescriptor.

Trait Implementations

impl Clone for PartitionIndexDescriptor

fn clone(&self) -> PartitionIndexDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartitionIndexDescriptor

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

Formats the value using the given formatter.

impl PartialEq for PartitionIndexDescriptor

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