aws-sdk-redshiftdata 1.110.0

// 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 ExecuteStatementOutput {
    /// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The date and time (UTC) the statement was created.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>
    pub cluster_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The database user name.</p>
    pub db_user: ::std::option::Option<::std::string::String>,
    /// <p>A list of colon (:) separated names of database groups.</p>
    pub db_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The name of the database.</p>
    pub database: ::std::option::Option<::std::string::String>,
    /// <p>The name or ARN of the secret that enables access to the database.</p>
    pub secret_arn: ::std::option::Option<::std::string::String>,
    /// <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
    pub workgroup_name: ::std::option::Option<::std::string::String>,
    /// <p>The session identifier of the query.</p>
    pub session_id: ::std::option::Option<::std::string::String>,
    /// <p>The status of the SQL statement. Status values are defined as follows:</p>
    /// <ul>
    /// <li>
    /// <p>ABORTED - The query run was stopped by the user.</p></li>
    /// <li>
    /// <p>FAILED - The query run failed.</p></li>
    /// <li>
    /// <p>FINISHED - The query has finished running.</p></li>
    /// <li>
    /// <p>PICKED - The query has been chosen to be run.</p></li>
    /// <li>
    /// <p>STARTED - The query run has started.</p></li>
    /// <li>
    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
    /// </ul>
    pub status: ::std::option::Option<crate::types::StatementStatusString>,
    /// <p>The process identifier from Amazon Redshift.</p>
    pub redshift_pid: ::std::option::Option<i64>,
    /// <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
    pub has_result_set: ::std::option::Option<bool>,
    _request_id: Option<String>,
}
impl ExecuteStatementOutput {
    /// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The date and time (UTC) the statement was created.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>
    pub fn cluster_identifier(&self) -> ::std::option::Option<&str> {
        self.cluster_identifier.as_deref()
    }
    /// <p>The database user name.</p>
    pub fn db_user(&self) -> ::std::option::Option<&str> {
        self.db_user.as_deref()
    }
    /// <p>A list of colon (:) separated names of database groups.</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 `.db_groups.is_none()`.
    pub fn db_groups(&self) -> &[::std::string::String] {
        self.db_groups.as_deref().unwrap_or_default()
    }
    /// <p>The name of the database.</p>
    pub fn database(&self) -> ::std::option::Option<&str> {
        self.database.as_deref()
    }
    /// <p>The name or ARN of the secret that enables access to the database.</p>
    pub fn secret_arn(&self) -> ::std::option::Option<&str> {
        self.secret_arn.as_deref()
    }
    /// <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
    pub fn workgroup_name(&self) -> ::std::option::Option<&str> {
        self.workgroup_name.as_deref()
    }
    /// <p>The session identifier of the query.</p>
    pub fn session_id(&self) -> ::std::option::Option<&str> {
        self.session_id.as_deref()
    }
    /// <p>The status of the SQL statement. Status values are defined as follows:</p>
    /// <ul>
    /// <li>
    /// <p>ABORTED - The query run was stopped by the user.</p></li>
    /// <li>
    /// <p>FAILED - The query run failed.</p></li>
    /// <li>
    /// <p>FINISHED - The query has finished running.</p></li>
    /// <li>
    /// <p>PICKED - The query has been chosen to be run.</p></li>
    /// <li>
    /// <p>STARTED - The query run has started.</p></li>
    /// <li>
    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
    /// </ul>
    pub fn status(&self) -> ::std::option::Option<&crate::types::StatementStatusString> {
        self.status.as_ref()
    }
    /// <p>The process identifier from Amazon Redshift.</p>
    pub fn redshift_pid(&self) -> ::std::option::Option<i64> {
        self.redshift_pid
    }
    /// <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
    pub fn has_result_set(&self) -> ::std::option::Option<bool> {
        self.has_result_set
    }
}
impl ::aws_types::request_id::RequestId for ExecuteStatementOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl ExecuteStatementOutput {
    /// Creates a new builder-style object to manufacture [`ExecuteStatementOutput`](crate::operation::execute_statement::ExecuteStatementOutput).
    pub fn builder() -> crate::operation::execute_statement::builders::ExecuteStatementOutputBuilder {
        crate::operation::execute_statement::builders::ExecuteStatementOutputBuilder::default()
    }
}

/// A builder for [`ExecuteStatementOutput`](crate::operation::execute_statement::ExecuteStatementOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ExecuteStatementOutputBuilder {
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) cluster_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) db_user: ::std::option::Option<::std::string::String>,
    pub(crate) db_groups: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) database: ::std::option::Option<::std::string::String>,
    pub(crate) secret_arn: ::std::option::Option<::std::string::String>,
    pub(crate) workgroup_name: ::std::option::Option<::std::string::String>,
    pub(crate) session_id: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::StatementStatusString>,
    pub(crate) redshift_pid: ::std::option::Option<i64>,
    pub(crate) has_result_set: ::std::option::Option<bool>,
    _request_id: Option<String>,
}
impl ExecuteStatementOutputBuilder {
    /// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>
    pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The date and time (UTC) the statement was created.</p>
    pub fn created_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time (UTC) the statement was created.</p>
    pub fn set_created_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_at = input;
        self
    }
    /// <p>The date and time (UTC) the statement was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>
    pub fn cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cluster_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>
    pub fn set_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cluster_identifier = input;
        self
    }
    /// <p>The cluster identifier. This element is not returned when connecting to a serverless workgroup.</p>
    pub fn get_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.cluster_identifier
    }
    /// <p>The database user name.</p>
    pub fn db_user(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.db_user = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The database user name.</p>
    pub fn set_db_user(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.db_user = input;
        self
    }
    /// <p>The database user name.</p>
    pub fn get_db_user(&self) -> &::std::option::Option<::std::string::String> {
        &self.db_user
    }
    /// Appends an item to `db_groups`.
    ///
    /// To override the contents of this collection use [`set_db_groups`](Self::set_db_groups).
    ///
    /// <p>A list of colon (:) separated names of database groups.</p>
    pub fn db_groups(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.db_groups.unwrap_or_default();
        v.push(input.into());
        self.db_groups = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of colon (:) separated names of database groups.</p>
    pub fn set_db_groups(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.db_groups = input;
        self
    }
    /// <p>A list of colon (:) separated names of database groups.</p>
    pub fn get_db_groups(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.db_groups
    }
    /// <p>The name of the database.</p>
    pub fn database(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.database = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the database.</p>
    pub fn set_database(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.database = input;
        self
    }
    /// <p>The name of the database.</p>
    pub fn get_database(&self) -> &::std::option::Option<::std::string::String> {
        &self.database
    }
    /// <p>The name or ARN of the secret that enables access to the database.</p>
    pub fn secret_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.secret_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name or ARN of the secret that enables access to the database.</p>
    pub fn set_secret_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.secret_arn = input;
        self
    }
    /// <p>The name or ARN of the secret that enables access to the database.</p>
    pub fn get_secret_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.secret_arn
    }
    /// <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
    pub fn workgroup_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.workgroup_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
    pub fn set_workgroup_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.workgroup_name = input;
        self
    }
    /// <p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>
    pub fn get_workgroup_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.workgroup_name
    }
    /// <p>The session identifier of the query.</p>
    pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.session_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The session identifier of the query.</p>
    pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.session_id = input;
        self
    }
    /// <p>The session identifier of the query.</p>
    pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.session_id
    }
    /// <p>The status of the SQL statement. Status values are defined as follows:</p>
    /// <ul>
    /// <li>
    /// <p>ABORTED - The query run was stopped by the user.</p></li>
    /// <li>
    /// <p>FAILED - The query run failed.</p></li>
    /// <li>
    /// <p>FINISHED - The query has finished running.</p></li>
    /// <li>
    /// <p>PICKED - The query has been chosen to be run.</p></li>
    /// <li>
    /// <p>STARTED - The query run has started.</p></li>
    /// <li>
    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
    /// </ul>
    pub fn status(mut self, input: crate::types::StatementStatusString) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the SQL statement. Status values are defined as follows:</p>
    /// <ul>
    /// <li>
    /// <p>ABORTED - The query run was stopped by the user.</p></li>
    /// <li>
    /// <p>FAILED - The query run failed.</p></li>
    /// <li>
    /// <p>FINISHED - The query has finished running.</p></li>
    /// <li>
    /// <p>PICKED - The query has been chosen to be run.</p></li>
    /// <li>
    /// <p>STARTED - The query run has started.</p></li>
    /// <li>
    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
    /// </ul>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::StatementStatusString>) -> Self {
        self.status = input;
        self
    }
    /// <p>The status of the SQL statement. Status values are defined as follows:</p>
    /// <ul>
    /// <li>
    /// <p>ABORTED - The query run was stopped by the user.</p></li>
    /// <li>
    /// <p>FAILED - The query run failed.</p></li>
    /// <li>
    /// <p>FINISHED - The query has finished running.</p></li>
    /// <li>
    /// <p>PICKED - The query has been chosen to be run.</p></li>
    /// <li>
    /// <p>STARTED - The query run has started.</p></li>
    /// <li>
    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
    /// </ul>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::StatementStatusString> {
        &self.status
    }
    /// <p>The process identifier from Amazon Redshift.</p>
    pub fn redshift_pid(mut self, input: i64) -> Self {
        self.redshift_pid = ::std::option::Option::Some(input);
        self
    }
    /// <p>The process identifier from Amazon Redshift.</p>
    pub fn set_redshift_pid(mut self, input: ::std::option::Option<i64>) -> Self {
        self.redshift_pid = input;
        self
    }
    /// <p>The process identifier from Amazon Redshift.</p>
    pub fn get_redshift_pid(&self) -> &::std::option::Option<i64> {
        &self.redshift_pid
    }
    /// <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
    pub fn has_result_set(mut self, input: bool) -> Self {
        self.has_result_set = ::std::option::Option::Some(input);
        self
    }
    /// <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
    pub fn set_has_result_set(mut self, input: ::std::option::Option<bool>) -> Self {
        self.has_result_set = input;
        self
    }
    /// <p>A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.</p>
    pub fn get_has_result_set(&self) -> &::std::option::Option<bool> {
        &self.has_result_set
    }
    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 [`ExecuteStatementOutput`](crate::operation::execute_statement::ExecuteStatementOutput).
    pub fn build(self) -> crate::operation::execute_statement::ExecuteStatementOutput {
        crate::operation::execute_statement::ExecuteStatementOutput {
            id: self.id,
            created_at: self.created_at,
            cluster_identifier: self.cluster_identifier,
            db_user: self.db_user,
            db_groups: self.db_groups,
            database: self.database,
            secret_arn: self.secret_arn,
            workgroup_name: self.workgroup_name,
            session_id: self.session_id,
            status: self.status,
            redshift_pid: self.redshift_pid,
            has_result_set: self.has_result_set,
            _request_id: self._request_id,
        }
    }
}