pub struct GetExportFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetExport
.
Exports a deployed version of a RestApi in a specified format.
Implementations§
Source§impl GetExportFluentBuilder
impl GetExportFluentBuilder
Sourcepub fn as_input(&self) -> &GetExportInputBuilder
pub fn as_input(&self) -> &GetExportInputBuilder
Access the GetExport as a reference.
Sourcepub async fn send(
self,
) -> Result<GetExportOutput, SdkError<GetExportError, HttpResponse>>
pub async fn send( self, ) -> Result<GetExportOutput, SdkError<GetExportError, HttpResponse>>
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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<GetExportOutput, GetExportError, Self>
pub fn customize( self, ) -> CustomizableOperation<GetExportOutput, GetExportError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn rest_api_id(self, input: impl Into<String>) -> Self
pub fn rest_api_id(self, input: impl Into<String>) -> Self
The string identifier of the associated RestApi.
Sourcepub fn set_rest_api_id(self, input: Option<String>) -> Self
pub fn set_rest_api_id(self, input: Option<String>) -> Self
The string identifier of the associated RestApi.
Sourcepub fn get_rest_api_id(&self) -> &Option<String>
pub fn get_rest_api_id(&self) -> &Option<String>
The string identifier of the associated RestApi.
Sourcepub fn stage_name(self, input: impl Into<String>) -> Self
pub fn stage_name(self, input: impl Into<String>) -> Self
The name of the Stage that will be exported.
Sourcepub fn set_stage_name(self, input: Option<String>) -> Self
pub fn set_stage_name(self, input: Option<String>) -> Self
The name of the Stage that will be exported.
Sourcepub fn get_stage_name(&self) -> &Option<String>
pub fn get_stage_name(&self) -> &Option<String>
The name of the Stage that will be exported.
Sourcepub fn export_type(self, input: impl Into<String>) -> Self
pub fn export_type(self, input: impl Into<String>) -> Self
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
Sourcepub fn set_export_type(self, input: Option<String>) -> Self
pub fn set_export_type(self, input: Option<String>) -> Self
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
Sourcepub fn get_export_type(&self) -> &Option<String>
pub fn get_export_type(&self) -> &Option<String>
The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
Sourcepub fn parameters(self, k: impl Into<String>, v: impl Into<String>) -> Self
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
Sourcepub fn set_parameters(self, input: Option<HashMap<String, String>>) -> Self
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
Sourcepub fn get_parameters(&self) -> &Option<HashMap<String, String>>
pub fn get_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
Sourcepub fn accepts(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_accepts(self, input: Option<String>) -> Self
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.
Sourcepub fn get_accepts(&self) -> &Option<String>
pub fn get_accepts(&self) -> &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.
Trait Implementations§
Source§impl Clone for GetExportFluentBuilder
impl Clone for GetExportFluentBuilder
Source§fn clone(&self) -> GetExportFluentBuilder
fn clone(&self) -> GetExportFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for GetExportFluentBuilder
impl !RefUnwindSafe for GetExportFluentBuilder
impl Send for GetExportFluentBuilder
impl Sync for GetExportFluentBuilder
impl Unpin for GetExportFluentBuilder
impl !UnwindSafe for GetExportFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);