#[non_exhaustive]pub struct ReplicaGlobalSecondaryIndexBuilder { /* private fields */ }
Expand description
A builder for ReplicaGlobalSecondaryIndex
.
Implementations§
source§impl ReplicaGlobalSecondaryIndexBuilder
impl ReplicaGlobalSecondaryIndexBuilder
sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The name of the global secondary index.
This field is required.sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The name of the global secondary index.
sourcepub fn get_index_name(&self) -> &Option<String>
pub fn get_index_name(&self) -> &Option<String>
The name of the global secondary index.
sourcepub fn provisioned_throughput_override(
self,
input: ProvisionedThroughputOverride,
) -> Self
pub fn provisioned_throughput_override( self, input: ProvisionedThroughputOverride, ) -> Self
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
sourcepub fn set_provisioned_throughput_override(
self,
input: Option<ProvisionedThroughputOverride>,
) -> Self
pub fn set_provisioned_throughput_override( self, input: Option<ProvisionedThroughputOverride>, ) -> Self
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
sourcepub fn get_provisioned_throughput_override(
&self,
) -> &Option<ProvisionedThroughputOverride>
pub fn get_provisioned_throughput_override( &self, ) -> &Option<ProvisionedThroughputOverride>
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
sourcepub fn on_demand_throughput_override(
self,
input: OnDemandThroughputOverride,
) -> Self
pub fn on_demand_throughput_override( self, input: OnDemandThroughputOverride, ) -> Self
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
sourcepub fn set_on_demand_throughput_override(
self,
input: Option<OnDemandThroughputOverride>,
) -> Self
pub fn set_on_demand_throughput_override( self, input: Option<OnDemandThroughputOverride>, ) -> Self
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
sourcepub fn get_on_demand_throughput_override(
&self,
) -> &Option<OnDemandThroughputOverride>
pub fn get_on_demand_throughput_override( &self, ) -> &Option<OnDemandThroughputOverride>
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
sourcepub fn build(self) -> Result<ReplicaGlobalSecondaryIndex, BuildError>
pub fn build(self) -> Result<ReplicaGlobalSecondaryIndex, BuildError>
Consumes the builder and constructs a ReplicaGlobalSecondaryIndex
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for ReplicaGlobalSecondaryIndexBuilder
impl Clone for ReplicaGlobalSecondaryIndexBuilder
source§fn clone(&self) -> ReplicaGlobalSecondaryIndexBuilder
fn clone(&self) -> ReplicaGlobalSecondaryIndexBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for ReplicaGlobalSecondaryIndexBuilder
impl Default for ReplicaGlobalSecondaryIndexBuilder
source§fn default() -> ReplicaGlobalSecondaryIndexBuilder
fn default() -> ReplicaGlobalSecondaryIndexBuilder
source§impl PartialEq for ReplicaGlobalSecondaryIndexBuilder
impl PartialEq for ReplicaGlobalSecondaryIndexBuilder
source§fn eq(&self, other: &ReplicaGlobalSecondaryIndexBuilder) -> bool
fn eq(&self, other: &ReplicaGlobalSecondaryIndexBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ReplicaGlobalSecondaryIndexBuilder
Auto Trait Implementations§
impl Freeze for ReplicaGlobalSecondaryIndexBuilder
impl RefUnwindSafe for ReplicaGlobalSecondaryIndexBuilder
impl Send for ReplicaGlobalSecondaryIndexBuilder
impl Sync for ReplicaGlobalSecondaryIndexBuilder
impl Unpin for ReplicaGlobalSecondaryIndexBuilder
impl UnwindSafe for ReplicaGlobalSecondaryIndexBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();
§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.§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);