Struct aws_sdk_apigateway::operation::get_export::GetExportInput

#[non_exhaustive]
pub struct GetExportInput {
    pub rest_api_id: Option<String>,
    pub stage_name: Option<String>,
    pub export_type: Option<String>,
    pub parameters: Option<HashMap<String, String>>,
    pub accepts: Option<String>,
}

Request a new export of a RestApi for a particular Stage.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

stage_name: Option<String>

The name of the Stage that will be exported.

export_type: Option<String>

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

parameters: Option<HashMap<String, String>>

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

accepts: Option<String>

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Implementations

impl GetExportInput

pub fn rest_api_id(&self) -> Option<&str>

The string identifier of the associated RestApi.

pub fn stage_name(&self) -> Option<&str>

The name of the Stage that will be exported.

pub fn export_type(&self) -> Option<&str>

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

pub fn parameters(&self) -> Option<&HashMap<String, String>>

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

pub fn accepts(&self) -> Option<&str>

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

impl GetExportInput

pub fn builder() -> GetExportInputBuilder

Creates a new builder-style object to manufacture GetExportInput.

Trait Implementations

impl Clone for GetExportInput

fn clone(&self) -> GetExportInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetExportInput

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

Formats the value using the given formatter.

impl PartialEq for GetExportInput

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