aws_sdk_apigateway/operation/update_deployment/
_update_deployment_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3/// <p>Requests API Gateway to change information about a Deployment resource.</p>
4#[non_exhaustive]
5#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
6pub struct UpdateDeploymentInput {
7    /// <p>The string identifier of the associated RestApi.</p>
8    pub rest_api_id: ::std::option::Option<::std::string::String>,
9    /// <p>The replacement identifier for the Deployment resource to change information about.</p>
10    pub deployment_id: ::std::option::Option<::std::string::String>,
11    /// <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
12    pub patch_operations: ::std::option::Option<::std::vec::Vec<crate::types::PatchOperation>>,
13}
14impl UpdateDeploymentInput {
15    /// <p>The string identifier of the associated RestApi.</p>
16    pub fn rest_api_id(&self) -> ::std::option::Option<&str> {
17        self.rest_api_id.as_deref()
18    }
19    /// <p>The replacement identifier for the Deployment resource to change information about.</p>
20    pub fn deployment_id(&self) -> ::std::option::Option<&str> {
21        self.deployment_id.as_deref()
22    }
23    /// <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
24    ///
25    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.patch_operations.is_none()`.
26    pub fn patch_operations(&self) -> &[crate::types::PatchOperation] {
27        self.patch_operations.as_deref().unwrap_or_default()
28    }
29}
30impl UpdateDeploymentInput {
31    /// Creates a new builder-style object to manufacture [`UpdateDeploymentInput`](crate::operation::update_deployment::UpdateDeploymentInput).
32    pub fn builder() -> crate::operation::update_deployment::builders::UpdateDeploymentInputBuilder {
33        crate::operation::update_deployment::builders::UpdateDeploymentInputBuilder::default()
34    }
35}
36
37/// A builder for [`UpdateDeploymentInput`](crate::operation::update_deployment::UpdateDeploymentInput).
38#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
39#[non_exhaustive]
40pub struct UpdateDeploymentInputBuilder {
41    pub(crate) rest_api_id: ::std::option::Option<::std::string::String>,
42    pub(crate) deployment_id: ::std::option::Option<::std::string::String>,
43    pub(crate) patch_operations: ::std::option::Option<::std::vec::Vec<crate::types::PatchOperation>>,
44}
45impl UpdateDeploymentInputBuilder {
46    /// <p>The string identifier of the associated RestApi.</p>
47    /// This field is required.
48    pub fn rest_api_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
49        self.rest_api_id = ::std::option::Option::Some(input.into());
50        self
51    }
52    /// <p>The string identifier of the associated RestApi.</p>
53    pub fn set_rest_api_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
54        self.rest_api_id = input;
55        self
56    }
57    /// <p>The string identifier of the associated RestApi.</p>
58    pub fn get_rest_api_id(&self) -> &::std::option::Option<::std::string::String> {
59        &self.rest_api_id
60    }
61    /// <p>The replacement identifier for the Deployment resource to change information about.</p>
62    /// This field is required.
63    pub fn deployment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
64        self.deployment_id = ::std::option::Option::Some(input.into());
65        self
66    }
67    /// <p>The replacement identifier for the Deployment resource to change information about.</p>
68    pub fn set_deployment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
69        self.deployment_id = input;
70        self
71    }
72    /// <p>The replacement identifier for the Deployment resource to change information about.</p>
73    pub fn get_deployment_id(&self) -> &::std::option::Option<::std::string::String> {
74        &self.deployment_id
75    }
76    /// Appends an item to `patch_operations`.
77    ///
78    /// To override the contents of this collection use [`set_patch_operations`](Self::set_patch_operations).
79    ///
80    /// <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
81    pub fn patch_operations(mut self, input: crate::types::PatchOperation) -> Self {
82        let mut v = self.patch_operations.unwrap_or_default();
83        v.push(input);
84        self.patch_operations = ::std::option::Option::Some(v);
85        self
86    }
87    /// <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
88    pub fn set_patch_operations(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PatchOperation>>) -> Self {
89        self.patch_operations = input;
90        self
91    }
92    /// <p>For more information about supported patch operations, see <a href="https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html">Patch Operations</a>.</p>
93    pub fn get_patch_operations(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PatchOperation>> {
94        &self.patch_operations
95    }
96    /// Consumes the builder and constructs a [`UpdateDeploymentInput`](crate::operation::update_deployment::UpdateDeploymentInput).
97    pub fn build(
98        self,
99    ) -> ::std::result::Result<crate::operation::update_deployment::UpdateDeploymentInput, ::aws_smithy_types::error::operation::BuildError> {
100        ::std::result::Result::Ok(crate::operation::update_deployment::UpdateDeploymentInput {
101            rest_api_id: self.rest_api_id,
102            deployment_id: self.deployment_id,
103            patch_operations: self.patch_operations,
104        })
105    }
106}