Struct aws_sdk_apigatewayv2::input::export_api_input::Builder

pub struct Builder { /* private fields */ }

A builder for ExportApiInput.

Implementations

impl Builder

pub fn api_id(self, input: impl Into<String>) -> Self

The API identifier.

Examples found in repository

src/client.rs (line 5020)

        pub fn api_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.api_id(input.into());
            self
        }

pub fn set_api_id(self, input: Option<String>) -> Self

The API identifier.

Examples found in repository

src/client.rs (line 5025)

        pub fn set_api_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_api_id(input);
            self
        }

pub fn export_version(self, input: impl Into<String>) -> Self

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Examples found in repository

src/client.rs (line 5030)

        pub fn export_version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.export_version(input.into());
            self
        }

pub fn set_export_version(self, input: Option<String>) -> Self

The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.

Examples found in repository

src/client.rs (line 5038)

        pub fn set_export_version(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_export_version(input);
            self
        }

pub fn include_extensions(self, input: bool) -> Self

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Examples found in repository

src/client.rs (line 5043)

        pub fn include_extensions(mut self, input: bool) -> Self {
            self.inner = self.inner.include_extensions(input);
            self
        }

pub fn set_include_extensions(self, input: Option<bool>) -> Self

Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.

Examples found in repository

src/client.rs (line 5048)

        pub fn set_include_extensions(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_include_extensions(input);
            self
        }

pub fn output_type(self, input: impl Into<String>) -> Self

The output type of the exported definition file. Valid values are JSON and YAML.

Examples found in repository

src/client.rs (line 5053)

        pub fn output_type(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.output_type(input.into());
            self
        }

pub fn set_output_type(self, input: Option<String>) -> Self

The output type of the exported definition file. Valid values are JSON and YAML.

Examples found in repository

src/client.rs (line 5058)

        pub fn set_output_type(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_output_type(input);
            self
        }

pub fn specification(self, input: impl Into<String>) -> Self

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Examples found in repository

src/client.rs (line 5063)

        pub fn specification(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.specification(input.into());
            self
        }

pub fn set_specification(self, input: Option<String>) -> Self

The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.

Examples found in repository

src/client.rs (line 5071)

        pub fn set_specification(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_specification(input);
            self
        }

pub fn stage_name(self, input: impl Into<String>) -> Self

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Examples found in repository

src/client.rs (line 5076)

        pub fn stage_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.stage_name(input.into());
            self
        }

pub fn set_stage_name(self, input: Option<String>) -> Self

The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.

Examples found in repository

src/client.rs (line 5081)

        pub fn set_stage_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_stage_name(input);
            self
        }

pub fn build(self) -> Result<ExportApiInput, BuildError>

Consumes the builder and constructs a ExportApiInput.

Examples found in repository

src/client.rs (line 4987)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::ExportApi,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::ExportApiError>,
        > {
            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)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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::output::ExportApiOutput,
            aws_smithy_http::result::SdkError<crate::error::ExportApiError>,
        > {
            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
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder