#[non_exhaustive]pub struct ExportApiInputBuilder { /* private fields */ }
Expand description
A builder for ExportApiInput
.
Implementations§
Source§impl ExportApiInputBuilder
impl ExportApiInputBuilder
Sourcepub fn api_id(self, input: impl Into<String>) -> Self
pub fn api_id(self, input: impl Into<String>) -> Self
The API identifier.
This field is required.Sourcepub fn set_api_id(self, input: Option<String>) -> Self
pub fn set_api_id(self, input: Option<String>) -> Self
The API identifier.
Sourcepub fn get_api_id(&self) -> &Option<String>
pub fn get_api_id(&self) -> &Option<String>
The API identifier.
Sourcepub fn export_version(self, input: impl Into<String>) -> Self
pub fn export_version(self, input: impl Into<String>) -> Self
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
Sourcepub fn set_export_version(self, input: Option<String>) -> Self
pub fn set_export_version(self, input: Option<String>) -> Self
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
Sourcepub fn get_export_version(&self) -> &Option<String>
pub fn get_export_version(&self) -> &Option<String>
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
Sourcepub fn include_extensions(self, input: bool) -> Self
pub fn include_extensions(self, input: bool) -> Self
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
Sourcepub fn set_include_extensions(self, input: Option<bool>) -> Self
pub fn set_include_extensions(self, input: Option<bool>) -> Self
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
Sourcepub fn get_include_extensions(&self) -> &Option<bool>
pub fn get_include_extensions(&self) -> &Option<bool>
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
Sourcepub fn output_type(self, input: impl Into<String>) -> Self
pub fn output_type(self, input: impl Into<String>) -> Self
The output type of the exported definition file. Valid values are JSON and YAML.
This field is required.Sourcepub fn set_output_type(self, input: Option<String>) -> Self
pub fn set_output_type(self, input: Option<String>) -> Self
The output type of the exported definition file. Valid values are JSON and YAML.
Sourcepub fn get_output_type(&self) -> &Option<String>
pub fn get_output_type(&self) -> &Option<String>
The output type of the exported definition file. Valid values are JSON and YAML.
Sourcepub fn specification(self, input: impl Into<String>) -> Self
pub fn specification(self, input: impl Into<String>) -> Self
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
This field is required.Sourcepub fn set_specification(self, input: Option<String>) -> Self
pub fn set_specification(self, input: Option<String>) -> Self
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
Sourcepub fn get_specification(&self) -> &Option<String>
pub fn get_specification(&self) -> &Option<String>
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
Sourcepub fn stage_name(self, input: impl Into<String>) -> Self
pub fn stage_name(self, input: impl Into<String>) -> Self
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is 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 API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
Sourcepub fn get_stage_name(&self) -> &Option<String>
pub fn get_stage_name(&self) -> &Option<String>
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
Sourcepub fn build(self) -> Result<ExportApiInput, BuildError>
pub fn build(self) -> Result<ExportApiInput, BuildError>
Consumes the builder and constructs a ExportApiInput
.
Source§impl ExportApiInputBuilder
impl ExportApiInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<ExportApiOutput, SdkError<ExportApiError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<ExportApiOutput, SdkError<ExportApiError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for ExportApiInputBuilder
impl Clone for ExportApiInputBuilder
Source§fn clone(&self) -> ExportApiInputBuilder
fn clone(&self) -> ExportApiInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ExportApiInputBuilder
impl Debug for ExportApiInputBuilder
Source§impl Default for ExportApiInputBuilder
impl Default for ExportApiInputBuilder
Source§fn default() -> ExportApiInputBuilder
fn default() -> ExportApiInputBuilder
Source§impl PartialEq for ExportApiInputBuilder
impl PartialEq for ExportApiInputBuilder
impl StructuralPartialEq for ExportApiInputBuilder
Auto Trait Implementations§
impl Freeze for ExportApiInputBuilder
impl RefUnwindSafe for ExportApiInputBuilder
impl Send for ExportApiInputBuilder
impl Sync for ExportApiInputBuilder
impl Unpin for ExportApiInputBuilder
impl UnwindSafe for ExportApiInputBuilder
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);