Skip to main content

aws_sdk_kendra/types/
_data_source_sync_job_status.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// When writing a match expression against `DataSourceSyncJobStatus`, it is important to ensure
4/// your code is forward-compatible. That is, if a match arm handles a case for a
5/// feature that is supported by the service but has not been represented as an enum
6/// variant in a current version of SDK, your code should continue to work when you
7/// upgrade SDK to a future version in which the enum does include a variant for that
8/// feature.
9///
10/// Here is an example of how you can make a match expression forward-compatible:
11///
12/// ```text
13/// # let datasourcesyncjobstatus = unimplemented!();
14/// match datasourcesyncjobstatus {
15///     DataSourceSyncJobStatus::Aborted => { /* ... */ },
16///     DataSourceSyncJobStatus::Failed => { /* ... */ },
17///     DataSourceSyncJobStatus::Incomplete => { /* ... */ },
18///     DataSourceSyncJobStatus::Stopping => { /* ... */ },
19///     DataSourceSyncJobStatus::Succeeded => { /* ... */ },
20///     DataSourceSyncJobStatus::Syncing => { /* ... */ },
21///     DataSourceSyncJobStatus::SyncingIndexing => { /* ... */ },
22///     other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
23///     _ => { /* ... */ },
24/// }
25/// ```
26/// The above code demonstrates that when `datasourcesyncjobstatus` represents
27/// `NewFeature`, the execution path will lead to the second last match arm,
28/// even though the enum does not contain a variant `DataSourceSyncJobStatus::NewFeature`
29/// in the current version of SDK. The reason is that the variable `other`,
30/// created by the `@` operator, is bound to
31/// `DataSourceSyncJobStatus::Unknown(UnknownVariantValue("NewFeature".to_owned()))`
32/// and calling `as_str` on it yields `"NewFeature"`.
33/// This match expression is forward-compatible when executed with a newer
34/// version of SDK where the variant `DataSourceSyncJobStatus::NewFeature` is defined.
35/// Specifically, when `datasourcesyncjobstatus` represents `NewFeature`,
36/// the execution path will hit the second last match arm as before by virtue of
37/// calling `as_str` on `DataSourceSyncJobStatus::NewFeature` also yielding `"NewFeature"`.
38///
39/// Explicitly matching on the `Unknown` variant should
40/// be avoided for two reasons:
41/// - The inner data `UnknownVariantValue` is opaque, and no further information can be extracted.
42/// - It might inadvertently shadow other intended match arms.
43///
44#[allow(missing_docs)] // documentation missing in model
45#[non_exhaustive]
46#[derive(
47    ::std::clone::Clone, ::std::cmp::Eq, ::std::cmp::Ord, ::std::cmp::PartialEq, ::std::cmp::PartialOrd, ::std::fmt::Debug, ::std::hash::Hash,
48)]
49pub enum DataSourceSyncJobStatus {
50    #[allow(missing_docs)] // documentation missing in model
51    Aborted,
52    #[allow(missing_docs)] // documentation missing in model
53    Failed,
54    #[allow(missing_docs)] // documentation missing in model
55    Incomplete,
56    #[allow(missing_docs)] // documentation missing in model
57    Stopping,
58    #[allow(missing_docs)] // documentation missing in model
59    Succeeded,
60    #[allow(missing_docs)] // documentation missing in model
61    Syncing,
62    #[allow(missing_docs)] // documentation missing in model
63    SyncingIndexing,
64    /// `Unknown` contains new variants that have been added since this code was generated.
65    #[deprecated(note = "Don't directly match on `Unknown`. See the docs on this enum for the correct way to handle unknown variants.")]
66    Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue),
67}
68impl ::std::convert::From<&str> for DataSourceSyncJobStatus {
69    fn from(s: &str) -> Self {
70        match s {
71            "ABORTED" => DataSourceSyncJobStatus::Aborted,
72            "FAILED" => DataSourceSyncJobStatus::Failed,
73            "INCOMPLETE" => DataSourceSyncJobStatus::Incomplete,
74            "STOPPING" => DataSourceSyncJobStatus::Stopping,
75            "SUCCEEDED" => DataSourceSyncJobStatus::Succeeded,
76            "SYNCING" => DataSourceSyncJobStatus::Syncing,
77            "SYNCING_INDEXING" => DataSourceSyncJobStatus::SyncingIndexing,
78            other => DataSourceSyncJobStatus::Unknown(crate::primitives::sealed_enum_unknown::UnknownVariantValue(other.to_owned())),
79        }
80    }
81}
82impl ::std::str::FromStr for DataSourceSyncJobStatus {
83    type Err = ::std::convert::Infallible;
84
85    fn from_str(s: &str) -> ::std::result::Result<Self, <Self as ::std::str::FromStr>::Err> {
86        ::std::result::Result::Ok(DataSourceSyncJobStatus::from(s))
87    }
88}
89impl DataSourceSyncJobStatus {
90    /// Returns the `&str` value of the enum member.
91    pub fn as_str(&self) -> &str {
92        match self {
93            DataSourceSyncJobStatus::Aborted => "ABORTED",
94            DataSourceSyncJobStatus::Failed => "FAILED",
95            DataSourceSyncJobStatus::Incomplete => "INCOMPLETE",
96            DataSourceSyncJobStatus::Stopping => "STOPPING",
97            DataSourceSyncJobStatus::Succeeded => "SUCCEEDED",
98            DataSourceSyncJobStatus::Syncing => "SYNCING",
99            DataSourceSyncJobStatus::SyncingIndexing => "SYNCING_INDEXING",
100            DataSourceSyncJobStatus::Unknown(value) => value.as_str(),
101        }
102    }
103    /// Returns all the `&str` representations of the enum members.
104    pub const fn values() -> &'static [&'static str] {
105        &["ABORTED", "FAILED", "INCOMPLETE", "STOPPING", "SUCCEEDED", "SYNCING", "SYNCING_INDEXING"]
106    }
107}
108impl ::std::convert::AsRef<str> for DataSourceSyncJobStatus {
109    fn as_ref(&self) -> &str {
110        self.as_str()
111    }
112}
113impl DataSourceSyncJobStatus {
114    /// Parses the enum value while disallowing unknown variants.
115    ///
116    /// Unknown variants will result in an error.
117    pub fn try_parse(value: &str) -> ::std::result::Result<Self, crate::error::UnknownVariantError> {
118        match Self::from(value) {
119            #[allow(deprecated)]
120            Self::Unknown(_) => ::std::result::Result::Err(crate::error::UnknownVariantError::new(value)),
121            known => Ok(known),
122        }
123    }
124}
125impl ::std::fmt::Display for DataSourceSyncJobStatus {
126    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
127        match self {
128            DataSourceSyncJobStatus::Aborted => write!(f, "ABORTED"),
129            DataSourceSyncJobStatus::Failed => write!(f, "FAILED"),
130            DataSourceSyncJobStatus::Incomplete => write!(f, "INCOMPLETE"),
131            DataSourceSyncJobStatus::Stopping => write!(f, "STOPPING"),
132            DataSourceSyncJobStatus::Succeeded => write!(f, "SUCCEEDED"),
133            DataSourceSyncJobStatus::Syncing => write!(f, "SYNCING"),
134            DataSourceSyncJobStatus::SyncingIndexing => write!(f, "SYNCING_INDEXING"),
135            DataSourceSyncJobStatus::Unknown(value) => write!(f, "{value}"),
136        }
137    }
138}