aws_sdk_machinelearning/operation/describe_batch_predictions/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_batch_predictions::_describe_batch_predictions_output::DescribeBatchPredictionsOutputBuilder;

pub use crate::operation::describe_batch_predictions::_describe_batch_predictions_input::DescribeBatchPredictionsInputBuilder;

impl crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_batch_predictions::DescribeBatchPredictionsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_batch_predictions();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeBatchPredictions`.
///
/// <p>Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeBatchPredictionsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput,
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsError,
    > for DescribeBatchPredictionsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput,
            crate::operation::describe_batch_predictions::DescribeBatchPredictionsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeBatchPredictionsFluentBuilder {
    /// Creates a new `DescribeBatchPredictionsFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the DescribeBatchPredictions as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_batch_predictions::builders::DescribeBatchPredictionsInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_batch_predictions::DescribeBatchPredictionsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::describe_batch_predictions::DescribeBatchPredictions::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_batch_predictions::DescribeBatchPredictions::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsOutput,
        crate::operation::describe_batch_predictions::DescribeBatchPredictionsError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::describe_batch_predictions::paginator::DescribeBatchPredictionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_batch_predictions::paginator::DescribeBatchPredictionsPaginator {
        crate::operation::describe_batch_predictions::paginator::DescribeBatchPredictionsPaginator::new(self.handle, self.inner)
    }
    /// <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
    /// <ul>
    /// <li>
    /// <p><code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p></li>
    /// <li>
    /// <p><code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p></li>
    /// <li>
    /// <p><code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <b> </b> <code>Name</code>.</p></li>
    /// <li>
    /// <p><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p></li>
    /// <li>
    /// <p><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p></li>
    /// </ul>
    pub fn filter_variable(mut self, input: crate::types::BatchPredictionFilterVariable) -> Self {
        self.inner = self.inner.filter_variable(input);
        self
    }
    /// <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
    /// <ul>
    /// <li>
    /// <p><code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p></li>
    /// <li>
    /// <p><code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p></li>
    /// <li>
    /// <p><code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <b> </b> <code>Name</code>.</p></li>
    /// <li>
    /// <p><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p></li>
    /// <li>
    /// <p><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p></li>
    /// </ul>
    pub fn set_filter_variable(mut self, input: ::std::option::Option<crate::types::BatchPredictionFilterVariable>) -> Self {
        self.inner = self.inner.set_filter_variable(input);
        self
    }
    /// <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
    /// <ul>
    /// <li>
    /// <p><code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p></li>
    /// <li>
    /// <p><code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p></li>
    /// <li>
    /// <p><code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <b> </b> <code>Name</code>.</p></li>
    /// <li>
    /// <p><code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p></li>
    /// <li>
    /// <p><code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p></li>
    /// <li>
    /// <p><code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p></li>
    /// </ul>
    pub fn get_filter_variable(&self) -> &::std::option::Option<crate::types::BatchPredictionFilterVariable> {
        self.inner.get_filter_variable()
    }
    /// <p>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
    pub fn eq(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.eq(input.into());
        self
    }
    /// <p>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
    pub fn set_eq(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_eq(input);
        self
    }
    /// <p>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
    pub fn get_eq(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_eq()
    }
    /// <p>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
    pub fn gt(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.gt(input.into());
        self
    }
    /// <p>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
    pub fn set_gt(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_gt(input);
        self
    }
    /// <p>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
    pub fn get_gt(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_gt()
    }
    /// <p>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
    pub fn lt(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.lt(input.into());
        self
    }
    /// <p>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
    pub fn set_lt(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_lt(input);
        self
    }
    /// <p>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
    pub fn get_lt(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_lt()
    }
    /// <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.</p>
    pub fn ge(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.ge(input.into());
        self
    }
    /// <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.</p>
    pub fn set_ge(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_ge(input);
        self
    }
    /// <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.</p>
    pub fn get_ge(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_ge()
    }
    /// <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
    pub fn le(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.le(input.into());
        self
    }
    /// <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
    pub fn set_le(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_le(input);
        self
    }
    /// <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
    pub fn get_le(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_le()
    }
    /// <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
    pub fn ne(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.ne(input.into());
        self
    }
    /// <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
    pub fn set_ne(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_ne(input);
        self
    }
    /// <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
    pub fn get_ne(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_ne()
    }
    /// <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
    /// <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>:</p>
    /// <ul>
    /// <li>
    /// <p>2014-09</p></li>
    /// <li>
    /// <p>2014-09-09</p></li>
    /// <li>
    /// <p>2014-09-09-Holiday</p></li>
    /// </ul>
    pub fn prefix(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.prefix(input.into());
        self
    }
    /// <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
    /// <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>:</p>
    /// <ul>
    /// <li>
    /// <p>2014-09</p></li>
    /// <li>
    /// <p>2014-09-09</p></li>
    /// <li>
    /// <p>2014-09-09-Holiday</p></li>
    /// </ul>
    pub fn set_prefix(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_prefix(input);
        self
    }
    /// <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
    /// <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>:</p>
    /// <ul>
    /// <li>
    /// <p>2014-09</p></li>
    /// <li>
    /// <p>2014-09-09</p></li>
    /// <li>
    /// <p>2014-09-09-Holiday</p></li>
    /// </ul>
    pub fn get_prefix(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_prefix()
    }
    /// <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
    /// <ul>
    /// <li>
    /// <p><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p></li>
    /// <li>
    /// <p><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p></li>
    /// </ul>
    /// <p>Results are sorted by <code>FilterVariable</code>.</p>
    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
        self.inner = self.inner.sort_order(input);
        self
    }
    /// <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
    /// <ul>
    /// <li>
    /// <p><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p></li>
    /// <li>
    /// <p><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p></li>
    /// </ul>
    /// <p>Results are sorted by <code>FilterVariable</code>.</p>
    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
        self.inner = self.inner.set_sort_order(input);
        self
    }
    /// <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
    /// <ul>
    /// <li>
    /// <p><code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p></li>
    /// <li>
    /// <p><code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p></li>
    /// </ul>
    /// <p>Results are sorted by <code>FilterVariable</code>.</p>
    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
        self.inner.get_sort_order()
    }
    /// <p>An ID of the page in the paginated results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>An ID of the page in the paginated results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>An ID of the page in the paginated results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
    pub fn limit(mut self, input: i32) -> Self {
        self.inner = self.inner.limit(input);
        self
    }
    /// <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
    pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_limit(input);
        self
    }
    /// <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
    pub fn get_limit(&self) -> &::std::option::Option<i32> {
        self.inner.get_limit()
    }
}