#[non_exhaustive]pub struct CacheNodeTypeSpecificParameter {
pub parameter_name: Option<String>,
pub description: Option<String>,
pub source: Option<String>,
pub data_type: Option<String>,
pub allowed_values: Option<String>,
pub is_modifiable: Option<bool>,
pub minimum_engine_version: Option<String>,
pub cache_node_type_specific_values: Option<Vec<CacheNodeTypeSpecificValue>>,
pub change_type: Option<ChangeType>,
}
Expand description
A parameter that has a different value for each cache node type it is applied to. For example, in a Valkey or Redis OSS cluster, a cache.m1.large
cache node type would have a larger maxmemory
value than a cache.m1.small
type.
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.parameter_name: Option<String>
The name of the parameter.
description: Option<String>
A description of the parameter.
source: Option<String>
The source of the parameter value.
data_type: Option<String>
The valid data type for the parameter.
allowed_values: Option<String>
The valid range of values for the parameter.
is_modifiable: Option<bool>
Indicates whether (true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
minimum_engine_version: Option<String>
The earliest cache engine version to which the parameter can apply.
cache_node_type_specific_values: Option<Vec<CacheNodeTypeSpecificValue>>
A list of cache node types and their corresponding values for this parameter.
change_type: Option<ChangeType>
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
Implementations§
Source§impl CacheNodeTypeSpecificParameter
impl CacheNodeTypeSpecificParameter
Sourcepub fn parameter_name(&self) -> Option<&str>
pub fn parameter_name(&self) -> Option<&str>
The name of the parameter.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the parameter.
Sourcepub fn allowed_values(&self) -> Option<&str>
pub fn allowed_values(&self) -> Option<&str>
The valid range of values for the parameter.
Sourcepub fn is_modifiable(&self) -> Option<bool>
pub fn is_modifiable(&self) -> Option<bool>
Indicates whether (true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Sourcepub fn minimum_engine_version(&self) -> Option<&str>
pub fn minimum_engine_version(&self) -> Option<&str>
The earliest cache engine version to which the parameter can apply.
Sourcepub fn cache_node_type_specific_values(&self) -> &[CacheNodeTypeSpecificValue]
pub fn cache_node_type_specific_values(&self) -> &[CacheNodeTypeSpecificValue]
A list of cache node types and their corresponding values for this parameter.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .cache_node_type_specific_values.is_none()
.
Sourcepub fn change_type(&self) -> Option<&ChangeType>
pub fn change_type(&self) -> Option<&ChangeType>
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.
Source§impl CacheNodeTypeSpecificParameter
impl CacheNodeTypeSpecificParameter
Sourcepub fn builder() -> CacheNodeTypeSpecificParameterBuilder
pub fn builder() -> CacheNodeTypeSpecificParameterBuilder
Creates a new builder-style object to manufacture CacheNodeTypeSpecificParameter
.
Trait Implementations§
Source§impl Clone for CacheNodeTypeSpecificParameter
impl Clone for CacheNodeTypeSpecificParameter
Source§fn clone(&self) -> CacheNodeTypeSpecificParameter
fn clone(&self) -> CacheNodeTypeSpecificParameter
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for CacheNodeTypeSpecificParameter
impl PartialEq for CacheNodeTypeSpecificParameter
Source§fn eq(&self, other: &CacheNodeTypeSpecificParameter) -> bool
fn eq(&self, other: &CacheNodeTypeSpecificParameter) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CacheNodeTypeSpecificParameter
Auto Trait Implementations§
impl Freeze for CacheNodeTypeSpecificParameter
impl RefUnwindSafe for CacheNodeTypeSpecificParameter
impl Send for CacheNodeTypeSpecificParameter
impl Sync for CacheNodeTypeSpecificParameter
impl Unpin for CacheNodeTypeSpecificParameter
impl UnwindSafe for CacheNodeTypeSpecificParameter
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);