aws_sdk_apigateway/operation/put_rest_api/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_rest_api::_put_rest_api_output::PutRestApiOutputBuilder;
3
4pub use crate::operation::put_rest_api::_put_rest_api_input::PutRestApiInputBuilder;
5
6impl crate::operation::put_rest_api::builders::PutRestApiInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::put_rest_api::PutRestApiOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::put_rest_api::PutRestApiError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.put_rest_api();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PutRestApi`.
24///
25/// <p>A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct PutRestApiFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::put_rest_api::builders::PutRestApiInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::put_rest_api::PutRestApiOutput,
35        crate::operation::put_rest_api::PutRestApiError,
36    > for PutRestApiFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::put_rest_api::PutRestApiOutput,
44            crate::operation::put_rest_api::PutRestApiError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl PutRestApiFluentBuilder {
51    /// Creates a new `PutRestApiFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the PutRestApi as a reference.
60    pub fn as_input(&self) -> &crate::operation::put_rest_api::builders::PutRestApiInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::put_rest_api::PutRestApiOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::put_rest_api::PutRestApiError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::put_rest_api::PutRestApi::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::put_rest_api::PutRestApi::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::put_rest_api::PutRestApiOutput,
97        crate::operation::put_rest_api::PutRestApiError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The string identifier of the associated RestApi.</p>
112    pub fn rest_api_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.rest_api_id(input.into());
114        self
115    }
116    /// <p>The string identifier of the associated RestApi.</p>
117    pub fn set_rest_api_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_rest_api_id(input);
119        self
120    }
121    /// <p>The string identifier of the associated RestApi.</p>
122    pub fn get_rest_api_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_rest_api_id()
124    }
125    /// <p>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".</p>
126    pub fn mode(mut self, input: crate::types::PutMode) -> Self {
127        self.inner = self.inner.mode(input);
128        self
129    }
130    /// <p>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".</p>
131    pub fn set_mode(mut self, input: ::std::option::Option<crate::types::PutMode>) -> Self {
132        self.inner = self.inner.set_mode(input);
133        self
134    }
135    /// <p>The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".</p>
136    pub fn get_mode(&self) -> &::std::option::Option<crate::types::PutMode> {
137        self.inner.get_mode()
138    }
139    /// <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>
140    pub fn fail_on_warnings(mut self, input: bool) -> Self {
141        self.inner = self.inner.fail_on_warnings(input);
142        self
143    }
144    /// <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>
145    pub fn set_fail_on_warnings(mut self, input: ::std::option::Option<bool>) -> Self {
146        self.inner = self.inner.set_fail_on_warnings(input);
147        self
148    }
149    /// <p>A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>) when a warning is encountered. The default value is <code>false</code>.</p>
150    pub fn get_fail_on_warnings(&self) -> &::std::option::Option<bool> {
151        self.inner.get_fail_on_warnings()
152    }
153    ///
154    /// Adds a key-value pair to `parameters`.
155    ///
156    /// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
157    ///
158    /// <p>Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</p>
159    pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
160        self.inner = self.inner.parameters(k.into(), v.into());
161        self
162    }
163    /// <p>Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</p>
164    pub fn set_parameters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
165        self.inner = self.inner.set_parameters(input);
166        self
167    }
168    /// <p>Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'</code>.</p>
169    pub fn get_parameters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
170        self.inner.get_parameters()
171    }
172    /// <p>The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>
173    pub fn body(mut self, input: ::aws_smithy_types::Blob) -> Self {
174        self.inner = self.inner.body(input);
175        self
176    }
177    /// <p>The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>
178    pub fn set_body(mut self, input: ::std::option::Option<::aws_smithy_types::Blob>) -> Self {
179        self.inner = self.inner.set_body(input);
180        self
181    }
182    /// <p>The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.</p>
183    pub fn get_body(&self) -> &::std::option::Option<::aws_smithy_types::Blob> {
184        self.inner.get_body()
185    }
186}
aws_sdk_apigateway/operation/put_rest_api/builders.rs

aws_sdk_apigateway/operation/put_rest_api/
builders.rs
