aws-sdk-datazone 1.137.0

AWS SDK for Amazon DataZone
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct SearchListingsOutput {
    /// <p>The results of the <code>SearchListings</code> action.</p>
    pub items: ::std::option::Option<::std::vec::Vec<crate::types::SearchResultItem>>,
    /// <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>Total number of search results.</p>
    pub total_match_count: ::std::option::Option<i32>,
    /// <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>
    pub aggregates: ::std::option::Option<::std::vec::Vec<crate::types::AggregationOutput>>,
    _request_id: Option<String>,
}
impl SearchListingsOutput {
    /// <p>The results of the <code>SearchListings</code> action.</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 `.items.is_none()`.
    pub fn items(&self) -> &[crate::types::SearchResultItem] {
        self.items.as_deref().unwrap_or_default()
    }
    /// <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>Total number of search results.</p>
    pub fn total_match_count(&self) -> ::std::option::Option<i32> {
        self.total_match_count
    }
    /// <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</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 `.aggregates.is_none()`.
    pub fn aggregates(&self) -> &[crate::types::AggregationOutput] {
        self.aggregates.as_deref().unwrap_or_default()
    }
}
impl ::aws_types::request_id::RequestId for SearchListingsOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl SearchListingsOutput {
    /// Creates a new builder-style object to manufacture [`SearchListingsOutput`](crate::operation::search_listings::SearchListingsOutput).
    pub fn builder() -> crate::operation::search_listings::builders::SearchListingsOutputBuilder {
        crate::operation::search_listings::builders::SearchListingsOutputBuilder::default()
    }
}

/// A builder for [`SearchListingsOutput`](crate::operation::search_listings::SearchListingsOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SearchListingsOutputBuilder {
    pub(crate) items: ::std::option::Option<::std::vec::Vec<crate::types::SearchResultItem>>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) total_match_count: ::std::option::Option<i32>,
    pub(crate) aggregates: ::std::option::Option<::std::vec::Vec<crate::types::AggregationOutput>>,
    _request_id: Option<String>,
}
impl SearchListingsOutputBuilder {
    /// Appends an item to `items`.
    ///
    /// To override the contents of this collection use [`set_items`](Self::set_items).
    ///
    /// <p>The results of the <code>SearchListings</code> action.</p>
    pub fn items(mut self, input: crate::types::SearchResultItem) -> Self {
        let mut v = self.items.unwrap_or_default();
        v.push(input);
        self.items = ::std::option::Option::Some(v);
        self
    }
    /// <p>The results of the <code>SearchListings</code> action.</p>
    pub fn set_items(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SearchResultItem>>) -> Self {
        self.items = input;
        self
    }
    /// <p>The results of the <code>SearchListings</code> action.</p>
    pub fn get_items(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SearchResultItem>> {
        &self.items
    }
    /// <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</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>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>When the number of results is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of results, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>SearchListings</code> to list the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>Total number of search results.</p>
    pub fn total_match_count(mut self, input: i32) -> Self {
        self.total_match_count = ::std::option::Option::Some(input);
        self
    }
    /// <p>Total number of search results.</p>
    pub fn set_total_match_count(mut self, input: ::std::option::Option<i32>) -> Self {
        self.total_match_count = input;
        self
    }
    /// <p>Total number of search results.</p>
    pub fn get_total_match_count(&self) -> &::std::option::Option<i32> {
        &self.total_match_count
    }
    /// Appends an item to `aggregates`.
    ///
    /// To override the contents of this collection use [`set_aggregates`](Self::set_aggregates).
    ///
    /// <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>
    pub fn aggregates(mut self, input: crate::types::AggregationOutput) -> Self {
        let mut v = self.aggregates.unwrap_or_default();
        v.push(input);
        self.aggregates = ::std::option::Option::Some(v);
        self
    }
    /// <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>
    pub fn set_aggregates(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AggregationOutput>>) -> Self {
        self.aggregates = input;
        self
    }
    /// <p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>
    pub fn get_aggregates(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AggregationOutput>> {
        &self.aggregates
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`SearchListingsOutput`](crate::operation::search_listings::SearchListingsOutput).
    pub fn build(self) -> crate::operation::search_listings::SearchListingsOutput {
        crate::operation::search_listings::SearchListingsOutput {
            items: self.items,
            next_token: self.next_token,
            total_match_count: self.total_match_count,
            aggregates: self.aggregates,
            _request_id: self._request_id,
        }
    }
}