Struct aws_sdk_apigatewayv2::operation::export_api::builders::ExportApiInputBuilder

#[non_exhaustive]
pub struct ExportApiInputBuilder { /* private fields */ }

A builder for ExportApiInput.

Implementations

impl ExportApiInputBuilder

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

The API identifier.

This field is required.

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

The API identifier.

pub fn get_api_id(&self) -> &Option<String>

The API identifier.

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.

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.

pub fn get_export_version(&self) -> &Option<String>

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

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.

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.

pub fn get_include_extensions(&self) -> &Option<bool>

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

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

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

This field is required.

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

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

pub fn get_output_type(&self) -> &Option<String>

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

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.

This field is required.

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.

pub fn get_specification(&self) -> &Option<String>

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

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.

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.

pub fn get_stage_name(&self) -> &Option<String>

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

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

Consumes the builder and constructs a ExportApiInput.

impl ExportApiInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ExportApiOutput, SdkError<ExportApiError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ExportApiInputBuilder

fn clone(&self) -> ExportApiInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExportApiInputBuilder

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

Formats the value using the given formatter.

impl Default for ExportApiInputBuilder

fn default() -> ExportApiInputBuilder

Returns the “default value” for a type.

impl PartialEq for ExportApiInputBuilder

fn eq(&self, other: &ExportApiInputBuilder) -> 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 ExportApiInputBuilder