aws_sdk_pi/operation/get_dimension_key_details/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_dimension_key_details::_get_dimension_key_details_output::GetDimensionKeyDetailsOutputBuilder;

pub use crate::operation::get_dimension_key_details::_get_dimension_key_details_input::GetDimensionKeyDetailsInputBuilder;

impl crate::operation::get_dimension_key_details::builders::GetDimensionKeyDetailsInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::get_dimension_key_details::GetDimensionKeyDetailsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_dimension_key_details::GetDimensionKeyDetailsError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.get_dimension_key_details();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `GetDimensionKeyDetails`.
///
/// <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large SQL statement text, lock snapshots, and execution plans.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetDimensionKeyDetailsFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::get_dimension_key_details::builders::GetDimensionKeyDetailsInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::get_dimension_key_details::GetDimensionKeyDetailsOutput,
        crate::operation::get_dimension_key_details::GetDimensionKeyDetailsError,
    > for GetDimensionKeyDetailsFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::get_dimension_key_details::GetDimensionKeyDetailsOutput,
            crate::operation::get_dimension_key_details::GetDimensionKeyDetailsError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl GetDimensionKeyDetailsFluentBuilder {
    /// Creates a new `GetDimensionKeyDetailsFluentBuilder`.
    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 GetDimensionKeyDetails as a reference.
    pub fn as_input(&self) -> &crate::operation::get_dimension_key_details::builders::GetDimensionKeyDetailsInputBuilder {
        &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::get_dimension_key_details::GetDimensionKeyDetailsOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_dimension_key_details::GetDimensionKeyDetailsError,
            ::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::get_dimension_key_details::GetDimensionKeyDetails::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::get_dimension_key_details::GetDimensionKeyDetails::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::get_dimension_key_details::GetDimensionKeyDetailsOutput,
        crate::operation::get_dimension_key_details::GetDimensionKeyDetailsError,
        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
    }
    /// <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
    pub fn service_type(mut self, input: crate::types::ServiceType) -> Self {
        self.inner = self.inner.service_type(input);
        self
    }
    /// <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
    pub fn set_service_type(mut self, input: ::std::option::Option<crate::types::ServiceType>) -> Self {
        self.inner = self.inner.set_service_type(input);
        self
    }
    /// <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
    pub fn get_service_type(&self) -> &::std::option::Option<crate::types::ServiceType> {
        self.inner.get_service_type()
    }
    /// <p>The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
    pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.identifier(input.into());
        self
    }
    /// <p>The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
    pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_identifier(input);
        self
    }
    /// <p>The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.</p>
    pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_identifier()
    }
    /// <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.query</code> (Amazon DocumentDB only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> (Amazon RDS and Aurora only)</p></li>
    /// </ul>
    pub fn group(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.group(input.into());
        self
    }
    /// <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.query</code> (Amazon DocumentDB only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> (Amazon RDS and Aurora only)</p></li>
    /// </ul>
    pub fn set_group(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_group(input);
        self
    }
    /// <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.query</code> (Amazon DocumentDB only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> (Amazon RDS and Aurora only)</p></li>
    /// </ul>
    pub fn get_group(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_group()
    }
    /// <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p></li>
    /// <li>
    /// <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p></li>
    /// </ul>
    pub fn group_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.group_identifier(input.into());
        self
    }
    /// <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p></li>
    /// <li>
    /// <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p></li>
    /// </ul>
    pub fn set_group_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_group_identifier(input);
        self
    }
    /// <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p></li>
    /// <li>
    /// <p><code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p></li>
    /// <li>
    /// <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p></li>
    /// </ul>
    pub fn get_group_identifier(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_group_identifier()
    }
    ///
    /// Appends an item to `RequestedDimensions`.
    ///
    /// To override the contents of this collection use [`set_requested_dimensions`](Self::set_requested_dimensions).
    ///
    /// <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p></li>
    /// <li>
    /// <p><code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p></li>
    /// </ul>
    pub fn requested_dimensions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.requested_dimensions(input.into());
        self
    }
    /// <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p></li>
    /// <li>
    /// <p><code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p></li>
    /// </ul>
    pub fn set_requested_dimensions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_requested_dimensions(input);
        self
    }
    /// <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
    /// <ul>
    /// <li>
    /// <p><code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p></li>
    /// <li>
    /// <p><code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p></li>
    /// <li>
    /// <p><code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p></li>
    /// <li>
    /// <p><code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p></li>
    /// </ul>
    pub fn get_requested_dimensions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_requested_dimensions()
    }
}