aws_sdk_apigateway/operation/get_export/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_export::_get_export_output::GetExportOutputBuilder;
3
4pub use crate::operation::get_export::_get_export_input::GetExportInputBuilder;
5
6impl crate::operation::get_export::builders::GetExportInputBuilder {
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::get_export::GetExportOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_export::GetExportError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_export();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetExport`.
24///
25/// <p>Exports a deployed version of a RestApi in a specified format.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct GetExportFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::get_export::builders::GetExportInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl crate::client::customize::internal::CustomizableSend<crate::operation::get_export::GetExportOutput, crate::operation::get_export::GetExportError>
33    for GetExportFluentBuilder
34{
35    fn send(
36        self,
37        config_override: crate::config::Builder,
38    ) -> crate::client::customize::internal::BoxFuture<
39        crate::client::customize::internal::SendResult<crate::operation::get_export::GetExportOutput, crate::operation::get_export::GetExportError>,
40    > {
41        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
42    }
43}
44impl GetExportFluentBuilder {
45    /// Creates a new `GetExportFluentBuilder`.
46    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
47        Self {
48            handle,
49            inner: ::std::default::Default::default(),
50            config_override: ::std::option::Option::None,
51        }
52    }
53    /// Access the GetExport as a reference.
54    pub fn as_input(&self) -> &crate::operation::get_export::builders::GetExportInputBuilder {
55        &self.inner
56    }
57    /// Sends the request and returns the response.
58    ///
59    /// If an error occurs, an `SdkError` will be returned with additional details that
60    /// can be matched against.
61    ///
62    /// By default, any retryable failures will be retried twice. Retry behavior
63    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
64    /// set when configuring the client.
65    pub async fn send(
66        self,
67    ) -> ::std::result::Result<
68        crate::operation::get_export::GetExportOutput,
69        ::aws_smithy_runtime_api::client::result::SdkError<
70            crate::operation::get_export::GetExportError,
71            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
72        >,
73    > {
74        let input = self
75            .inner
76            .build()
77            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
78        let runtime_plugins = crate::operation::get_export::GetExport::operation_runtime_plugins(
79            self.handle.runtime_plugins.clone(),
80            &self.handle.conf,
81            self.config_override,
82        );
83        crate::operation::get_export::GetExport::orchestrate(&runtime_plugins, input).await
84    }
85
86    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
87    pub fn customize(
88        self,
89    ) -> crate::client::customize::CustomizableOperation<
90        crate::operation::get_export::GetExportOutput,
91        crate::operation::get_export::GetExportError,
92        Self,
93    > {
94        crate::client::customize::CustomizableOperation::new(self)
95    }
96    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
97        self.set_config_override(::std::option::Option::Some(config_override.into()));
98        self
99    }
100
101    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
102        self.config_override = config_override;
103        self
104    }
105    /// <p>The string identifier of the associated RestApi.</p>
106    pub fn rest_api_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
107        self.inner = self.inner.rest_api_id(input.into());
108        self
109    }
110    /// <p>The string identifier of the associated RestApi.</p>
111    pub fn set_rest_api_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
112        self.inner = self.inner.set_rest_api_id(input);
113        self
114    }
115    /// <p>The string identifier of the associated RestApi.</p>
116    pub fn get_rest_api_id(&self) -> &::std::option::Option<::std::string::String> {
117        self.inner.get_rest_api_id()
118    }
119    /// <p>The name of the Stage that will be exported.</p>
120    pub fn stage_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.stage_name(input.into());
122        self
123    }
124    /// <p>The name of the Stage that will be exported.</p>
125    pub fn set_stage_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_stage_name(input);
127        self
128    }
129    /// <p>The name of the Stage that will be exported.</p>
130    pub fn get_stage_name(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_stage_name()
132    }
133    /// <p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p>
134    pub fn export_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.export_type(input.into());
136        self
137    }
138    /// <p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p>
139    pub fn set_export_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_export_type(input);
141        self
142    }
143    /// <p>The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.</p>
144    pub fn get_export_type(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_export_type()
146    }
147    ///
148    /// Adds a key-value pair to `parameters`.
149    ///
150    /// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
151    ///
152    /// <p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>
153    pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
154        self.inner = self.inner.parameters(k.into(), v.into());
155        self
156    }
157    /// <p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>
158    pub fn set_parameters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
159        self.inner = self.inner.set_parameters(input);
160        self
161    }
162    /// <p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>oas30</code> and <code>swagger</code>, any combination of the following parameters are supported: <code>extensions='integrations'</code> or <code>extensions='apigateway'</code> will export the API with x-amazon-apigateway-integration extensions. <code>extensions='authorizers'</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>
163    pub fn get_parameters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
164        self.inner.get_parameters()
165    }
166    /// <p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>
167    pub fn accepts(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168        self.inner = self.inner.accepts(input.into());
169        self
170    }
171    /// <p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>
172    pub fn set_accepts(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.inner = self.inner.set_accepts(input);
174        self
175    }
176    /// <p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of<code>oas30</code> and <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>
177    pub fn get_accepts(&self) -> &::std::option::Option<::std::string::String> {
178        self.inner.get_accepts()
179    }
180}
aws_sdk_apigateway/operation/get_export/builders.rs

aws_sdk_apigateway/operation/get_export/
builders.rs
