aws_sdk_backup/operation/list_scan_jobs/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_scan_jobs::_list_scan_jobs_output::ListScanJobsOutputBuilder;

pub use crate::operation::list_scan_jobs::_list_scan_jobs_input::ListScanJobsInputBuilder;

impl crate::operation::list_scan_jobs::builders::ListScanJobsInputBuilder {
    /// 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_scan_jobs::ListScanJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_scan_jobs::ListScanJobsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_scan_jobs();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListScanJobs`.
///
/// <p>Returns a list of existing scan jobs for an authenticated account for the last 30 days.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListScanJobsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_scan_jobs::builders::ListScanJobsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_scan_jobs::ListScanJobsOutput,
        crate::operation::list_scan_jobs::ListScanJobsError,
    > for ListScanJobsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_scan_jobs::ListScanJobsOutput,
            crate::operation::list_scan_jobs::ListScanJobsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListScanJobsFluentBuilder {
    /// Creates a new `ListScanJobsFluentBuilder`.
    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 ListScanJobs as a reference.
    pub fn as_input(&self) -> &crate::operation::list_scan_jobs::builders::ListScanJobsInputBuilder {
        &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_scan_jobs::ListScanJobsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_scan_jobs::ListScanJobsError,
            ::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_scan_jobs::ListScanJobs::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_scan_jobs::ListScanJobs::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_scan_jobs::ListScanJobsOutput,
        crate::operation::list_scan_jobs::ListScanJobsError,
        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_scan_jobs::paginator::ListScanJobsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_scan_jobs::paginator::ListScanJobsPaginator {
        crate::operation::list_scan_jobs::paginator::ListScanJobsPaginator::new(self.handle, self.inner)
    }
    /// <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 Amazon Web Services Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    /// <p>Pattern: <code>^\[0-9\]{12}$</code></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 Amazon Web Services Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    /// <p>Pattern: <code>^\[0-9\]{12}$</code></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 Amazon Web Services Organizations management account, passing <code>*</code> returns all jobs across the organization.</p>
    /// <p>Pattern: <code>^\[0-9\]{12}$</code></p>
    pub fn get_by_account_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_account_id()
    }
    /// <p>Returns only scan 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>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{2,50}$</code></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 scan 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>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{2,50}$</code></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 scan 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>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{2,50}$</code></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 scan 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 scan 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 scan 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>Returns only the scan jobs for the specified malware scanner. Currently only supports <code>GUARDDUTY</code>.</p>
    pub fn by_malware_scanner(mut self, input: crate::types::MalwareScanner) -> Self {
        self.inner = self.inner.by_malware_scanner(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified malware scanner. Currently only supports <code>GUARDDUTY</code>.</p>
    pub fn set_by_malware_scanner(mut self, input: ::std::option::Option<crate::types::MalwareScanner>) -> Self {
        self.inner = self.inner.set_by_malware_scanner(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified malware scanner. Currently only supports <code>GUARDDUTY</code>.</p>
    pub fn get_by_malware_scanner(&self) -> &::std::option::Option<crate::types::MalwareScanner> {
        self.inner.get_by_malware_scanner()
    }
    /// <p>Returns only the scan jobs that are ran against the specified recovery point.</p>
    pub fn by_recovery_point_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.by_recovery_point_arn(input.into());
        self
    }
    /// <p>Returns only the scan jobs that are ran against the specified recovery point.</p>
    pub fn set_by_recovery_point_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_by_recovery_point_arn(input);
        self
    }
    /// <p>Returns only the scan jobs that are ran against the specified recovery point.</p>
    pub fn get_by_recovery_point_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_by_recovery_point_arn()
    }
    /// <p>Returns only scan 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 scan 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 scan 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 restore testing selections by the specified restore testing plan name.</p>
    /// <ul>
    /// <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>S3</code>for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// </ul>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{1,50}$</code></p>
    pub fn by_resource_type(mut self, input: crate::types::ScanResourceType) -> Self {
        self.inner = self.inner.by_resource_type(input);
        self
    }
    /// <p>Returns restore testing selections by the specified restore testing plan name.</p>
    /// <ul>
    /// <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>S3</code>for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// </ul>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{1,50}$</code></p>
    pub fn set_by_resource_type(mut self, input: ::std::option::Option<crate::types::ScanResourceType>) -> Self {
        self.inner = self.inner.set_by_resource_type(input);
        self
    }
    /// <p>Returns restore testing selections by the specified restore testing plan name.</p>
    /// <ul>
    /// <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>S3</code>for Amazon Simple Storage Service (Amazon S3)</p></li>
    /// </ul>
    /// <p>Pattern: <code>^\[a-zA-Z0-9\-\_\.\]{1,50}$</code></p>
    pub fn get_by_resource_type(&self) -> &::std::option::Option<crate::types::ScanResourceType> {
        self.inner.get_by_resource_type()
    }
    /// <p>Returns only the scan jobs for the specified scan results:</p>
    /// <ul>
    /// <li>
    /// <p><code>THREATS_FOUND</code></p></li>
    /// <li>
    /// <p><code>NO_THREATS_FOUND</code></p></li>
    /// </ul>
    pub fn by_scan_result_status(mut self, input: crate::types::ScanResultStatus) -> Self {
        self.inner = self.inner.by_scan_result_status(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified scan results:</p>
    /// <ul>
    /// <li>
    /// <p><code>THREATS_FOUND</code></p></li>
    /// <li>
    /// <p><code>NO_THREATS_FOUND</code></p></li>
    /// </ul>
    pub fn set_by_scan_result_status(mut self, input: ::std::option::Option<crate::types::ScanResultStatus>) -> Self {
        self.inner = self.inner.set_by_scan_result_status(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified scan results:</p>
    /// <ul>
    /// <li>
    /// <p><code>THREATS_FOUND</code></p></li>
    /// <li>
    /// <p><code>NO_THREATS_FOUND</code></p></li>
    /// </ul>
    pub fn get_by_scan_result_status(&self) -> &::std::option::Option<crate::types::ScanResultStatus> {
        self.inner.get_by_scan_result_status()
    }
    /// <p>Returns only the scan jobs for the specified scanning job state.</p>
    pub fn by_state(mut self, input: crate::types::ScanState) -> Self {
        self.inner = self.inner.by_state(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified scanning job state.</p>
    pub fn set_by_state(mut self, input: ::std::option::Option<crate::types::ScanState>) -> Self {
        self.inner = self.inner.set_by_state(input);
        self
    }
    /// <p>Returns only the scan jobs for the specified scanning job state.</p>
    pub fn get_by_state(&self) -> &::std::option::Option<crate::types::ScanState> {
        self.inner.get_by_state()
    }
    /// <p>The maximum number of items to be returned.</p>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 1000.</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>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 1000.</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>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 1000.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <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()
    }
}