#[non_exhaustive]pub struct AuthenticationDescriptionBuilder { /* private fields */ }
Expand description
A builder for AuthenticationDescription
.
Implementations§
Source§impl AuthenticationDescriptionBuilder
impl AuthenticationDescriptionBuilder
Sourcepub fn providers(self, input: AuthenticationProviderTypes) -> Self
pub fn providers(self, input: AuthenticationProviderTypes) -> Self
Appends an item to providers
.
To override the contents of this collection use set_providers
.
Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
Sourcepub fn set_providers(
self,
input: Option<Vec<AuthenticationProviderTypes>>,
) -> Self
pub fn set_providers( self, input: Option<Vec<AuthenticationProviderTypes>>, ) -> Self
Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
Sourcepub fn get_providers(&self) -> &Option<Vec<AuthenticationProviderTypes>>
pub fn get_providers(&self) -> &Option<Vec<AuthenticationProviderTypes>>
Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace.
Sourcepub fn saml(self, input: SamlAuthentication) -> Self
pub fn saml(self, input: SamlAuthentication) -> Self
A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
Sourcepub fn set_saml(self, input: Option<SamlAuthentication>) -> Self
pub fn set_saml(self, input: Option<SamlAuthentication>) -> Self
A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
Sourcepub fn get_saml(&self) -> &Option<SamlAuthentication>
pub fn get_saml(&self) -> &Option<SamlAuthentication>
A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace.
Sourcepub fn aws_sso(self, input: AwsSsoAuthentication) -> Self
pub fn aws_sso(self, input: AwsSsoAuthentication) -> Self
A structure containing information about how this workspace works with IAM Identity Center.
Sourcepub fn set_aws_sso(self, input: Option<AwsSsoAuthentication>) -> Self
pub fn set_aws_sso(self, input: Option<AwsSsoAuthentication>) -> Self
A structure containing information about how this workspace works with IAM Identity Center.
Sourcepub fn get_aws_sso(&self) -> &Option<AwsSsoAuthentication>
pub fn get_aws_sso(&self) -> &Option<AwsSsoAuthentication>
A structure containing information about how this workspace works with IAM Identity Center.
Sourcepub fn build(self) -> Result<AuthenticationDescription, BuildError>
pub fn build(self) -> Result<AuthenticationDescription, BuildError>
Consumes the builder and constructs a AuthenticationDescription
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AuthenticationDescriptionBuilder
impl Clone for AuthenticationDescriptionBuilder
Source§fn clone(&self) -> AuthenticationDescriptionBuilder
fn clone(&self) -> AuthenticationDescriptionBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AuthenticationDescriptionBuilder
impl Default for AuthenticationDescriptionBuilder
Source§fn default() -> AuthenticationDescriptionBuilder
fn default() -> AuthenticationDescriptionBuilder
Source§impl PartialEq for AuthenticationDescriptionBuilder
impl PartialEq for AuthenticationDescriptionBuilder
Source§fn eq(&self, other: &AuthenticationDescriptionBuilder) -> bool
fn eq(&self, other: &AuthenticationDescriptionBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AuthenticationDescriptionBuilder
Auto Trait Implementations§
impl Freeze for AuthenticationDescriptionBuilder
impl RefUnwindSafe for AuthenticationDescriptionBuilder
impl Send for AuthenticationDescriptionBuilder
impl Sync for AuthenticationDescriptionBuilder
impl Unpin for AuthenticationDescriptionBuilder
impl UnwindSafe for AuthenticationDescriptionBuilder
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);