aws-sdk-emr 1.121.0

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Detailed information about a Spark Connect session.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Session {
    /// <p>The ID of the session.</p>
    pub id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the cluster that the session belongs to.</p>
    pub cluster_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the session, if one was provided at creation time.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the session.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>
    pub state: ::std::option::Option<crate::types::SessionState>,
    /// <p>A human-readable message describing the most recent state change.</p>
    pub state_change_reason: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon EMR release label of the cluster that the session is running on.</p>
    pub release_label: ::std::option::Option<::std::string::String>,
    /// <p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>
    pub execution_role_arn: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Web Services account ID that owns the session.</p>
    pub account_id: ::std::option::Option<::std::string::String>,
    /// <p>The date and time that the session was created.</p>
    pub created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time that the session was last updated.</p>
    pub updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time that the session entered the <code>STARTED</code> state.</p>
    pub started_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time that the session was terminated or failed.</p>
    pub ended_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time that the session last entered the <code>IDLE</code> state.</p>
    pub idle_since: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The configuration overrides for the session. Only runtime configuration overrides are supported.</p>
    pub engine_configurations: ::std::option::Option<::std::vec::Vec<crate::types::Configuration>>,
    /// <p>The monitoring configuration for the session.</p>
    pub monitoring_configuration: ::std::option::Option<crate::types::SessionMonitoringConfiguration>,
    /// <p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>
    pub session_idle_timeout_in_minutes: ::std::option::Option<i64>,
    /// <p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>
    pub server_url: ::std::option::Option<::std::string::String>,
    /// <p>The tags associated with the session.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl Session {
    /// <p>The ID of the session.</p>
    pub fn id(&self) -> ::std::option::Option<&str> {
        self.id.as_deref()
    }
    /// <p>The ID of the cluster that the session belongs to.</p>
    pub fn cluster_id(&self) -> ::std::option::Option<&str> {
        self.cluster_id.as_deref()
    }
    /// <p>The name of the session, if one was provided at creation time.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the session.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::SessionState> {
        self.state.as_ref()
    }
    /// <p>A human-readable message describing the most recent state change.</p>
    pub fn state_change_reason(&self) -> ::std::option::Option<&str> {
        self.state_change_reason.as_deref()
    }
    /// <p>The Amazon EMR release label of the cluster that the session is running on.</p>
    pub fn release_label(&self) -> ::std::option::Option<&str> {
        self.release_label.as_deref()
    }
    /// <p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>
    pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
        self.execution_role_arn.as_deref()
    }
    /// <p>The Amazon Web Services account ID that owns the session.</p>
    pub fn account_id(&self) -> ::std::option::Option<&str> {
        self.account_id.as_deref()
    }
    /// <p>The date and time that the session was created.</p>
    pub fn created_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_at.as_ref()
    }
    /// <p>The date and time that the session was last updated.</p>
    pub fn updated_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.updated_at.as_ref()
    }
    /// <p>The date and time that the session entered the <code>STARTED</code> state.</p>
    pub fn started_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.started_at.as_ref()
    }
    /// <p>The date and time that the session was terminated or failed.</p>
    pub fn ended_at(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.ended_at.as_ref()
    }
    /// <p>The date and time that the session last entered the <code>IDLE</code> state.</p>
    pub fn idle_since(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.idle_since.as_ref()
    }
    /// <p>The configuration overrides for the session. Only runtime configuration overrides are supported.</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 `.engine_configurations.is_none()`.
    pub fn engine_configurations(&self) -> &[crate::types::Configuration] {
        self.engine_configurations.as_deref().unwrap_or_default()
    }
    /// <p>The monitoring configuration for the session.</p>
    pub fn monitoring_configuration(&self) -> ::std::option::Option<&crate::types::SessionMonitoringConfiguration> {
        self.monitoring_configuration.as_ref()
    }
    /// <p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>
    pub fn session_idle_timeout_in_minutes(&self) -> ::std::option::Option<i64> {
        self.session_idle_timeout_in_minutes
    }
    /// <p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>
    pub fn server_url(&self) -> ::std::option::Option<&str> {
        self.server_url.as_deref()
    }
    /// <p>The tags associated with the session.</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 `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl Session {
    /// Creates a new builder-style object to manufacture [`Session`](crate::types::Session).
    pub fn builder() -> crate::types::builders::SessionBuilder {
        crate::types::builders::SessionBuilder::default()
    }
}

/// A builder for [`Session`](crate::types::Session).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SessionBuilder {
    pub(crate) id: ::std::option::Option<::std::string::String>,
    pub(crate) cluster_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) state: ::std::option::Option<crate::types::SessionState>,
    pub(crate) state_change_reason: ::std::option::Option<::std::string::String>,
    pub(crate) release_label: ::std::option::Option<::std::string::String>,
    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) account_id: ::std::option::Option<::std::string::String>,
    pub(crate) created_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) updated_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) started_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) ended_at: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) idle_since: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) engine_configurations: ::std::option::Option<::std::vec::Vec<crate::types::Configuration>>,
    pub(crate) monitoring_configuration: ::std::option::Option<crate::types::SessionMonitoringConfiguration>,
    pub(crate) session_idle_timeout_in_minutes: ::std::option::Option<i64>,
    pub(crate) server_url: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl SessionBuilder {
    /// <p>The ID of the session.</p>
    /// This field is required.
    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 ID of the session.</p>
    pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.id = input;
        self
    }
    /// <p>The ID of the session.</p>
    pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.id
    }
    /// <p>The ID of the cluster that the session belongs to.</p>
    /// This field is required.
    pub fn cluster_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cluster_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the cluster that the session belongs to.</p>
    pub fn set_cluster_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cluster_id = input;
        self
    }
    /// <p>The ID of the cluster that the session belongs to.</p>
    pub fn get_cluster_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.cluster_id
    }
    /// <p>The name of the session, if one was provided at creation time.</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 name of the session, if one was provided at creation time.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the session, if one was provided at creation time.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The Amazon Resource Name (ARN) of the session.</p>
    /// This field is required.
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the session.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the session.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>
    /// This field is required.
    pub fn state(mut self, input: crate::types::SessionState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::SessionState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The current state of the session. Valid values are <code>SUBMITTED</code>, <code>STARTING</code>, <code>STARTED</code>, <code>IDLE</code>, <code>BUSY</code>, <code>TERMINATING</code>, <code>TERMINATED</code>, and <code>FAILED</code>.</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::SessionState> {
        &self.state
    }
    /// <p>A human-readable message describing the most recent state change.</p>
    pub fn state_change_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.state_change_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A human-readable message describing the most recent state change.</p>
    pub fn set_state_change_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.state_change_reason = input;
        self
    }
    /// <p>A human-readable message describing the most recent state change.</p>
    pub fn get_state_change_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.state_change_reason
    }
    /// <p>The Amazon EMR release label of the cluster that the session is running on.</p>
    pub fn release_label(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.release_label = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon EMR release label of the cluster that the session is running on.</p>
    pub fn set_release_label(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.release_label = input;
        self
    }
    /// <p>The Amazon EMR release label of the cluster that the session is running on.</p>
    pub fn get_release_label(&self) -> &::std::option::Option<::std::string::String> {
        &self.release_label
    }
    /// <p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>
    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_role_arn = input;
        self
    }
    /// <p>The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.</p>
    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_role_arn
    }
    /// <p>The Amazon Web Services account ID that owns the session.</p>
    pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Web Services account ID that owns the session.</p>
    pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.account_id = input;
        self
    }
    /// <p>The Amazon Web Services account ID that owns the session.</p>
    pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.account_id
    }
    /// <p>The date and time that the session 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 that the session 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 that the session was created.</p>
    pub fn get_created_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_at
    }
    /// <p>The date and time that the session was last updated.</p>
    pub fn updated_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.updated_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time that the session was last updated.</p>
    pub fn set_updated_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.updated_at = input;
        self
    }
    /// <p>The date and time that the session was last updated.</p>
    pub fn get_updated_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.updated_at
    }
    /// <p>The date and time that the session entered the <code>STARTED</code> state.</p>
    pub fn started_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.started_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time that the session entered the <code>STARTED</code> state.</p>
    pub fn set_started_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.started_at = input;
        self
    }
    /// <p>The date and time that the session entered the <code>STARTED</code> state.</p>
    pub fn get_started_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.started_at
    }
    /// <p>The date and time that the session was terminated or failed.</p>
    pub fn ended_at(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.ended_at = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time that the session was terminated or failed.</p>
    pub fn set_ended_at(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.ended_at = input;
        self
    }
    /// <p>The date and time that the session was terminated or failed.</p>
    pub fn get_ended_at(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.ended_at
    }
    /// <p>The date and time that the session last entered the <code>IDLE</code> state.</p>
    pub fn idle_since(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.idle_since = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time that the session last entered the <code>IDLE</code> state.</p>
    pub fn set_idle_since(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.idle_since = input;
        self
    }
    /// <p>The date and time that the session last entered the <code>IDLE</code> state.</p>
    pub fn get_idle_since(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.idle_since
    }
    /// Appends an item to `engine_configurations`.
    ///
    /// To override the contents of this collection use [`set_engine_configurations`](Self::set_engine_configurations).
    ///
    /// <p>The configuration overrides for the session. Only runtime configuration overrides are supported.</p>
    pub fn engine_configurations(mut self, input: crate::types::Configuration) -> Self {
        let mut v = self.engine_configurations.unwrap_or_default();
        v.push(input);
        self.engine_configurations = ::std::option::Option::Some(v);
        self
    }
    /// <p>The configuration overrides for the session. Only runtime configuration overrides are supported.</p>
    pub fn set_engine_configurations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Configuration>>) -> Self {
        self.engine_configurations = input;
        self
    }
    /// <p>The configuration overrides for the session. Only runtime configuration overrides are supported.</p>
    pub fn get_engine_configurations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Configuration>> {
        &self.engine_configurations
    }
    /// <p>The monitoring configuration for the session.</p>
    pub fn monitoring_configuration(mut self, input: crate::types::SessionMonitoringConfiguration) -> Self {
        self.monitoring_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The monitoring configuration for the session.</p>
    pub fn set_monitoring_configuration(mut self, input: ::std::option::Option<crate::types::SessionMonitoringConfiguration>) -> Self {
        self.monitoring_configuration = input;
        self
    }
    /// <p>The monitoring configuration for the session.</p>
    pub fn get_monitoring_configuration(&self) -> &::std::option::Option<crate::types::SessionMonitoringConfiguration> {
        &self.monitoring_configuration
    }
    /// <p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>
    pub fn session_idle_timeout_in_minutes(mut self, input: i64) -> Self {
        self.session_idle_timeout_in_minutes = ::std::option::Option::Some(input);
        self
    }
    /// <p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>
    pub fn set_session_idle_timeout_in_minutes(mut self, input: ::std::option::Option<i64>) -> Self {
        self.session_idle_timeout_in_minutes = input;
        self
    }
    /// <p>The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR automatically terminates it.</p>
    pub fn get_session_idle_timeout_in_minutes(&self) -> &::std::option::Option<i64> {
        &self.session_idle_timeout_in_minutes
    }
    /// <p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>
    pub fn server_url(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.server_url = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>
    pub fn set_server_url(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.server_url = input;
        self
    }
    /// <p>The Spark Connect server URL for the session. Use this URL with the <code>Credentials</code> returned by <code>GetSessionEndpoint</code> to connect directly to the session over VPC peering.</p>
    pub fn get_server_url(&self) -> &::std::option::Option<::std::string::String> {
        &self.server_url
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags associated with the session.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>The tags associated with the session.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags associated with the session.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`Session`](crate::types::Session).
    pub fn build(self) -> crate::types::Session {
        crate::types::Session {
            id: self.id,
            cluster_id: self.cluster_id,
            name: self.name,
            arn: self.arn,
            state: self.state,
            state_change_reason: self.state_change_reason,
            release_label: self.release_label,
            execution_role_arn: self.execution_role_arn,
            account_id: self.account_id,
            created_at: self.created_at,
            updated_at: self.updated_at,
            started_at: self.started_at,
            ended_at: self.ended_at,
            idle_since: self.idle_since,
            engine_configurations: self.engine_configurations,
            monitoring_configuration: self.monitoring_configuration,
            session_idle_timeout_in_minutes: self.session_idle_timeout_in_minutes,
            server_url: self.server_url,
            tags: self.tags,
        }
    }
}