Struct aws_sdk_apigateway::operation::put_rest_api::builders::PutRestApiInputBuilder

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

A builder for PutRestApiInput.

Implementations

impl PutRestApiInputBuilder

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

The string identifier of the associated RestApi.

This field is required.

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

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

pub fn mode(self, input: PutMode) -> Self

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

pub fn set_mode(self, input: Option<PutMode>) -> Self

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

pub fn get_mode(&self) -> &Option<PutMode>

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

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

A query parameter to indicate whether to rollback the API update (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 update (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 update (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.

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

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

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

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

The PUT 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.

This field is required.

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

The PUT 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 PUT 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<PutRestApiInput, BuildError>

Consumes the builder and constructs a PutRestApiInput.

impl PutRestApiInputBuilder

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

Sends a request with this input using the given client.

Trait Implementations

impl Clone for PutRestApiInputBuilder

fn clone(&self) -> PutRestApiInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutRestApiInputBuilder

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

Formats the value using the given formatter.

impl Default for PutRestApiInputBuilder

fn default() -> PutRestApiInputBuilder

Returns the “default value” for a type.

impl PartialEq for PutRestApiInputBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PutRestApiInputBuilder