Struct ContainerProperties 

pub struct ContainerProperties {
    pub id: Cow<'static, str>,
    pub partition_key: PartitionKeyDefinition,
    pub indexing_policy: Option<IndexingPolicy>,
    pub unique_key_policy: Option<UniqueKeyPolicy>,
    pub conflict_resolution_policy: Option<ConflictResolutionPolicy>,
    pub vector_embedding_policy: Option<VectorEmbeddingPolicy>,
    pub default_ttl: Option<Duration>,
    pub analytical_storage_ttl: Option<Duration>,
    pub system_properties: SystemProperties,
}

Properties of a Cosmos DB container.

Constructing

When constructing this type, you should always use Struct Update syntax using ..Default::default(), for example:

let properties = ContainerProperties {
    id: "NewContainer".into(),
    partition_key: "/partitionKey".into(),
    ..Default::default()
};

Using this syntax has two purposes:

1. It allows you to construct the type even though SystemProperties is not constructable (these properties should always be empty when you send a request).
2. It protects you if we add additional properties to this struct.

Also, note that the id and partition_key values are required by the server. You will get an error from the server if you omit them.

Fields

id: Cow<'static, str>

The ID of the container.

partition_key: PartitionKeyDefinition

The definition of the partition key for the container.

indexing_policy: Option<IndexingPolicy>

The indexing policy for the container.

unique_key_policy: Option<UniqueKeyPolicy>

The unique key policy for the container.

conflict_resolution_policy: Option<ConflictResolutionPolicy>

The conflict resolution policy for the container.

vector_embedding_policy: Option<VectorEmbeddingPolicy>

The vector embedding policy for the container.

default_ttl: Option<Duration>

The time-to-live for items in the container.

For more information see https://learn.microsoft.com/azure/cosmos-db/time-to-live#time-to-live-configurations

analytical_storage_ttl: Option<Duration>

The time-to-live for the analytical store in the container.

For more information see https://learn.microsoft.com/azure/cosmos-db/analytical-store-introduction#analytical-ttl

system_properties: SystemProperties

A SystemProperties object containing common system properties for the container.

Trait Implementations

impl Clone for ContainerProperties

fn clone(&self) -> ContainerProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerProperties

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

Formats the value using the given formatter.

impl Default for ContainerProperties

fn default() -> ContainerProperties

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContainerProperties

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContainerProperties

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ContainerProperties

impl StructuralPartialEq for ContainerProperties