#[non_exhaustive]pub struct CheckpointConfigurationBuilder { /* private fields */ }
Expand description
A builder for CheckpointConfiguration
.
Implementations§
source§impl CheckpointConfigurationBuilder
impl CheckpointConfigurationBuilder
sourcepub fn configuration_type(self, input: ConfigurationType) -> Self
pub fn configuration_type(self, input: ConfigurationType) -> Self
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
-
CheckpointingEnabled: true
-
CheckpointInterval: 60000
-
MinPauseBetweenCheckpoints: 5000
sourcepub fn set_configuration_type(self, input: Option<ConfigurationType>) -> Self
pub fn set_configuration_type(self, input: Option<ConfigurationType>) -> Self
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
-
CheckpointingEnabled: true
-
CheckpointInterval: 60000
-
MinPauseBetweenCheckpoints: 5000
sourcepub fn get_configuration_type(&self) -> &Option<ConfigurationType>
pub fn get_configuration_type(&self) -> &Option<ConfigurationType>
Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM
in order to set the CheckpointingEnabled
, CheckpointInterval
, or MinPauseBetweenCheckpoints
parameters.
If this value is set to DEFAULT
, the application will use the following values, even if they are set to other values using APIs or application code:
-
CheckpointingEnabled: true
-
CheckpointInterval: 60000
-
MinPauseBetweenCheckpoints: 5000
sourcepub fn checkpointing_enabled(self, input: bool) -> Self
pub fn checkpointing_enabled(self, input: bool) -> Self
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
sourcepub fn set_checkpointing_enabled(self, input: Option<bool>) -> Self
pub fn set_checkpointing_enabled(self, input: Option<bool>) -> Self
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
sourcepub fn get_checkpointing_enabled(&self) -> &Option<bool>
pub fn get_checkpointing_enabled(&self) -> &Option<bool>
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointingEnabled
value of true
, even if this value is set to another value using this API or in application code.
sourcepub fn checkpoint_interval(self, input: i64) -> Self
pub fn checkpoint_interval(self, input: i64) -> Self
Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
sourcepub fn set_checkpoint_interval(self, input: Option<i64>) -> Self
pub fn set_checkpoint_interval(self, input: Option<i64>) -> Self
Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
sourcepub fn get_checkpoint_interval(&self) -> &Option<i64>
pub fn get_checkpoint_interval(&self) -> &Option<i64>
Describes the interval in milliseconds between checkpoint operations.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a CheckpointInterval
value of 60000, even if this value is set to another value using this API or in application code.
sourcepub fn min_pause_between_checkpoints(self, input: i64) -> Self
pub fn min_pause_between_checkpoints(self, input: i64) -> Self
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
sourcepub fn set_min_pause_between_checkpoints(self, input: Option<i64>) -> Self
pub fn set_min_pause_between_checkpoints(self, input: Option<i64>) -> Self
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
sourcepub fn get_min_pause_between_checkpoints(&self) -> &Option<i64>
pub fn get_min_pause_between_checkpoints(&self) -> &Option<i64>
Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval
, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.
If CheckpointConfiguration.ConfigurationType
is DEFAULT
, the application will use a MinPauseBetweenCheckpoints
value of 5000, even if this value is set using this API or in application code.
sourcepub fn build(self) -> Result<CheckpointConfiguration, BuildError>
pub fn build(self) -> Result<CheckpointConfiguration, BuildError>
Consumes the builder and constructs a CheckpointConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for CheckpointConfigurationBuilder
impl Clone for CheckpointConfigurationBuilder
source§fn clone(&self) -> CheckpointConfigurationBuilder
fn clone(&self) -> CheckpointConfigurationBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for CheckpointConfigurationBuilder
impl Default for CheckpointConfigurationBuilder
source§fn default() -> CheckpointConfigurationBuilder
fn default() -> CheckpointConfigurationBuilder
source§impl PartialEq for CheckpointConfigurationBuilder
impl PartialEq for CheckpointConfigurationBuilder
source§fn eq(&self, other: &CheckpointConfigurationBuilder) -> bool
fn eq(&self, other: &CheckpointConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CheckpointConfigurationBuilder
Auto Trait Implementations§
impl Freeze for CheckpointConfigurationBuilder
impl RefUnwindSafe for CheckpointConfigurationBuilder
impl Send for CheckpointConfigurationBuilder
impl Sync for CheckpointConfigurationBuilder
impl Unpin for CheckpointConfigurationBuilder
impl UnwindSafe for CheckpointConfigurationBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);