Struct aws_sdk_apigateway::operation::import_rest_api::builders::ImportRestApiInputBuilder

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

A builder for ImportRestApiInput.

Implementations

impl ImportRestApiInputBuilder

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

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

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

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

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

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

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 context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

pub fn body(self, input: Blob) -> Self

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

pub fn set_body(self, input: Option<Blob>) -> Self

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

pub fn get_body(&self) -> &Option<Blob>

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

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

Consumes the builder and constructs a ImportRestApiInput.

impl ImportRestApiInputBuilder

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

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ImportRestApiInputBuilder

fn clone(&self) -> ImportRestApiInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImportRestApiInputBuilder

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

Formats the value using the given formatter.

impl Default for ImportRestApiInputBuilder

fn default() -> ImportRestApiInputBuilder

Returns the “default value” for a type.

impl PartialEq<ImportRestApiInputBuilder> for ImportRestApiInputBuilder

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