aws_sdk_codedeploy/operation/list_deployments/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_deployments::_list_deployments_output::ListDeploymentsOutputBuilder;

pub use crate::operation::list_deployments::_list_deployments_input::ListDeploymentsInputBuilder;

impl crate::operation::list_deployments::builders::ListDeploymentsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::list_deployments::ListDeploymentsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_deployments::ListDeploymentsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_deployments();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListDeployments`.
///
/// <p>Lists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListDeploymentsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_deployments::builders::ListDeploymentsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_deployments::ListDeploymentsOutput,
        crate::operation::list_deployments::ListDeploymentsError,
    > for ListDeploymentsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_deployments::ListDeploymentsOutput,
            crate::operation::list_deployments::ListDeploymentsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListDeploymentsFluentBuilder {
    /// Creates a new `ListDeploymentsFluentBuilder`.
    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 ListDeployments as a reference.
    pub fn as_input(&self) -> &crate::operation::list_deployments::builders::ListDeploymentsInputBuilder {
        &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::list_deployments::ListDeploymentsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_deployments::ListDeploymentsError,
            ::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::list_deployments::ListDeployments::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_deployments::ListDeployments::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::list_deployments::ListDeploymentsOutput,
        crate::operation::list_deployments::ListDeploymentsError,
        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::list_deployments::paginator::ListDeploymentsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_deployments::paginator::ListDeploymentsPaginator {
        crate::operation::list_deployments::paginator::ListDeploymentsPaginator::new(self.handle, self.inner)
    }
    /// <p>The name of an CodeDeploy application associated with the user or Amazon Web Services account.</p><note>
    /// <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified.</p>
    /// </note>
    pub fn application_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.application_name(input.into());
        self
    }
    /// <p>The name of an CodeDeploy application associated with the user or Amazon Web Services account.</p><note>
    /// <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified.</p>
    /// </note>
    pub fn set_application_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_application_name(input);
        self
    }
    /// <p>The name of an CodeDeploy application associated with the user or Amazon Web Services account.</p><note>
    /// <p>If <code>applicationName</code> is specified, then <code>deploymentGroupName</code> must be specified. If it is not specified, then <code>deploymentGroupName</code> must not be specified.</p>
    /// </note>
    pub fn get_application_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_application_name()
    }
    /// <p>The name of a deployment group for the specified application.</p><note>
    /// <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified.</p>
    /// </note>
    pub fn deployment_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.deployment_group_name(input.into());
        self
    }
    /// <p>The name of a deployment group for the specified application.</p><note>
    /// <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified.</p>
    /// </note>
    pub fn set_deployment_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_deployment_group_name(input);
        self
    }
    /// <p>The name of a deployment group for the specified application.</p><note>
    /// <p>If <code>deploymentGroupName</code> is specified, then <code>applicationName</code> must be specified. If it is not specified, then <code>applicationName</code> must not be specified.</p>
    /// </note>
    pub fn get_deployment_group_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_deployment_group_name()
    }
    /// <p>The unique ID of an external resource for returning deployments linked to the external resource.</p>
    pub fn external_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.external_id(input.into());
        self
    }
    /// <p>The unique ID of an external resource for returning deployments linked to the external resource.</p>
    pub fn set_external_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_external_id(input);
        self
    }
    /// <p>The unique ID of an external resource for returning deployments linked to the external resource.</p>
    pub fn get_external_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_external_id()
    }
    ///
    /// Appends an item to `includeOnlyStatuses`.
    ///
    /// To override the contents of this collection use [`set_include_only_statuses`](Self::set_include_only_statuses).
    ///
    /// <p>A subset of deployments to list by status:</p>
    /// <ul>
    /// <li>
    /// <p><code>Created</code>: Include created deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Queued</code>: Include queued deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>In Progress</code>: Include in-progress deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Succeeded</code>: Include successful deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Failed</code>: Include failed deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Stopped</code>: Include stopped deployments in the resulting list.</p></li>
    /// </ul>
    pub fn include_only_statuses(mut self, input: crate::types::DeploymentStatus) -> Self {
        self.inner = self.inner.include_only_statuses(input);
        self
    }
    /// <p>A subset of deployments to list by status:</p>
    /// <ul>
    /// <li>
    /// <p><code>Created</code>: Include created deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Queued</code>: Include queued deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>In Progress</code>: Include in-progress deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Succeeded</code>: Include successful deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Failed</code>: Include failed deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Stopped</code>: Include stopped deployments in the resulting list.</p></li>
    /// </ul>
    pub fn set_include_only_statuses(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DeploymentStatus>>) -> Self {
        self.inner = self.inner.set_include_only_statuses(input);
        self
    }
    /// <p>A subset of deployments to list by status:</p>
    /// <ul>
    /// <li>
    /// <p><code>Created</code>: Include created deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Queued</code>: Include queued deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>In Progress</code>: Include in-progress deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Succeeded</code>: Include successful deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Failed</code>: Include failed deployments in the resulting list.</p></li>
    /// <li>
    /// <p><code>Stopped</code>: Include stopped deployments in the resulting list.</p></li>
    /// </ul>
    pub fn get_include_only_statuses(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DeploymentStatus>> {
        self.inner.get_include_only_statuses()
    }
    /// <p>A time range (start and end) for returning a subset of the list of deployments.</p>
    pub fn create_time_range(mut self, input: crate::types::TimeRange) -> Self {
        self.inner = self.inner.create_time_range(input);
        self
    }
    /// <p>A time range (start and end) for returning a subset of the list of deployments.</p>
    pub fn set_create_time_range(mut self, input: ::std::option::Option<crate::types::TimeRange>) -> Self {
        self.inner = self.inner.set_create_time_range(input);
        self
    }
    /// <p>A time range (start and end) for returning a subset of the list of deployments.</p>
    pub fn get_create_time_range(&self) -> &::std::option::Option<crate::types::TimeRange> {
        self.inner.get_create_time_range()
    }
    /// <p>An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</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 identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</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 identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
}