Enum aws_sdk_opensearch::model::AutoTuneDesiredState

#[non_exhaustive]
pub enum AutoTuneDesiredState {
    Disabled,
    Enabled,
    Unknown(UnknownVariantValue),
}

When writing a match expression against AutoTuneDesiredState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Here is an example of how you can make a match expression forward-compatible:

# let autotunedesiredstate = unimplemented!();
match autotunedesiredstate {
    AutoTuneDesiredState::Disabled => { /* ... */ },
    AutoTuneDesiredState::Enabled => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when autotunedesiredstate represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant AutoTuneDesiredState::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to AutoTuneDesiredState::Unknown(UnknownVariantValue("NewFeature".to_owned())) and calling as_str on it yields "NewFeature". This match expression is forward-compatible when executed with a newer version of SDK where the variant AutoTuneDesiredState::NewFeature is defined. Specifically, when autotunedesiredstate represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on AutoTuneDesiredState::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

• The inner data UnknownVariantValue is opaque, and no further information can be extracted.
• It might inadvertently shadow other intended match arms.

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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.

Disabled

Enabled

Unknown(UnknownVariantValue)

Unknown contains new variants that have been added since this code was generated.

Implementations

impl AutoTuneDesiredState

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 2016)

    fn as_ref(&self) -> &str {
        self.as_str()
    }

src/json_ser.rs (line 596)

pub fn serialize_structure_crate_model_auto_tune_options_input(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::AutoTuneOptionsInput,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_131) = &input.desired_state {
        object.key("DesiredState").string(var_131.as_str());
    }
    if let Some(var_132) = &input.maintenance_schedules {
        let mut array_133 = object.key("MaintenanceSchedules").start_array();
        for item_134 in var_132 {
            {
                #[allow(unused_mut)]
                let mut object_135 = array_133.value().start_object();
                crate::json_ser::serialize_structure_crate_model_auto_tune_maintenance_schedule(
                    &mut object_135,
                    item_134,
                )?;
                object_135.finish();
            }
        }
        array_133.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_cluster_config(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::ClusterConfig,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_136) = &input.instance_type {
        object.key("InstanceType").string(var_136.as_str());
    }
    if let Some(var_137) = &input.instance_count {
        object.key("InstanceCount").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_137).into()),
        );
    }
    if let Some(var_138) = &input.dedicated_master_enabled {
        object.key("DedicatedMasterEnabled").boolean(*var_138);
    }
    if let Some(var_139) = &input.zone_awareness_enabled {
        object.key("ZoneAwarenessEnabled").boolean(*var_139);
    }
    if let Some(var_140) = &input.zone_awareness_config {
        #[allow(unused_mut)]
        let mut object_141 = object.key("ZoneAwarenessConfig").start_object();
        crate::json_ser::serialize_structure_crate_model_zone_awareness_config(
            &mut object_141,
            var_140,
        )?;
        object_141.finish();
    }
    if let Some(var_142) = &input.dedicated_master_type {
        object.key("DedicatedMasterType").string(var_142.as_str());
    }
    if let Some(var_143) = &input.dedicated_master_count {
        object.key("DedicatedMasterCount").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_143).into()),
        );
    }
    if let Some(var_144) = &input.warm_enabled {
        object.key("WarmEnabled").boolean(*var_144);
    }
    if let Some(var_145) = &input.warm_type {
        object.key("WarmType").string(var_145.as_str());
    }
    if let Some(var_146) = &input.warm_count {
        object.key("WarmCount").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_146).into()),
        );
    }
    if let Some(var_147) = &input.cold_storage_options {
        #[allow(unused_mut)]
        let mut object_148 = object.key("ColdStorageOptions").start_object();
        crate::json_ser::serialize_structure_crate_model_cold_storage_options(
            &mut object_148,
            var_147,
        )?;
        object_148.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_cognito_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::CognitoOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_149) = &input.enabled {
        object.key("Enabled").boolean(*var_149);
    }
    if let Some(var_150) = &input.user_pool_id {
        object.key("UserPoolId").string(var_150.as_str());
    }
    if let Some(var_151) = &input.identity_pool_id {
        object.key("IdentityPoolId").string(var_151.as_str());
    }
    if let Some(var_152) = &input.role_arn {
        object.key("RoleArn").string(var_152.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_domain_endpoint_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::DomainEndpointOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_153) = &input.enforce_https {
        object.key("EnforceHTTPS").boolean(*var_153);
    }
    if let Some(var_154) = &input.tls_security_policy {
        object.key("TLSSecurityPolicy").string(var_154.as_str());
    }
    if let Some(var_155) = &input.custom_endpoint_enabled {
        object.key("CustomEndpointEnabled").boolean(*var_155);
    }
    if let Some(var_156) = &input.custom_endpoint {
        object.key("CustomEndpoint").string(var_156.as_str());
    }
    if let Some(var_157) = &input.custom_endpoint_certificate_arn {
        object
            .key("CustomEndpointCertificateArn")
            .string(var_157.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_ebs_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::EbsOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_158) = &input.ebs_enabled {
        object.key("EBSEnabled").boolean(*var_158);
    }
    if let Some(var_159) = &input.volume_type {
        object.key("VolumeType").string(var_159.as_str());
    }
    if let Some(var_160) = &input.volume_size {
        object.key("VolumeSize").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_160).into()),
        );
    }
    if let Some(var_161) = &input.iops {
        object.key("Iops").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_161).into()),
        );
    }
    if let Some(var_162) = &input.throughput {
        object.key("Throughput").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_162).into()),
        );
    }
    Ok(())
}

pub fn serialize_structure_crate_model_encryption_at_rest_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::EncryptionAtRestOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_163) = &input.enabled {
        object.key("Enabled").boolean(*var_163);
    }
    if let Some(var_164) = &input.kms_key_id {
        object.key("KmsKeyId").string(var_164.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_log_publishing_option(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::LogPublishingOption,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_165) = &input.cloud_watch_logs_log_group_arn {
        object
            .key("CloudWatchLogsLogGroupArn")
            .string(var_165.as_str());
    }
    if let Some(var_166) = &input.enabled {
        object.key("Enabled").boolean(*var_166);
    }
    Ok(())
}

pub fn serialize_structure_crate_model_node_to_node_encryption_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::NodeToNodeEncryptionOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_167) = &input.enabled {
        object.key("Enabled").boolean(*var_167);
    }
    Ok(())
}

pub fn serialize_structure_crate_model_snapshot_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::SnapshotOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_168) = &input.automated_snapshot_start_hour {
        object.key("AutomatedSnapshotStartHour").number(
            #[allow(clippy::useless_conversion)]
            aws_smithy_types::Number::NegInt((*var_168).into()),
        );
    }
    Ok(())
}

pub fn serialize_structure_crate_model_vpc_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::VpcOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_169) = &input.subnet_ids {
        let mut array_170 = object.key("SubnetIds").start_array();
        for item_171 in var_169 {
            {
                array_170.value().string(item_171.as_str());
            }
        }
        array_170.finish();
    }
    if let Some(var_172) = &input.security_group_ids {
        let mut array_173 = object.key("SecurityGroupIds").start_array();
        for item_174 in var_172 {
            {
                array_173.value().string(item_174.as_str());
            }
        }
        array_173.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_domain_information_container(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::DomainInformationContainer,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_175) = &input.aws_domain_information {
        #[allow(unused_mut)]
        let mut object_176 = object.key("AWSDomainInformation").start_object();
        crate::json_ser::serialize_structure_crate_model_aws_domain_information(
            &mut object_176,
            var_175,
        )?;
        object_176.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_package_source(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::PackageSource,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_177) = &input.s3_bucket_name {
        object.key("S3BucketName").string(var_177.as_str());
    }
    if let Some(var_178) = &input.s3_key {
        object.key("S3Key").string(var_178.as_str());
    }
    Ok(())
}

pub fn serialize_structure_crate_model_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::Filter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_179) = &input.name {
        object.key("Name").string(var_179.as_str());
    }
    if let Some(var_180) = &input.values {
        let mut array_181 = object.key("Values").start_array();
        for item_182 in var_180 {
            {
                array_181.value().string(item_182.as_str());
            }
        }
        array_181.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_describe_packages_filter(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::DescribePackagesFilter,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_183) = &input.name {
        object.key("Name").string(var_183.as_str());
    }
    if let Some(var_184) = &input.value {
        let mut array_185 = object.key("Value").start_array();
        for item_186 in var_184 {
            {
                array_185.value().string(item_186.as_str());
            }
        }
        array_185.finish();
    }
    Ok(())
}

pub fn serialize_structure_crate_model_auto_tune_options(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::model::AutoTuneOptions,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_187) = &input.desired_state {
        object.key("DesiredState").string(var_187.as_str());
    }
    if let Some(var_188) = &input.rollback_on_disable {
        object.key("RollbackOnDisable").string(var_188.as_str());
    }
    if let Some(var_189) = &input.maintenance_schedules {
        let mut array_190 = object.key("MaintenanceSchedules").start_array();
        for item_191 in var_189 {
            {
                #[allow(unused_mut)]
                let mut object_192 = array_190.value().start_object();
                crate::json_ser::serialize_structure_crate_model_auto_tune_maintenance_schedule(
                    &mut object_192,
                    item_191,
                )?;
                object_192.finish();
            }
        }
        array_190.finish();
    }
    Ok(())
}

pub const fn values() -> &'static [&'static str]

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for AutoTuneDesiredState

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AutoTuneDesiredState

fn clone(&self) -> AutoTuneDesiredState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutoTuneDesiredState

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

Formats the value using the given formatter.

impl From<&str> for AutoTuneDesiredState

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for AutoTuneDesiredState

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for AutoTuneDesiredState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AutoTuneDesiredState

fn cmp(&self, other: &AutoTuneDesiredState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AutoTuneDesiredState> for AutoTuneDesiredState

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AutoTuneDesiredState> for AutoTuneDesiredState

fn partial_cmp(&self, other: &AutoTuneDesiredState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for AutoTuneDesiredState

impl StructuralEq for AutoTuneDesiredState

impl StructuralPartialEq for AutoTuneDesiredState