#[non_exhaustive]pub struct S3ActionBuilder { /* private fields */ }
Expand description
A builder for S3Action
.
Implementations§
Source§impl S3ActionBuilder
impl S3ActionBuilder
Sourcepub fn action_failure_policy(self, input: ActionFailurePolicy) -> Self
pub fn action_failure_policy(self, input: ActionFailurePolicy) -> Self
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
Sourcepub fn set_action_failure_policy(
self,
input: Option<ActionFailurePolicy>,
) -> Self
pub fn set_action_failure_policy( self, input: Option<ActionFailurePolicy>, ) -> Self
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
Sourcepub fn get_action_failure_policy(&self) -> &Option<ActionFailurePolicy>
pub fn get_action_failure_policy(&self) -> &Option<ActionFailurePolicy>
A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
Sourcepub fn s3_bucket(self, input: impl Into<String>) -> Self
pub fn s3_bucket(self, input: impl Into<String>) -> Self
The bucket name of the S3 bucket to write to.
This field is required.Sourcepub fn set_s3_bucket(self, input: Option<String>) -> Self
pub fn set_s3_bucket(self, input: Option<String>) -> Self
The bucket name of the S3 bucket to write to.
Sourcepub fn get_s3_bucket(&self) -> &Option<String>
pub fn get_s3_bucket(&self) -> &Option<String>
The bucket name of the S3 bucket to write to.
Sourcepub fn s3_prefix(self, input: impl Into<String>) -> Self
pub fn s3_prefix(self, input: impl Into<String>) -> Self
The S3 prefix to use for the write to the s3 bucket.
Sourcepub fn set_s3_prefix(self, input: Option<String>) -> Self
pub fn set_s3_prefix(self, input: Option<String>) -> Self
The S3 prefix to use for the write to the s3 bucket.
Sourcepub fn get_s3_prefix(&self) -> &Option<String>
pub fn get_s3_prefix(&self) -> &Option<String>
The S3 prefix to use for the write to the s3 bucket.
Sourcepub fn s3_sse_kms_key_id(self, input: impl Into<String>) -> Self
pub fn s3_sse_kms_key_id(self, input: impl Into<String>) -> Self
The KMS Key ID to use to encrypt the message in S3.
Sourcepub fn set_s3_sse_kms_key_id(self, input: Option<String>) -> Self
pub fn set_s3_sse_kms_key_id(self, input: Option<String>) -> Self
The KMS Key ID to use to encrypt the message in S3.
Sourcepub fn get_s3_sse_kms_key_id(&self) -> &Option<String>
pub fn get_s3_sse_kms_key_id(&self) -> &Option<String>
The KMS Key ID to use to encrypt the message in S3.
Trait Implementations§
Source§impl Clone for S3ActionBuilder
impl Clone for S3ActionBuilder
Source§fn clone(&self) -> S3ActionBuilder
fn clone(&self) -> S3ActionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for S3ActionBuilder
impl Debug for S3ActionBuilder
Source§impl Default for S3ActionBuilder
impl Default for S3ActionBuilder
Source§fn default() -> S3ActionBuilder
fn default() -> S3ActionBuilder
Source§impl PartialEq for S3ActionBuilder
impl PartialEq for S3ActionBuilder
impl StructuralPartialEq for S3ActionBuilder
Auto Trait Implementations§
impl Freeze for S3ActionBuilder
impl RefUnwindSafe for S3ActionBuilder
impl Send for S3ActionBuilder
impl Sync for S3ActionBuilder
impl Unpin for S3ActionBuilder
impl UnwindSafe for S3ActionBuilder
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);