#[non_exhaustive]pub struct PolicyGenerationBuilder { /* private fields */ }
Expand description
A builder for PolicyGeneration
.
Implementations§
Source§impl PolicyGenerationBuilder
impl PolicyGenerationBuilder
Sourcepub fn job_id(self, input: impl Into<String>) -> Self
pub fn job_id(self, input: impl Into<String>) -> Self
The JobId
that is returned by the StartPolicyGeneration
operation. The JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used with CancelPolicyGeneration
to cancel the policy generation request.
Sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The JobId
that is returned by the StartPolicyGeneration
operation. The JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used with CancelPolicyGeneration
to cancel the policy generation request.
Sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The JobId
that is returned by the StartPolicyGeneration
operation. The JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used with CancelPolicyGeneration
to cancel the policy generation request.
Sourcepub fn principal_arn(self, input: impl Into<String>) -> Self
pub fn principal_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM entity (user or role) for which you are generating a policy.
This field is required.Sourcepub fn set_principal_arn(self, input: Option<String>) -> Self
pub fn set_principal_arn(self, input: Option<String>) -> Self
The ARN of the IAM entity (user or role) for which you are generating a policy.
Sourcepub fn get_principal_arn(&self) -> &Option<String>
pub fn get_principal_arn(&self) -> &Option<String>
The ARN of the IAM entity (user or role) for which you are generating a policy.
Sourcepub fn status(self, input: JobStatus) -> Self
pub fn status(self, input: JobStatus) -> Self
The status of the policy generation request.
This field is required.Sourcepub fn set_status(self, input: Option<JobStatus>) -> Self
pub fn set_status(self, input: Option<JobStatus>) -> Self
The status of the policy generation request.
Sourcepub fn get_status(&self) -> &Option<JobStatus>
pub fn get_status(&self) -> &Option<JobStatus>
The status of the policy generation request.
Sourcepub fn started_on(self, input: DateTime) -> Self
pub fn started_on(self, input: DateTime) -> Self
A timestamp of when the policy generation started.
This field is required.Sourcepub fn set_started_on(self, input: Option<DateTime>) -> Self
pub fn set_started_on(self, input: Option<DateTime>) -> Self
A timestamp of when the policy generation started.
Sourcepub fn get_started_on(&self) -> &Option<DateTime>
pub fn get_started_on(&self) -> &Option<DateTime>
A timestamp of when the policy generation started.
Sourcepub fn completed_on(self, input: DateTime) -> Self
pub fn completed_on(self, input: DateTime) -> Self
A timestamp of when the policy generation was completed.
Sourcepub fn set_completed_on(self, input: Option<DateTime>) -> Self
pub fn set_completed_on(self, input: Option<DateTime>) -> Self
A timestamp of when the policy generation was completed.
Sourcepub fn get_completed_on(&self) -> &Option<DateTime>
pub fn get_completed_on(&self) -> &Option<DateTime>
A timestamp of when the policy generation was completed.
Sourcepub fn build(self) -> Result<PolicyGeneration, BuildError>
pub fn build(self) -> Result<PolicyGeneration, BuildError>
Consumes the builder and constructs a PolicyGeneration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for PolicyGenerationBuilder
impl Clone for PolicyGenerationBuilder
Source§fn clone(&self) -> PolicyGenerationBuilder
fn clone(&self) -> PolicyGenerationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PolicyGenerationBuilder
impl Debug for PolicyGenerationBuilder
Source§impl Default for PolicyGenerationBuilder
impl Default for PolicyGenerationBuilder
Source§fn default() -> PolicyGenerationBuilder
fn default() -> PolicyGenerationBuilder
Source§impl PartialEq for PolicyGenerationBuilder
impl PartialEq for PolicyGenerationBuilder
impl StructuralPartialEq for PolicyGenerationBuilder
Auto Trait Implementations§
impl Freeze for PolicyGenerationBuilder
impl RefUnwindSafe for PolicyGenerationBuilder
impl Send for PolicyGenerationBuilder
impl Sync for PolicyGenerationBuilder
impl Unpin for PolicyGenerationBuilder
impl UnwindSafe for PolicyGenerationBuilder
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);