#[non_exhaustive]pub struct MethodSetting {
pub metrics_enabled: bool,
pub logging_level: Option<String>,
pub data_trace_enabled: bool,
pub throttling_burst_limit: i32,
pub throttling_rate_limit: f64,
pub caching_enabled: bool,
pub cache_ttl_in_seconds: i32,
pub cache_data_encrypted: bool,
pub require_authorization_for_cache_control: bool,
pub unauthorized_cache_control_header_strategy: Option<UnauthorizedCacheControlHeaderStrategy>,
}Expand description
Specifies the method setting properties.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.metrics_enabled: boolSpecifies whether Amazon CloudWatch metrics are enabled for this method.
logging_level: Option<String>Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
data_trace_enabled: boolSpecifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
throttling_burst_limit: i32Specifies the throttling burst limit.
throttling_rate_limit: f64Specifies the throttling rate limit.
caching_enabled: boolSpecifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
cache_ttl_in_seconds: i32Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
cache_data_encrypted: boolSpecifies whether the cached responses are encrypted.
Specifies whether authorization is required for a cache invalidation request.
Specifies how to handle unauthorized requests for cache invalidation.
Implementations§
Source§impl MethodSetting
impl MethodSetting
Sourcepub fn metrics_enabled(&self) -> bool
pub fn metrics_enabled(&self) -> bool
Specifies whether Amazon CloudWatch metrics are enabled for this method.
Sourcepub fn logging_level(&self) -> Option<&str>
pub fn logging_level(&self) -> Option<&str>
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.
Sourcepub fn data_trace_enabled(&self) -> bool
pub fn data_trace_enabled(&self) -> bool
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
Sourcepub fn throttling_burst_limit(&self) -> i32
pub fn throttling_burst_limit(&self) -> i32
Specifies the throttling burst limit.
Sourcepub fn throttling_rate_limit(&self) -> f64
pub fn throttling_rate_limit(&self) -> f64
Specifies the throttling rate limit.
Sourcepub fn caching_enabled(&self) -> bool
pub fn caching_enabled(&self) -> bool
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
Sourcepub fn cache_ttl_in_seconds(&self) -> i32
pub fn cache_ttl_in_seconds(&self) -> i32
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
Sourcepub fn cache_data_encrypted(&self) -> bool
pub fn cache_data_encrypted(&self) -> bool
Specifies whether the cached responses are encrypted.
Specifies whether authorization is required for a cache invalidation request.
Specifies how to handle unauthorized requests for cache invalidation.
Source§impl MethodSetting
impl MethodSetting
Sourcepub fn builder() -> MethodSettingBuilder
pub fn builder() -> MethodSettingBuilder
Creates a new builder-style object to manufacture MethodSetting.
Trait Implementations§
Source§impl Clone for MethodSetting
impl Clone for MethodSetting
Source§fn clone(&self) -> MethodSetting
fn clone(&self) -> MethodSetting
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for MethodSetting
impl Debug for MethodSetting
Source§impl PartialEq for MethodSetting
impl PartialEq for MethodSetting
impl StructuralPartialEq for MethodSetting
Auto Trait Implementations§
impl Freeze for MethodSetting
impl RefUnwindSafe for MethodSetting
impl Send for MethodSetting
impl Sync for MethodSetting
impl Unpin for MethodSetting
impl UnwindSafe for MethodSetting
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);