aws-sdk-sagemaker 1.189.0

AWS SDK for Amazon SageMaker Service
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 DescribePipelineExecutionOutput {
    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
    pub pipeline_arn: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
    pub pipeline_execution_arn: ::std::option::Option<::std::string::String>,
    /// <p>The display name of the pipeline execution.</p>
    pub pipeline_execution_display_name: ::std::option::Option<::std::string::String>,
    /// <p>The status of the pipeline execution.</p>
    pub pipeline_execution_status: ::std::option::Option<crate::types::PipelineExecutionStatus>,
    /// <p>The description of the pipeline execution.</p>
    pub pipeline_execution_description: ::std::option::Option<::std::string::String>,
    /// <p>Specifies the names of the experiment and trial created by a pipeline.</p>
    pub pipeline_experiment_config: ::std::option::Option<crate::types::PipelineExperimentConfig>,
    /// <p>If the execution failed, a message describing why.</p>
    pub failure_reason: ::std::option::Option<::std::string::String>,
    /// <p>The time when the pipeline execution was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The time when the pipeline execution was modified last.</p>
    pub last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub created_by: ::std::option::Option<crate::types::UserContext>,
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub last_modified_by: ::std::option::Option<crate::types::UserContext>,
    /// <p>The parallelism configuration applied to the pipeline.</p>
    pub parallelism_configuration: ::std::option::Option<crate::types::ParallelismConfiguration>,
    /// <p>The selective execution configuration applied to the pipeline run.</p>
    pub selective_execution_config: ::std::option::Option<crate::types::SelectiveExecutionConfig>,
    /// <p>The ID of the pipeline version.</p>
    pub pipeline_version_id: ::std::option::Option<i64>,
    /// <p>The MLflow configuration of the pipeline execution.</p>
    pub m_lflow_config: ::std::option::Option<crate::types::MLflowConfiguration>,
    _request_id: Option<String>,
}
impl DescribePipelineExecutionOutput {
    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
    pub fn pipeline_arn(&self) -> ::std::option::Option<&str> {
        self.pipeline_arn.as_deref()
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
    pub fn pipeline_execution_arn(&self) -> ::std::option::Option<&str> {
        self.pipeline_execution_arn.as_deref()
    }
    /// <p>The display name of the pipeline execution.</p>
    pub fn pipeline_execution_display_name(&self) -> ::std::option::Option<&str> {
        self.pipeline_execution_display_name.as_deref()
    }
    /// <p>The status of the pipeline execution.</p>
    pub fn pipeline_execution_status(&self) -> ::std::option::Option<&crate::types::PipelineExecutionStatus> {
        self.pipeline_execution_status.as_ref()
    }
    /// <p>The description of the pipeline execution.</p>
    pub fn pipeline_execution_description(&self) -> ::std::option::Option<&str> {
        self.pipeline_execution_description.as_deref()
    }
    /// <p>Specifies the names of the experiment and trial created by a pipeline.</p>
    pub fn pipeline_experiment_config(&self) -> ::std::option::Option<&crate::types::PipelineExperimentConfig> {
        self.pipeline_experiment_config.as_ref()
    }
    /// <p>If the execution failed, a message describing why.</p>
    pub fn failure_reason(&self) -> ::std::option::Option<&str> {
        self.failure_reason.as_deref()
    }
    /// <p>The time when the pipeline execution was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The time when the pipeline execution was modified last.</p>
    pub fn last_modified_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_modified_time.as_ref()
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn created_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
        self.created_by.as_ref()
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn last_modified_by(&self) -> ::std::option::Option<&crate::types::UserContext> {
        self.last_modified_by.as_ref()
    }
    /// <p>The parallelism configuration applied to the pipeline.</p>
    pub fn parallelism_configuration(&self) -> ::std::option::Option<&crate::types::ParallelismConfiguration> {
        self.parallelism_configuration.as_ref()
    }
    /// <p>The selective execution configuration applied to the pipeline run.</p>
    pub fn selective_execution_config(&self) -> ::std::option::Option<&crate::types::SelectiveExecutionConfig> {
        self.selective_execution_config.as_ref()
    }
    /// <p>The ID of the pipeline version.</p>
    pub fn pipeline_version_id(&self) -> ::std::option::Option<i64> {
        self.pipeline_version_id
    }
    /// <p>The MLflow configuration of the pipeline execution.</p>
    pub fn m_lflow_config(&self) -> ::std::option::Option<&crate::types::MLflowConfiguration> {
        self.m_lflow_config.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for DescribePipelineExecutionOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribePipelineExecutionOutput {
    /// Creates a new builder-style object to manufacture [`DescribePipelineExecutionOutput`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput).
    pub fn builder() -> crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionOutputBuilder {
        crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionOutputBuilder::default()
    }
}

/// A builder for [`DescribePipelineExecutionOutput`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribePipelineExecutionOutputBuilder {
    pub(crate) pipeline_arn: ::std::option::Option<::std::string::String>,
    pub(crate) pipeline_execution_arn: ::std::option::Option<::std::string::String>,
    pub(crate) pipeline_execution_display_name: ::std::option::Option<::std::string::String>,
    pub(crate) pipeline_execution_status: ::std::option::Option<crate::types::PipelineExecutionStatus>,
    pub(crate) pipeline_execution_description: ::std::option::Option<::std::string::String>,
    pub(crate) pipeline_experiment_config: ::std::option::Option<crate::types::PipelineExperimentConfig>,
    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_modified_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) created_by: ::std::option::Option<crate::types::UserContext>,
    pub(crate) last_modified_by: ::std::option::Option<crate::types::UserContext>,
    pub(crate) parallelism_configuration: ::std::option::Option<crate::types::ParallelismConfiguration>,
    pub(crate) selective_execution_config: ::std::option::Option<crate::types::SelectiveExecutionConfig>,
    pub(crate) pipeline_version_id: ::std::option::Option<i64>,
    pub(crate) m_lflow_config: ::std::option::Option<crate::types::MLflowConfiguration>,
    _request_id: Option<String>,
}
impl DescribePipelineExecutionOutputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
    pub fn pipeline_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.pipeline_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
    pub fn set_pipeline_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.pipeline_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline.</p>
    pub fn get_pipeline_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.pipeline_arn
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
    pub fn pipeline_execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.pipeline_execution_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
    pub fn set_pipeline_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.pipeline_execution_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
    pub fn get_pipeline_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.pipeline_execution_arn
    }
    /// <p>The display name of the pipeline execution.</p>
    pub fn pipeline_execution_display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.pipeline_execution_display_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The display name of the pipeline execution.</p>
    pub fn set_pipeline_execution_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.pipeline_execution_display_name = input;
        self
    }
    /// <p>The display name of the pipeline execution.</p>
    pub fn get_pipeline_execution_display_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.pipeline_execution_display_name
    }
    /// <p>The status of the pipeline execution.</p>
    pub fn pipeline_execution_status(mut self, input: crate::types::PipelineExecutionStatus) -> Self {
        self.pipeline_execution_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The status of the pipeline execution.</p>
    pub fn set_pipeline_execution_status(mut self, input: ::std::option::Option<crate::types::PipelineExecutionStatus>) -> Self {
        self.pipeline_execution_status = input;
        self
    }
    /// <p>The status of the pipeline execution.</p>
    pub fn get_pipeline_execution_status(&self) -> &::std::option::Option<crate::types::PipelineExecutionStatus> {
        &self.pipeline_execution_status
    }
    /// <p>The description of the pipeline execution.</p>
    pub fn pipeline_execution_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.pipeline_execution_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The description of the pipeline execution.</p>
    pub fn set_pipeline_execution_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.pipeline_execution_description = input;
        self
    }
    /// <p>The description of the pipeline execution.</p>
    pub fn get_pipeline_execution_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.pipeline_execution_description
    }
    /// <p>Specifies the names of the experiment and trial created by a pipeline.</p>
    pub fn pipeline_experiment_config(mut self, input: crate::types::PipelineExperimentConfig) -> Self {
        self.pipeline_experiment_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specifies the names of the experiment and trial created by a pipeline.</p>
    pub fn set_pipeline_experiment_config(mut self, input: ::std::option::Option<crate::types::PipelineExperimentConfig>) -> Self {
        self.pipeline_experiment_config = input;
        self
    }
    /// <p>Specifies the names of the experiment and trial created by a pipeline.</p>
    pub fn get_pipeline_experiment_config(&self) -> &::std::option::Option<crate::types::PipelineExperimentConfig> {
        &self.pipeline_experiment_config
    }
    /// <p>If the execution failed, a message describing why.</p>
    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>If the execution failed, a message describing why.</p>
    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_reason = input;
        self
    }
    /// <p>If the execution failed, a message describing why.</p>
    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_reason
    }
    /// <p>The time when the pipeline execution was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time when the pipeline execution was created.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>The time when the pipeline execution was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The time when the pipeline execution was modified last.</p>
    pub fn last_modified_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_modified_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The time when the pipeline execution was modified last.</p>
    pub fn set_last_modified_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_modified_time = input;
        self
    }
    /// <p>The time when the pipeline execution was modified last.</p>
    pub fn get_last_modified_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_modified_time
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn created_by(mut self, input: crate::types::UserContext) -> Self {
        self.created_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn set_created_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
        self.created_by = input;
        self
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn get_created_by(&self) -> &::std::option::Option<crate::types::UserContext> {
        &self.created_by
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn last_modified_by(mut self, input: crate::types::UserContext) -> Self {
        self.last_modified_by = ::std::option::Option::Some(input);
        self
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn set_last_modified_by(mut self, input: ::std::option::Option<crate::types::UserContext>) -> Self {
        self.last_modified_by = input;
        self
    }
    /// <p>Information about the user who created or modified a SageMaker resource.</p>
    pub fn get_last_modified_by(&self) -> &::std::option::Option<crate::types::UserContext> {
        &self.last_modified_by
    }
    /// <p>The parallelism configuration applied to the pipeline.</p>
    pub fn parallelism_configuration(mut self, input: crate::types::ParallelismConfiguration) -> Self {
        self.parallelism_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The parallelism configuration applied to the pipeline.</p>
    pub fn set_parallelism_configuration(mut self, input: ::std::option::Option<crate::types::ParallelismConfiguration>) -> Self {
        self.parallelism_configuration = input;
        self
    }
    /// <p>The parallelism configuration applied to the pipeline.</p>
    pub fn get_parallelism_configuration(&self) -> &::std::option::Option<crate::types::ParallelismConfiguration> {
        &self.parallelism_configuration
    }
    /// <p>The selective execution configuration applied to the pipeline run.</p>
    pub fn selective_execution_config(mut self, input: crate::types::SelectiveExecutionConfig) -> Self {
        self.selective_execution_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The selective execution configuration applied to the pipeline run.</p>
    pub fn set_selective_execution_config(mut self, input: ::std::option::Option<crate::types::SelectiveExecutionConfig>) -> Self {
        self.selective_execution_config = input;
        self
    }
    /// <p>The selective execution configuration applied to the pipeline run.</p>
    pub fn get_selective_execution_config(&self) -> &::std::option::Option<crate::types::SelectiveExecutionConfig> {
        &self.selective_execution_config
    }
    /// <p>The ID of the pipeline version.</p>
    pub fn pipeline_version_id(mut self, input: i64) -> Self {
        self.pipeline_version_id = ::std::option::Option::Some(input);
        self
    }
    /// <p>The ID of the pipeline version.</p>
    pub fn set_pipeline_version_id(mut self, input: ::std::option::Option<i64>) -> Self {
        self.pipeline_version_id = input;
        self
    }
    /// <p>The ID of the pipeline version.</p>
    pub fn get_pipeline_version_id(&self) -> &::std::option::Option<i64> {
        &self.pipeline_version_id
    }
    /// <p>The MLflow configuration of the pipeline execution.</p>
    pub fn m_lflow_config(mut self, input: crate::types::MLflowConfiguration) -> Self {
        self.m_lflow_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The MLflow configuration of the pipeline execution.</p>
    pub fn set_m_lflow_config(mut self, input: ::std::option::Option<crate::types::MLflowConfiguration>) -> Self {
        self.m_lflow_config = input;
        self
    }
    /// <p>The MLflow configuration of the pipeline execution.</p>
    pub fn get_m_lflow_config(&self) -> &::std::option::Option<crate::types::MLflowConfiguration> {
        &self.m_lflow_config
    }
    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 [`DescribePipelineExecutionOutput`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput).
    pub fn build(self) -> crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput {
        crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput {
            pipeline_arn: self.pipeline_arn,
            pipeline_execution_arn: self.pipeline_execution_arn,
            pipeline_execution_display_name: self.pipeline_execution_display_name,
            pipeline_execution_status: self.pipeline_execution_status,
            pipeline_execution_description: self.pipeline_execution_description,
            pipeline_experiment_config: self.pipeline_experiment_config,
            failure_reason: self.failure_reason,
            creation_time: self.creation_time,
            last_modified_time: self.last_modified_time,
            created_by: self.created_by,
            last_modified_by: self.last_modified_by,
            parallelism_configuration: self.parallelism_configuration,
            selective_execution_config: self.selective_execution_config,
            pipeline_version_id: self.pipeline_version_id,
            m_lflow_config: self.m_lflow_config,
            _request_id: self._request_id,
        }
    }
}