Struct aws_sdk_apigateway::client::fluent_builders::GetExport

pub struct GetExport<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetExport.

Exports a deployed version of a RestApi in a specified format.

Implementations

impl<C, M, R> GetExport<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<GetExportOutput, SdkError<GetExportError>> where
    R::Policy: SmithyRetryPolicy<GetExportInputOperationOutputAlias, GetExportOutput, GetExportError, GetExportInputOperationRetryAlias>, 

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, which can be set when configuring the client.

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

[Required] The string identifier of the associated RestApi.

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

[Required] The string identifier of the associated RestApi.

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

[Required] The name of the Stage that will be exported.

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

[Required] The name of the Stage that will be exported.

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

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

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

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

pub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

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 set_parameters(self, input: Option<HashMap<String, String>>) -> Self

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, input: impl Into<String>) -> Self

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.

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

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for GetExport<C, M, R>

fn clone(&self) -> GetExport<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for GetExport<C, M, R>

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

Formats the value using the given formatter.