Struct aws_sdk_codepipeline::input::stop_pipeline_execution_input::Builder

source ·

pub struct Builder { /* private fields */ }

Expand description

A builder for StopPipelineExecutionInput.

Implementations§

source §

impl Builder

source

pub fn pipeline_name(self, input: impl Into<String>) -> Self

The name of the pipeline to stop.

Examples found in repository ?

src/client.rs (line 3984)

        pub fn pipeline_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.pipeline_name(input.into());
            self
        }

source

pub fn set_pipeline_name(self, input: Option<String>) -> Self

The name of the pipeline to stop.

Examples found in repository ?

src/client.rs (line 3992)

        pub fn set_pipeline_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_pipeline_name(input);
            self
        }

source

pub fn pipeline_execution_id(self, input: impl Into<String>) -> Self

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Examples found in repository ?

src/client.rs (line 3997)

        pub fn pipeline_execution_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.pipeline_execution_id(input.into());
            self
        }

source

pub fn set_pipeline_execution_id(self, input: Option<String>) -> Self

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Examples found in repository ?

src/client.rs (line 4005)

        pub fn set_pipeline_execution_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_pipeline_execution_id(input);
            self
        }

source

pub fn abandon(self, input: bool) -> Self

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Examples found in repository ?

src/client.rs (line 4012)

        pub fn abandon(mut self, input: bool) -> Self {
            self.inner = self.inner.abandon(input);
            self
        }

source

pub fn set_abandon(self, input: Option<bool>) -> Self

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

Examples found in repository ?

src/client.rs (line 4019)

        pub fn set_abandon(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_abandon(input);
            self
        }

source

pub fn reason(self, input: impl Into<String>) -> Self

Use this option to enter comments, such as the reason the pipeline was stopped.

Examples found in repository ?

src/client.rs (line 4024)

        pub fn reason(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.reason(input.into());
            self
        }

source

pub fn set_reason(self, input: Option<String>) -> Self

Use this option to enter comments, such as the reason the pipeline was stopped.

Examples found in repository ?

src/client.rs (line 4029)

        pub fn set_reason(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_reason(input);
            self
        }

source

pub fn build(self) -> Result<StopPipelineExecutionInput, BuildError>

Consumes the builder and constructs a StopPipelineExecutionInput.

Examples found in repository ?

src/client.rs (line 3951)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::StopPipelineExecution,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::StopPipelineExecutionError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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::output::StopPipelineExecutionOutput,
            aws_smithy_http::result::SdkError<crate::error::StopPipelineExecutionError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }