aws_sdk_backup/operation/list_backup_jobs/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_backup_jobs::_list_backup_jobs_output::ListBackupJobsOutputBuilder;

pub use crate::operation::list_backup_jobs::_list_backup_jobs_input::ListBackupJobsInputBuilder;

impl crate::operation::list_backup_jobs::builders::ListBackupJobsInputBuilder {
    /// 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_backup_jobs::ListBackupJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_backup_jobs::ListBackupJobsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_backup_jobs();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListBackupJobs`.
///
/// <p>Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">monitoring tools</a>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListBackupJobsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_backup_jobs::builders::ListBackupJobsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_backup_jobs::ListBackupJobsOutput,
        crate::operation::list_backup_jobs::ListBackupJobsError,
    > for ListBackupJobsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_backup_jobs::ListBackupJobsOutput,
            crate::operation::list_backup_jobs::ListBackupJobsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListBackupJobsFluentBuilder {
    /// Creates a new `ListBackupJobsFluentBuilder`.
    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 ListBackupJobs as a reference.
    pub fn as_input(&self) -> &crate::operation::list_backup_jobs::builders::ListBackupJobsInputBuilder {
        &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_backup_jobs::ListBackupJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_backup_jobs::ListBackupJobsError,
            ::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_backup_jobs::ListBackupJobs::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_backup_jobs::ListBackupJobs::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_backup_jobs::ListBackupJobsOutput,
        crate::operation::list_backup_jobs::ListBackupJobsError,
        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_backup_jobs::paginator::ListBackupJobsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_backup_jobs::paginator::ListBackupJobsPaginator {
        crate::operation::list_backup_jobs::paginator::ListBackupJobsPaginator::new(self.handle, self.inner)
    }
    /// <p>The next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</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 next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</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 next item following a partial list of returned items. For example, if a request is made to return <code>MaxResults</code> number of items, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</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 be returned.</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 be returned.</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 be returned.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <p>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</p>
    pub fn by_resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_resource_arn(input.into());
        self
    }
    /// <p>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</p>
    pub fn set_by_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_resource_arn(input);
        self
    }
    /// <p>Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).</p>
    pub fn get_by_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_resource_arn()
    }
    /// <p>Returns only backup jobs that are in the specified state.</p>
    /// <p><code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message.</p>
    /// <p>To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p>
    /// <p>GET /backup-jobs/?state=COMPLETED</p>
    /// <p>GET /backup-jobs/?messageCategory=SUCCESS&amp;state=COMPLETED</p>
    pub fn by_state(mut self, input: crate::types::BackupJobState) -> Self {
        self.inner = self.inner.by_state(input);
        self
    }
    /// <p>Returns only backup jobs that are in the specified state.</p>
    /// <p><code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message.</p>
    /// <p>To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p>
    /// <p>GET /backup-jobs/?state=COMPLETED</p>
    /// <p>GET /backup-jobs/?messageCategory=SUCCESS&amp;state=COMPLETED</p>
    pub fn set_by_state(mut self, input: ::std::option::Option<crate::types::BackupJobState>) -> Self {
        self.inner = self.inner.set_by_state(input);
        self
    }
    /// <p>Returns only backup jobs that are in the specified state.</p>
    /// <p><code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message.</p>
    /// <p>To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p>
    /// <p>GET /backup-jobs/?state=COMPLETED</p>
    /// <p>GET /backup-jobs/?messageCategory=SUCCESS&amp;state=COMPLETED</p>
    pub fn get_by_state(&self) -> &::std::option::Option<crate::types::BackupJobState> {
        self.inner.get_by_state()
    }
    /// <p>Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
    pub fn by_backup_vault_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_backup_vault_name(input.into());
        self
    }
    /// <p>Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
    pub fn set_by_backup_vault_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_backup_vault_name(input);
        self
    }
    /// <p>Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.</p>
    pub fn get_by_backup_vault_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_backup_vault_name()
    }
    /// <p>Returns only backup jobs that were created before the specified date.</p>
    pub fn by_created_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.by_created_before(input);
        self
    }
    /// <p>Returns only backup jobs that were created before the specified date.</p>
    pub fn set_by_created_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_by_created_before(input);
        self
    }
    /// <p>Returns only backup jobs that were created before the specified date.</p>
    pub fn get_by_created_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_by_created_before()
    }
    /// <p>Returns only backup jobs that were created after the specified date.</p>
    pub fn by_created_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.by_created_after(input);
        self
    }
    /// <p>Returns only backup jobs that were created after the specified date.</p>
    pub fn set_by_created_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_by_created_after(input);
        self
    }
    /// <p>Returns only backup jobs that were created after the specified date.</p>
    pub fn get_by_created_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_by_created_after()
    }
    /// <p>Returns only backup jobs for the specified resources:</p>
    /// <ul>
    /// <li>
    /// <p><code>Aurora</code> for Amazon Aurora</p></li>
    /// <li>
    /// <p><code>CloudFormation</code> for CloudFormation</p></li>
    /// <li>
    /// <p><code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p></li>
    /// <li>
    /// <p><code>DynamoDB</code> for Amazon DynamoDB</p></li>
    /// <li>
    /// <p><code>EBS</code> for Amazon Elastic Block Store</p></li>
    /// <li>
    /// <p><code>EC2</code> for Amazon Elastic Compute Cloud</p></li>
    /// <li>
    /// <p><code>EFS</code> for Amazon Elastic File System</p></li>
    /// <li>
    /// <p><code>FSx</code> for Amazon FSx</p></li>
    /// <li>
    /// <p><code>Neptune</code> for Amazon Neptune</p></li>
    /// <li>
    /// <p><code>RDS</code> for Amazon Relational Database Service</p></li>
    /// <li>
    /// <p><code>Redshift</code> for Amazon Redshift</p></li>
    /// <li>
    /// <p><code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// <li>
    /// <p><code>SAP HANA on Amazon EC2</code> for SAP HANA databases on Amazon Elastic Compute Cloud instances</p></li>
    /// <li>
    /// <p><code>Storage Gateway</code> for Storage Gateway</p></li>
    /// <li>
    /// <p><code>Timestream</code> for Amazon Timestream</p></li>
    /// <li>
    /// <p><code>VirtualMachine</code> for VMware virtual machines</p></li>
    /// </ul>
    pub fn by_resource_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_resource_type(input.into());
        self
    }
    /// <p>Returns only backup jobs for the specified resources:</p>
    /// <ul>
    /// <li>
    /// <p><code>Aurora</code> for Amazon Aurora</p></li>
    /// <li>
    /// <p><code>CloudFormation</code> for CloudFormation</p></li>
    /// <li>
    /// <p><code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p></li>
    /// <li>
    /// <p><code>DynamoDB</code> for Amazon DynamoDB</p></li>
    /// <li>
    /// <p><code>EBS</code> for Amazon Elastic Block Store</p></li>
    /// <li>
    /// <p><code>EC2</code> for Amazon Elastic Compute Cloud</p></li>
    /// <li>
    /// <p><code>EFS</code> for Amazon Elastic File System</p></li>
    /// <li>
    /// <p><code>FSx</code> for Amazon FSx</p></li>
    /// <li>
    /// <p><code>Neptune</code> for Amazon Neptune</p></li>
    /// <li>
    /// <p><code>RDS</code> for Amazon Relational Database Service</p></li>
    /// <li>
    /// <p><code>Redshift</code> for Amazon Redshift</p></li>
    /// <li>
    /// <p><code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// <li>
    /// <p><code>SAP HANA on Amazon EC2</code> for SAP HANA databases on Amazon Elastic Compute Cloud instances</p></li>
    /// <li>
    /// <p><code>Storage Gateway</code> for Storage Gateway</p></li>
    /// <li>
    /// <p><code>Timestream</code> for Amazon Timestream</p></li>
    /// <li>
    /// <p><code>VirtualMachine</code> for VMware virtual machines</p></li>
    /// </ul>
    pub fn set_by_resource_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_resource_type(input);
        self
    }
    /// <p>Returns only backup jobs for the specified resources:</p>
    /// <ul>
    /// <li>
    /// <p><code>Aurora</code> for Amazon Aurora</p></li>
    /// <li>
    /// <p><code>CloudFormation</code> for CloudFormation</p></li>
    /// <li>
    /// <p><code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p></li>
    /// <li>
    /// <p><code>DynamoDB</code> for Amazon DynamoDB</p></li>
    /// <li>
    /// <p><code>EBS</code> for Amazon Elastic Block Store</p></li>
    /// <li>
    /// <p><code>EC2</code> for Amazon Elastic Compute Cloud</p></li>
    /// <li>
    /// <p><code>EFS</code> for Amazon Elastic File System</p></li>
    /// <li>
    /// <p><code>FSx</code> for Amazon FSx</p></li>
    /// <li>
    /// <p><code>Neptune</code> for Amazon Neptune</p></li>
    /// <li>
    /// <p><code>RDS</code> for Amazon Relational Database Service</p></li>
    /// <li>
    /// <p><code>Redshift</code> for Amazon Redshift</p></li>
    /// <li>
    /// <p><code>S3</code> for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// <li>
    /// <p><code>SAP HANA on Amazon EC2</code> for SAP HANA databases on Amazon Elastic Compute Cloud instances</p></li>
    /// <li>
    /// <p><code>Storage Gateway</code> for Storage Gateway</p></li>
    /// <li>
    /// <p><code>Timestream</code> for Amazon Timestream</p></li>
    /// <li>
    /// <p><code>VirtualMachine</code> for VMware virtual machines</p></li>
    /// </ul>
    pub fn get_by_resource_type(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_resource_type()
    }
    /// <p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p>
    /// <p>If used from an Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    pub fn by_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_account_id(input.into());
        self
    }
    /// <p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p>
    /// <p>If used from an Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    pub fn set_by_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_account_id(input);
        self
    }
    /// <p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p>
    /// <p>If used from an Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    pub fn get_by_account_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_account_id()
    }
    /// <p>Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn by_complete_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.by_complete_after(input);
        self
    }
    /// <p>Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn set_by_complete_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_by_complete_after(input);
        self
    }
    /// <p>Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn get_by_complete_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_by_complete_after()
    }
    /// <p>Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn by_complete_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.by_complete_before(input);
        self
    }
    /// <p>Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn set_by_complete_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_by_complete_before(input);
        self
    }
    /// <p>Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).</p>
    pub fn get_by_complete_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_by_complete_before()
    }
    /// <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
    pub fn by_parent_job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_parent_job_id(input.into());
        self
    }
    /// <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
    pub fn set_by_parent_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_parent_job_id(input);
        self
    }
    /// <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
    pub fn get_by_parent_job_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_parent_job_id()
    }
    /// <p>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</p>
    /// <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>InvalidParameters</code>.</p>
    /// <p>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a></p>
    /// <p>The wildcard () returns count of all message categories.</p>
    /// <p><code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p>
    pub fn by_message_category(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_message_category(input.into());
        self
    }
    /// <p>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</p>
    /// <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>InvalidParameters</code>.</p>
    /// <p>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a></p>
    /// <p>The wildcard () returns count of all message categories.</p>
    /// <p><code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p>
    pub fn set_by_message_category(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_message_category(input);
        self
    }
    /// <p>This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.</p>
    /// <p>Example strings may include <code>AccessDenied</code>, <code>SUCCESS</code>, <code>AGGREGATE_ALL</code>, and <code>InvalidParameters</code>.</p>
    /// <p>View <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a></p>
    /// <p>The wildcard () returns count of all message categories.</p>
    /// <p><code>AGGREGATE_ALL</code> aggregates job counts for all message categories and returns the sum.</p>
    pub fn get_by_message_category(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_message_category()
    }
}