aws-sdk-datasync 1.130.0

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>ListLocationsRequest</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListLocationsInput {
    /// <p>The maximum number of locations to return.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
    pub filters: ::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>>,
}
impl ListLocationsInput {
    /// <p>The maximum number of locations to return.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
    pub fn filters(&self) -> &[crate::types::LocationFilter] {
        self.filters.as_deref().unwrap_or_default()
    }
}
static LISTLOCATIONSINPUT_MEMBER_MAX_RESULTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#ListLocationsInput$MaxResults",
        "com.amazonaws.datasync.synthetic",
        "ListLocationsInput",
    ),
    ::aws_smithy_schema::ShapeType::Integer,
    "MaxResults",
    0,
);
static LISTLOCATIONSINPUT_MEMBER_NEXT_TOKEN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#ListLocationsInput$NextToken",
        "com.amazonaws.datasync.synthetic",
        "ListLocationsInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "NextToken",
    1,
);
static LISTLOCATIONSINPUT_MEMBER_FILTERS_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync#LocationFilters$member",
        "com.amazonaws.datasync",
        "LocationFilters",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    "member",
    0,
);
static LISTLOCATIONSINPUT_MEMBER_FILTERS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#ListLocationsInput$Filters",
        "com.amazonaws.datasync.synthetic",
        "ListLocationsInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "Filters",
    2,
)
.with_list_member(&LISTLOCATIONSINPUT_MEMBER_FILTERS_MEMBER);
static LISTLOCATIONSINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.datasync.synthetic#ListLocationsInput",
        "com.amazonaws.datasync.synthetic",
        "ListLocationsInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &LISTLOCATIONSINPUT_MEMBER_MAX_RESULTS,
        &LISTLOCATIONSINPUT_MEMBER_NEXT_TOKEN,
        &LISTLOCATIONSINPUT_MEMBER_FILTERS,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("ListLocationsRequest");
impl ListLocationsInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &LISTLOCATIONSINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for ListLocationsInput {
    fn schema(&self) -> &::aws_smithy_schema::Schema<'_> {
        Self::SCHEMA
    }

    #[allow(unused_variables, clippy::diverging_sub_expression)]
    fn serialize_members(
        &self,
        ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        if let Some(ref val) = self.max_results {
            ser.write_integer(&LISTLOCATIONSINPUT_MEMBER_MAX_RESULTS, *val)?;
        }
        if let Some(ref val) = self.next_token {
            ser.write_string(&LISTLOCATIONSINPUT_MEMBER_NEXT_TOKEN, val)?;
        }
        if let Some(ref val) = self.filters {
            ser.write_list(
                &LISTLOCATIONSINPUT_MEMBER_FILTERS,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_struct(crate::types::LocationFilter::SCHEMA, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        Ok(())
    }
}
impl crate::operation::list_locations::builders::ListLocationsInputBuilder {
    #[allow(
        unused_variables,
        unreachable_code,
        clippy::single_match,
        clippy::match_single_binding,
        clippy::diverging_sub_expression
    )]
    pub(crate) fn deserialize_members(
        &mut self,
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        deserializer.read_struct(&LISTLOCATIONSINPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.max_results = Some(deser.read_integer(member)?);
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.next_token = Some(deser.read_string(member)?);
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.filters = Some({
                            let mut container = Vec::new();
                            deser.read_list(member, &mut |deser| {
                                container.push(crate::types::LocationFilter::deserialize(deser)?);
                                Ok(())
                            })?;
                            container
                        });
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl ListLocationsInput {
    /// Deserializes this structure from a [`ShapeDeserializer`].
    pub fn deserialize(
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<Self, ::aws_smithy_schema::serde::SerdeError> {
        let mut builder = Self::builder();
        builder.deserialize_members(deserializer)?;
        builder.build().map_err(|e| aws_smithy_schema::serde::SerdeError::custom(e.to_string()))
    }
}
impl ListLocationsInput {
    /// Creates a new builder-style object to manufacture [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
    pub fn builder() -> crate::operation::list_locations::builders::ListLocationsInputBuilder {
        crate::operation::list_locations::builders::ListLocationsInputBuilder::default()
    }
}

/// A builder for [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListLocationsInputBuilder {
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>>,
}
impl ListLocationsInputBuilder {
    /// <p>The maximum number of locations to return.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of locations to return.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of locations to return.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>An opaque string that indicates the position at which to begin the next list of locations.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
    pub fn filters(mut self, input: crate::types::LocationFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = ::std::option::Option::Some(v);
        self
    }
    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>>) -> Self {
        self.filters = input;
        self
    }
    /// <p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::LocationFilter>> {
        &self.filters
    }
    /// Consumes the builder and constructs a [`ListLocationsInput`](crate::operation::list_locations::ListLocationsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::list_locations::ListLocationsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_locations::ListLocationsInput {
            max_results: self.max_results,
            next_token: self.next_token,
            filters: self.filters,
        })
    }
}