Struct InventoryConfiguration

#[non_exhaustive]
pub struct InventoryConfiguration {
    pub destination: Option<InventoryDestination>,
    pub is_enabled: bool,
    pub filter: Option<InventoryFilter>,
    pub id: String,
    pub included_object_versions: InventoryIncludedObjectVersions,
    pub optional_fields: Option<Vec<InventoryOptionalField>>,
    pub schedule: Option<InventorySchedule>,
}

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

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.

destination: Option<InventoryDestination>

Contains information about where to publish the inventory results.

is_enabled: bool

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

filter: Option<InventoryFilter>

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

id: String

The ID used to identify the inventory configuration.

included_object_versions: InventoryIncludedObjectVersions

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

optional_fields: Option<Vec<InventoryOptionalField>>

Contains the optional fields that are included in the inventory results.

schedule: Option<InventorySchedule>

Specifies the schedule for generating inventory results.

Implementations

impl InventoryConfiguration

pub fn destination(&self) -> Option<&InventoryDestination>

Contains information about where to publish the inventory results.

pub fn is_enabled(&self) -> bool

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

pub fn filter(&self) -> Option<&InventoryFilter>

Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

pub fn id(&self) -> &str

The ID used to identify the inventory configuration.

pub fn included_object_versions(&self) -> &InventoryIncludedObjectVersions

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

pub fn optional_fields(&self) -> &[InventoryOptionalField]

Contains the optional fields that are included in the inventory results.

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

pub fn schedule(&self) -> Option<&InventorySchedule>

Specifies the schedule for generating inventory results.

impl InventoryConfiguration

pub fn builder() -> InventoryConfigurationBuilder

Creates a new builder-style object to manufacture InventoryConfiguration.

Trait Implementations

impl Clone for InventoryConfiguration

fn clone(&self) -> InventoryConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InventoryConfiguration

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

Formats the value using the given formatter.

impl PartialEq for InventoryConfiguration

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