#[non_exhaustive]pub struct CreateRestApiInputBuilder { /* private fields */ }
Expand description
A builder for CreateRestApiInput
.
Implementations§
Source§impl CreateRestApiInputBuilder
impl CreateRestApiInputBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the RestApi.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the RestApi.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the RestApi.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the RestApi.
Sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
A version identifier for the API.
Sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
A version identifier for the API.
Sourcepub fn clone_from(self, input: impl Into<String>) -> Self
pub fn clone_from(self, input: impl Into<String>) -> Self
The ID of the RestApi that you want to clone from.
Sourcepub fn set_clone_from(self, input: Option<String>) -> Self
pub fn set_clone_from(self, input: Option<String>) -> Self
The ID of the RestApi that you want to clone from.
Sourcepub fn get_clone_from(&self) -> &Option<String>
pub fn get_clone_from(&self) -> &Option<String>
The ID of the RestApi that you want to clone from.
Sourcepub fn binary_media_types(self, input: impl Into<String>) -> Self
pub fn binary_media_types(self, input: impl Into<String>) -> Self
Appends an item to binary_media_types
.
To override the contents of this collection use set_binary_media_types
.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Sourcepub fn set_binary_media_types(self, input: Option<Vec<String>>) -> Self
pub fn set_binary_media_types(self, input: Option<Vec<String>>) -> Self
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Sourcepub fn get_binary_media_types(&self) -> &Option<Vec<String>>
pub fn get_binary_media_types(&self) -> &Option<Vec<String>>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Sourcepub fn minimum_compression_size(self, input: i32) -> Self
pub fn minimum_compression_size(self, input: i32) -> Self
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Sourcepub fn set_minimum_compression_size(self, input: Option<i32>) -> Self
pub fn set_minimum_compression_size(self, input: Option<i32>) -> Self
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Sourcepub fn get_minimum_compression_size(&self) -> &Option<i32>
pub fn get_minimum_compression_size(&self) -> &Option<i32>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
Sourcepub fn api_key_source(self, input: ApiKeySourceType) -> Self
pub fn api_key_source(self, input: ApiKeySourceType) -> Self
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
Sourcepub fn set_api_key_source(self, input: Option<ApiKeySourceType>) -> Self
pub fn set_api_key_source(self, input: Option<ApiKeySourceType>) -> Self
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
Sourcepub fn get_api_key_source(&self) -> &Option<ApiKeySourceType>
pub fn get_api_key_source(&self) -> &Option<ApiKeySourceType>
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
Sourcepub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self
pub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
Sourcepub fn set_endpoint_configuration(
self,
input: Option<EndpointConfiguration>,
) -> Self
pub fn set_endpoint_configuration( self, input: Option<EndpointConfiguration>, ) -> Self
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
Sourcepub fn get_endpoint_configuration(&self) -> &Option<EndpointConfiguration>
pub fn get_endpoint_configuration(&self) -> &Option<EndpointConfiguration>
The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.
Sourcepub fn policy(self, input: impl Into<String>) -> Self
pub fn policy(self, input: impl Into<String>) -> Self
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Sourcepub fn set_policy(self, input: Option<String>) -> Self
pub fn set_policy(self, input: Option<String>) -> Self
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Sourcepub fn get_policy(&self) -> &Option<String>
pub fn get_policy(&self) -> &Option<String>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is \[a-zA-Z+-=._:/\]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
Sourcepub fn disable_execute_api_endpoint(self, input: bool) -> Self
pub fn disable_execute_api_endpoint(self, input: bool) -> Self
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
Sourcepub fn set_disable_execute_api_endpoint(self, input: Option<bool>) -> Self
pub fn set_disable_execute_api_endpoint(self, input: Option<bool>) -> Self
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
Sourcepub fn get_disable_execute_api_endpoint(&self) -> &Option<bool>
pub fn get_disable_execute_api_endpoint(&self) -> &Option<bool>
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
Sourcepub fn build(self) -> Result<CreateRestApiInput, BuildError>
pub fn build(self) -> Result<CreateRestApiInput, BuildError>
Consumes the builder and constructs a CreateRestApiInput
.
Source§impl CreateRestApiInputBuilder
impl CreateRestApiInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateRestApiOutput, SdkError<CreateRestApiError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateRestApiOutput, SdkError<CreateRestApiError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateRestApiInputBuilder
impl Clone for CreateRestApiInputBuilder
Source§fn clone(&self) -> CreateRestApiInputBuilder
fn clone(&self) -> CreateRestApiInputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateRestApiInputBuilder
impl Debug for CreateRestApiInputBuilder
Source§impl Default for CreateRestApiInputBuilder
impl Default for CreateRestApiInputBuilder
Source§fn default() -> CreateRestApiInputBuilder
fn default() -> CreateRestApiInputBuilder
Source§impl PartialEq for CreateRestApiInputBuilder
impl PartialEq for CreateRestApiInputBuilder
Source§fn eq(&self, other: &CreateRestApiInputBuilder) -> bool
fn eq(&self, other: &CreateRestApiInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateRestApiInputBuilder
Auto Trait Implementations§
impl Freeze for CreateRestApiInputBuilder
impl RefUnwindSafe for CreateRestApiInputBuilder
impl Send for CreateRestApiInputBuilder
impl Sync for CreateRestApiInputBuilder
impl Unpin for CreateRestApiInputBuilder
impl UnwindSafe for CreateRestApiInputBuilder
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);