aws_sdk_rds/operation/describe_db_snapshot_tenant_databases/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::describe_db_snapshot_tenant_databases::_describe_db_snapshot_tenant_databases_output::DescribeDbSnapshotTenantDatabasesOutputBuilder;

pub use crate::operation::describe_db_snapshot_tenant_databases::_describe_db_snapshot_tenant_databases_input::DescribeDbSnapshotTenantDatabasesInputBuilder;

impl crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDbSnapshotTenantDatabasesInputBuilder {
    /// 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_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.describe_db_snapshot_tenant_databases();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `DescribeDBSnapshotTenantDatabases`.
///
/// <p>Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.</p>
/// <p>You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct DescribeDBSnapshotTenantDatabasesFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDbSnapshotTenantDatabasesInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::describe_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput,
        crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError,
    > for DescribeDBSnapshotTenantDatabasesFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::describe_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput,
            crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl DescribeDBSnapshotTenantDatabasesFluentBuilder {
    /// Creates a new `DescribeDBSnapshotTenantDatabasesFluentBuilder`.
    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 DescribeDBSnapshotTenantDatabases as a reference.
    pub fn as_input(&self) -> &crate::operation::describe_db_snapshot_tenant_databases::builders::DescribeDbSnapshotTenantDatabasesInputBuilder {
        &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_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError,
            ::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_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabases::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabases::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_db_snapshot_tenant_databases::DescribeDbSnapshotTenantDatabasesOutput,
        crate::operation::describe_db_snapshot_tenant_databases::DescribeDBSnapshotTenantDatabasesError,
        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_db_snapshot_tenant_databases::paginator::DescribeDbSnapshotTenantDatabasesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::describe_db_snapshot_tenant_databases::paginator::DescribeDbSnapshotTenantDatabasesPaginator {
        crate::operation::describe_db_snapshot_tenant_databases::paginator::DescribeDbSnapshotTenantDatabasesPaginator::new(self.handle, self.inner)
    }
    /// <p>The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If supplied, must match the identifier of an existing <code>DBInstance</code>.</p></li>
    /// </ul>
    pub fn db_instance_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.db_instance_identifier(input.into());
        self
    }
    /// <p>The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If supplied, must match the identifier of an existing <code>DBInstance</code>.</p></li>
    /// </ul>
    pub fn set_db_instance_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_db_instance_identifier(input);
        self
    }
    /// <p>The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If supplied, must match the identifier of an existing <code>DBInstance</code>.</p></li>
    /// </ul>
    pub fn get_db_instance_identifier(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_db_instance_identifier()
    }
    /// <p>The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify this parameter, the value must match the ID of an existing DB snapshot.</p></li>
    /// <li>
    /// <p>If you specify an automatic snapshot, you must also specify <code>SnapshotType</code>.</p></li>
    /// </ul>
    pub fn db_snapshot_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.db_snapshot_identifier(input.into());
        self
    }
    /// <p>The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify this parameter, the value must match the ID of an existing DB snapshot.</p></li>
    /// <li>
    /// <p>If you specify an automatic snapshot, you must also specify <code>SnapshotType</code>.</p></li>
    /// </ul>
    pub fn set_db_snapshot_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_db_snapshot_identifier(input);
        self
    }
    /// <p>The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string.</p>
    /// <p>Constraints:</p>
    /// <ul>
    /// <li>
    /// <p>If you specify this parameter, the value must match the ID of an existing DB snapshot.</p></li>
    /// <li>
    /// <p>If you specify an automatic snapshot, you must also specify <code>SnapshotType</code>.</p></li>
    /// </ul>
    pub fn get_db_snapshot_identifier(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_db_snapshot_identifier()
    }
    /// <p>The type of DB snapshots to be returned. You can specify one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>automated</code> – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>manual</code> – All DB snapshots that have been taken by my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>shared</code> – All manual DB snapshots that have been shared to my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>public</code> – All DB snapshots that have been marked as public.</p></li>
    /// <li>
    /// <p><code>awsbackup</code> – All DB snapshots managed by the Amazon Web Services Backup service.</p></li>
    /// </ul>
    pub fn snapshot_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.snapshot_type(input.into());
        self
    }
    /// <p>The type of DB snapshots to be returned. You can specify one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>automated</code> – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>manual</code> – All DB snapshots that have been taken by my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>shared</code> – All manual DB snapshots that have been shared to my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>public</code> – All DB snapshots that have been marked as public.</p></li>
    /// <li>
    /// <p><code>awsbackup</code> – All DB snapshots managed by the Amazon Web Services Backup service.</p></li>
    /// </ul>
    pub fn set_snapshot_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_snapshot_type(input);
        self
    }
    /// <p>The type of DB snapshots to be returned. You can specify one of the following values:</p>
    /// <ul>
    /// <li>
    /// <p><code>automated</code> – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>manual</code> – All DB snapshots that have been taken by my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>shared</code> – All manual DB snapshots that have been shared to my Amazon Web Services account.</p></li>
    /// <li>
    /// <p><code>public</code> – All DB snapshots that have been marked as public.</p></li>
    /// <li>
    /// <p><code>awsbackup</code> – All DB snapshots managed by the Amazon Web Services Backup service.</p></li>
    /// </ul>
    pub fn get_snapshot_type(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_snapshot_type()
    }
    ///
    /// Appends an item to `Filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>A filter that specifies one or more tenant databases to describe.</p>
    /// <p>Supported filters:</p>
    /// <ul>
    /// <li>
    /// <p><code>tenant-db-name</code> - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.</p></li>
    /// <li>
    /// <p><code>tenant-database-resource-id</code> - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.</p></li>
    /// <li>
    /// <p><code>dbi-resource-id</code> - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.</p></li>
    /// <li>
    /// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).</p></li>
    /// <li>
    /// <p><code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p></li>
    /// <li>
    /// <p><code>snapshot-type</code> - Accepts types of DB snapshots.</p></li>
    /// </ul>
    pub fn filters(mut self, input: crate::types::Filter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>A filter that specifies one or more tenant databases to describe.</p>
    /// <p>Supported filters:</p>
    /// <ul>
    /// <li>
    /// <p><code>tenant-db-name</code> - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.</p></li>
    /// <li>
    /// <p><code>tenant-database-resource-id</code> - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.</p></li>
    /// <li>
    /// <p><code>dbi-resource-id</code> - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.</p></li>
    /// <li>
    /// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).</p></li>
    /// <li>
    /// <p><code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p></li>
    /// <li>
    /// <p><code>snapshot-type</code> - Accepts types of DB snapshots.</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>A filter that specifies one or more tenant databases to describe.</p>
    /// <p>Supported filters:</p>
    /// <ul>
    /// <li>
    /// <p><code>tenant-db-name</code> - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.</p></li>
    /// <li>
    /// <p><code>tenant-database-resource-id</code> - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots.</p></li>
    /// <li>
    /// <p><code>dbi-resource-id</code> - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers.</p></li>
    /// <li>
    /// <p><code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).</p></li>
    /// <li>
    /// <p><code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p></li>
    /// <li>
    /// <p><code>snapshot-type</code> - Accepts types of DB snapshots.</p></li>
    /// </ul>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
        self.inner.get_filters()
    }
    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
    pub fn max_records(mut self, input: i32) -> Self {
        self.inner = self.inner.max_records(input);
        self
    }
    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_records(input);
        self
    }
    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p>
    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_records()
    }
    /// <p>An optional pagination token provided by a previous <code>DescribeDBSnapshotTenantDatabases</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.marker(input.into());
        self
    }
    /// <p>An optional pagination token provided by a previous <code>DescribeDBSnapshotTenantDatabases</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_marker(input);
        self
    }
    /// <p>An optional pagination token provided by a previous <code>DescribeDBSnapshotTenantDatabases</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_marker()
    }
    /// <p>A specific DB resource identifier to describe.</p>
    pub fn dbi_resource_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.dbi_resource_id(input.into());
        self
    }
    /// <p>A specific DB resource identifier to describe.</p>
    pub fn set_dbi_resource_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_dbi_resource_id(input);
        self
    }
    /// <p>A specific DB resource identifier to describe.</p>
    pub fn get_dbi_resource_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_dbi_resource_id()
    }
}