aws-sdk-datapipeline 1.98.0

AWS SDK for AWS Data Pipeline
Documentation 
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

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

/// <p>Contains the parameters for DeactivatePipeline.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DeactivatePipelineInput {
    /// <p>The ID of the pipeline.</p>
    pub pipeline_id: ::std::option::Option<::std::string::String>,
    /// <p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>
    pub cancel_active: ::std::option::Option<bool>,
}
impl DeactivatePipelineInput {
    /// <p>The ID of the pipeline.</p>
    pub fn pipeline_id(&self) -> ::std::option::Option<&str> {
        self.pipeline_id.as_deref()
    }
    /// <p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>
    pub fn cancel_active(&self) -> ::std::option::Option<bool> {
        self.cancel_active
    }
}
impl DeactivatePipelineInput {
    /// Creates a new builder-style object to manufacture [`DeactivatePipelineInput`](crate::operation::deactivate_pipeline::DeactivatePipelineInput).
    pub fn builder() -> crate::operation::deactivate_pipeline::builders::DeactivatePipelineInputBuilder {
        crate::operation::deactivate_pipeline::builders::DeactivatePipelineInputBuilder::default()
    }
}

/// A builder for [`DeactivatePipelineInput`](crate::operation::deactivate_pipeline::DeactivatePipelineInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DeactivatePipelineInputBuilder {
    pub(crate) pipeline_id: ::std::option::Option<::std::string::String>,
    pub(crate) cancel_active: ::std::option::Option<bool>,
}
impl DeactivatePipelineInputBuilder {
    /// <p>The ID of the pipeline.</p>
    /// This field is required.
    pub fn pipeline_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.pipeline_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the pipeline.</p>
    pub fn set_pipeline_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.pipeline_id = input;
        self
    }
    /// <p>The ID of the pipeline.</p>
    pub fn get_pipeline_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.pipeline_id
    }
    /// <p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>
    pub fn cancel_active(mut self, input: bool) -> Self {
        self.cancel_active = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>
    pub fn set_cancel_active(mut self, input: ::std::option::Option<bool>) -> Self {
        self.cancel_active = input;
        self
    }
    /// <p>Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to <code>CANCELED</code>. If this value is false, the pipeline is deactivated after all running objects finish.</p>
    pub fn get_cancel_active(&self) -> &::std::option::Option<bool> {
        &self.cancel_active
    }
    /// Consumes the builder and constructs a [`DeactivatePipelineInput`](crate::operation::deactivate_pipeline::DeactivatePipelineInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::deactivate_pipeline::DeactivatePipelineInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::deactivate_pipeline::DeactivatePipelineInput {
            pipeline_id: self.pipeline_id,
            cancel_active: self.cancel_active,
        })
    }
}