1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::stop_pipeline_execution::_stop_pipeline_execution_output::StopPipelineExecutionOutputBuilder;
pub use crate::operation::stop_pipeline_execution::_stop_pipeline_execution_input::StopPipelineExecutionInputBuilder;
/// Fluent builder constructing a request to `StopPipelineExecution`.
///
/// <p>Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a <code>Stopping</code> state. After all in-progress actions are completed or abandoned, the pipeline execution is in a <code>Stopped</code> state.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StopPipelineExecutionFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::stop_pipeline_execution::builders::StopPipelineExecutionInputBuilder,
}
impl StopPipelineExecutionFluentBuilder {
/// Creates a new `StopPipelineExecution`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
}
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn customize_middleware(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::stop_pipeline_execution::StopPipelineExecution,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::stop_pipeline_execution::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)?;
::std::result::Result::Ok(crate::client::customize::CustomizableOperation {
handle,
operation,
})
}
// This function will go away in the near future. Do not rely on it.
#[doc(hidden)]
pub async fn send_middleware(
self,
) -> ::std::result::Result<
crate::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
::aws_smithy_http::result::SdkError<
crate::operation::stop_pipeline_execution::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
}
/// 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::operation::stop_pipeline_execution::StopPipelineExecutionOutput,
::aws_smithy_http::result::SdkError<
crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
>,
> {
self.send_middleware().await
}
/// Consumes this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> ::std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::stop_pipeline_execution::StopPipelineExecution,
::aws_http::retry::AwsResponseRetryClassifier,
>,
::aws_smithy_http::result::SdkError<
crate::operation::stop_pipeline_execution::StopPipelineExecutionError,
>,
> {
self.customize_middleware().await
}
/// <p>The name of the pipeline to stop.</p>
pub fn pipeline_name(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.pipeline_name(input.into());
self
}
/// <p>The name of the pipeline to stop.</p>
pub fn set_pipeline_name(
mut self,
input: ::std::option::Option<::std::string::String>,
) -> Self {
self.inner = self.inner.set_pipeline_name(input);
self
}
/// <p>The ID of the pipeline execution to be stopped in the current stage. Use the <code>GetPipelineState</code> action to retrieve the current pipelineExecutionId.</p>
pub fn pipeline_execution_id(
mut self,
input: impl ::std::convert::Into<::std::string::String>,
) -> Self {
self.inner = self.inner.pipeline_execution_id(input.into());
self
}
/// <p>The ID of the pipeline execution to be stopped in the current stage. Use the <code>GetPipelineState</code> action to retrieve the current pipelineExecutionId.</p>
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
}
/// <p>Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.</p> <note>
/// <p>This option can lead to failed or out-of-sequence tasks.</p>
/// </note>
pub fn abandon(mut self, input: bool) -> Self {
self.inner = self.inner.abandon(input);
self
}
/// <p>Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.</p> <note>
/// <p>This option can lead to failed or out-of-sequence tasks.</p>
/// </note>
pub fn set_abandon(mut self, input: ::std::option::Option<bool>) -> Self {
self.inner = self.inner.set_abandon(input);
self
}
/// <p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>
pub fn reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.reason(input.into());
self
}
/// <p>Use this option to enter comments, such as the reason the pipeline was stopped.</p>
pub fn set_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_reason(input);
self
}
}