aws_sdk_ec2/operation/describe_capacity_blocks/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_capacity_blocks::_describe_capacity_blocks_output::DescribeCapacityBlocksOutputBuilder;

pub use crate::operation::describe_capacity_blocks::_describe_capacity_blocks_input::DescribeCapacityBlocksInputBuilder;

impl crate::operation::describe_capacity_blocks::builders::DescribeCapacityBlocksInputBuilder {
    /// 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_capacity_blocks::DescribeCapacityBlocksOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_capacity_blocks::DescribeCapacityBlocksError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_capacity_blocks();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeCapacityBlocks`.
///
/// <p>Describes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeCapacityBlocksFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_capacity_blocks::builders::DescribeCapacityBlocksInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_capacity_blocks::DescribeCapacityBlocksOutput,
        crate::operation::describe_capacity_blocks::DescribeCapacityBlocksError,
    > for DescribeCapacityBlocksFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_capacity_blocks::DescribeCapacityBlocksOutput,
            crate::operation::describe_capacity_blocks::DescribeCapacityBlocksError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeCapacityBlocksFluentBuilder {
    /// Creates a new `DescribeCapacityBlocksFluentBuilder`.
    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 DescribeCapacityBlocks as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_capacity_blocks::builders::DescribeCapacityBlocksInputBuilder {
        &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_capacity_blocks::DescribeCapacityBlocksOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_capacity_blocks::DescribeCapacityBlocksError,
            ::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_capacity_blocks::DescribeCapacityBlocks::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_capacity_blocks::DescribeCapacityBlocks::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_capacity_blocks::DescribeCapacityBlocksOutput,
        crate::operation::describe_capacity_blocks::DescribeCapacityBlocksError,
        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_capacity_blocks::paginator::DescribeCapacityBlocksPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_capacity_blocks::paginator::DescribeCapacityBlocksPaginator {
        crate::operation::describe_capacity_blocks::paginator::DescribeCapacityBlocksPaginator::new(self.handle, self.inner)
    }
    ///
    /// Appends an item to `CapacityBlockIds`.
    ///
    /// To override the contents of this collection use [`set_capacity_block_ids`](Self::set_capacity_block_ids).
    ///
    /// <p>The IDs of the Capacity Blocks.</p>
    pub fn capacity_block_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.capacity_block_ids(input.into());
        self
    }
    /// <p>The IDs of the Capacity Blocks.</p>
    pub fn set_capacity_block_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_capacity_block_ids(input);
        self
    }
    /// <p>The IDs of the Capacity Blocks.</p>
    pub fn get_capacity_block_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_capacity_block_ids()
    }
    /// <p>The token to use to retrieve the next page of 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>The token to use to retrieve the next page of 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>The token to use to retrieve the next page of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    ///
    /// Appends an item to `Filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
    /// <li>
    /// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
    /// <li>
    /// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
    /// <li>
    /// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
    /// <li>
    /// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
    /// <li>
    /// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
    /// </ul>
    pub fn filters(mut self, input: crate::types::Filter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
    /// <li>
    /// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
    /// <li>
    /// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
    /// <li>
    /// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
    /// <li>
    /// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
    /// <li>
    /// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
    /// </ul>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
        self.inner = self.inner.set_filters(input);
        self
    }
    /// <p>One or more filters.</p>
    /// <ul>
    /// <li>
    /// <p><code>capacity-block-id</code> - The ID of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>ultraserver-type</code> - The Capacity Block type. The type can be <code>instances</code> or <code>ultraservers</code>.</p></li>
    /// <li>
    /// <p><code>availability-zone</code> - The Availability Zone of the Capacity Block.</p></li>
    /// <li>
    /// <p><code>start-date</code> - The date and time at which the Capacity Block was started.</p></li>
    /// <li>
    /// <p><code>end-date</code> - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.</p></li>
    /// <li>
    /// <p><code>create-date</code> - The date and time at which the Capacity Block was created.</p></li>
    /// <li>
    /// <p><code>state</code> - The state of the Capacity Block (<code>active</code> | <code>expired</code> | <code>unavailable</code> | <code>cancelled</code> | <code>failed</code> | <code>scheduled</code> | <code>payment-pending</code> | <code>payment-failed</code>).</p></li>
    /// <li>
    /// <p><code>tags</code> - The tags assigned to the Capacity Block.</p></li>
    /// </ul>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
        self.inner.get_filters()
    }
    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
    pub fn dry_run(mut self, input: bool) -> Self {
        self.inner = self.inner.dry_run(input);
        self
    }
    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_dry_run(input);
        self
    }
    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
        self.inner.get_dry_run()
    }
}