aws-sdk-quicksight 1.122.0

AWS SDK for Amazon QuickSight
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeAnalysisDefinitionOutput {
    /// <p>The ID of the analysis described.</p>
    pub analysis_id: ::std::option::Option<::std::string::String>,
    /// <p>The descriptive name of the analysis.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>Errors associated with the analysis.</p>
    pub errors: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>,
    /// <p>Status associated with the analysis.</p>
    /// <ul>
    /// <li>
    /// <p><code>CREATION_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>CREATION_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>CREATION_FAILED</code></p></li>
    /// <li>
    /// <p><code>UPDATE_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>UPDATE_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>UPDATE_FAILED</code></p></li>
    /// <li>
    /// <p><code>DELETED</code></p></li>
    /// </ul>
    pub resource_status: ::std::option::Option<crate::types::ResourceStatus>,
    /// <p>The ARN of the theme of the analysis.</p>
    pub theme_arn: ::std::option::Option<::std::string::String>,
    /// <p>The definition of an analysis.</p>
    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
    pub definition: ::std::option::Option<crate::types::AnalysisDefinition>,
    /// <p>The HTTP status of the request.</p>
    pub status: i32,
    /// <p>The Amazon Web Services request ID for this operation.</p>
    pub request_id: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl DescribeAnalysisDefinitionOutput {
    /// <p>The ID of the analysis described.</p>
    pub fn analysis_id(&self) -> ::std::option::Option<&str> {
        self.analysis_id.as_deref()
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>Errors associated with the analysis.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.errors.is_none()`.
    pub fn errors(&self) -> &[crate::types::AnalysisError] {
        self.errors.as_deref().unwrap_or_default()
    }
    /// <p>Status associated with the analysis.</p>
    /// <ul>
    /// <li>
    /// <p><code>CREATION_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>CREATION_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>CREATION_FAILED</code></p></li>
    /// <li>
    /// <p><code>UPDATE_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>UPDATE_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>UPDATE_FAILED</code></p></li>
    /// <li>
    /// <p><code>DELETED</code></p></li>
    /// </ul>
    pub fn resource_status(&self) -> ::std::option::Option<&crate::types::ResourceStatus> {
        self.resource_status.as_ref()
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn theme_arn(&self) -> ::std::option::Option<&str> {
        self.theme_arn.as_deref()
    }
    /// <p>The definition of an analysis.</p>
    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
    pub fn definition(&self) -> ::std::option::Option<&crate::types::AnalysisDefinition> {
        self.definition.as_ref()
    }
    /// <p>The HTTP status of the request.</p>
    pub fn status(&self) -> i32 {
        self.status
    }
    /// <p>The Amazon Web Services request ID for this operation.</p>
    pub fn request_id(&self) -> ::std::option::Option<&str> {
        self.request_id.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for DescribeAnalysisDefinitionOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeAnalysisDefinitionOutput {
    /// Creates a new builder-style object to manufacture [`DescribeAnalysisDefinitionOutput`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput).
    pub fn builder() -> crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionOutputBuilder {
        crate::operation::describe_analysis_definition::builders::DescribeAnalysisDefinitionOutputBuilder::default()
    }
}

/// A builder for [`DescribeAnalysisDefinitionOutput`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeAnalysisDefinitionOutputBuilder {
    pub(crate) analysis_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) errors: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>,
    pub(crate) resource_status: ::std::option::Option<crate::types::ResourceStatus>,
    pub(crate) theme_arn: ::std::option::Option<::std::string::String>,
    pub(crate) definition: ::std::option::Option<crate::types::AnalysisDefinition>,
    pub(crate) status: ::std::option::Option<i32>,
    pub(crate) request_id: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl DescribeAnalysisDefinitionOutputBuilder {
    /// <p>The ID of the analysis described.</p>
    pub fn analysis_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.analysis_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the analysis described.</p>
    pub fn set_analysis_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.analysis_id = input;
        self
    }
    /// <p>The ID of the analysis described.</p>
    pub fn get_analysis_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.analysis_id
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The descriptive name of the analysis.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// Appends an item to `errors`.
    ///
    /// To override the contents of this collection use [`set_errors`](Self::set_errors).
    ///
    /// <p>Errors associated with the analysis.</p>
    pub fn errors(mut self, input: crate::types::AnalysisError) -> Self {
        let mut v = self.errors.unwrap_or_default();
        v.push(input);
        self.errors = ::std::option::Option::Some(v);
        self
    }
    /// <p>Errors associated with the analysis.</p>
    pub fn set_errors(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>>) -> Self {
        self.errors = input;
        self
    }
    /// <p>Errors associated with the analysis.</p>
    pub fn get_errors(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AnalysisError>> {
        &self.errors
    }
    /// <p>Status associated with the analysis.</p>
    /// <ul>
    /// <li>
    /// <p><code>CREATION_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>CREATION_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>CREATION_FAILED</code></p></li>
    /// <li>
    /// <p><code>UPDATE_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>UPDATE_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>UPDATE_FAILED</code></p></li>
    /// <li>
    /// <p><code>DELETED</code></p></li>
    /// </ul>
    pub fn resource_status(mut self, input: crate::types::ResourceStatus) -> Self {
        self.resource_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>Status associated with the analysis.</p>
    /// <ul>
    /// <li>
    /// <p><code>CREATION_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>CREATION_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>CREATION_FAILED</code></p></li>
    /// <li>
    /// <p><code>UPDATE_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>UPDATE_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>UPDATE_FAILED</code></p></li>
    /// <li>
    /// <p><code>DELETED</code></p></li>
    /// </ul>
    pub fn set_resource_status(mut self, input: ::std::option::Option<crate::types::ResourceStatus>) -> Self {
        self.resource_status = input;
        self
    }
    /// <p>Status associated with the analysis.</p>
    /// <ul>
    /// <li>
    /// <p><code>CREATION_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>CREATION_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>CREATION_FAILED</code></p></li>
    /// <li>
    /// <p><code>UPDATE_IN_PROGRESS</code></p></li>
    /// <li>
    /// <p><code>UPDATE_SUCCESSFUL</code></p></li>
    /// <li>
    /// <p><code>UPDATE_FAILED</code></p></li>
    /// <li>
    /// <p><code>DELETED</code></p></li>
    /// </ul>
    pub fn get_resource_status(&self) -> &::std::option::Option<crate::types::ResourceStatus> {
        &self.resource_status
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.theme_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.theme_arn = input;
        self
    }
    /// <p>The ARN of the theme of the analysis.</p>
    pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.theme_arn
    }
    /// <p>The definition of an analysis.</p>
    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
    pub fn definition(mut self, input: crate::types::AnalysisDefinition) -> Self {
        self.definition = ::std::option::Option::Some(input);
        self
    }
    /// <p>The definition of an analysis.</p>
    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
    pub fn set_definition(mut self, input: ::std::option::Option<crate::types::AnalysisDefinition>) -> Self {
        self.definition = input;
        self
    }
    /// <p>The definition of an analysis.</p>
    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
    pub fn get_definition(&self) -> &::std::option::Option<crate::types::AnalysisDefinition> {
        &self.definition
    }
    /// <p>The HTTP status of the request.</p>
    pub fn status(mut self, input: i32) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The HTTP status of the request.</p>
    pub fn set_status(mut self, input: ::std::option::Option<i32>) -> Self {
        self.status = input;
        self
    }
    /// <p>The HTTP status of the request.</p>
    pub fn get_status(&self) -> &::std::option::Option<i32> {
        &self.status
    }
    /// <p>The Amazon Web Services request ID for this operation.</p>
    pub fn request_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.request_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Web Services request ID for this operation.</p>
    pub fn set_request_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.request_id = input;
        self
    }
    /// <p>The Amazon Web Services request ID for this operation.</p>
    pub fn get_request_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.request_id
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`DescribeAnalysisDefinitionOutput`](crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput).
    pub fn build(self) -> crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput {
        crate::operation::describe_analysis_definition::DescribeAnalysisDefinitionOutput {
            analysis_id: self.analysis_id,
            name: self.name,
            errors: self.errors,
            resource_status: self.resource_status,
            theme_arn: self.theme_arn,
            definition: self.definition,
            status: self.status.unwrap_or_default(),
            request_id: self.request_id,
            _request_id: self._request_id,
        }
    }
}