#[non_exhaustive]
pub struct GetWebExperienceOutputBuilder { /* private fields */ }
Expand description

A builder for GetWebExperienceOutput.

Implementations§

source§

impl GetWebExperienceOutputBuilder

source

pub fn application_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q Business application linked to the web experience.

source

pub fn set_application_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q Business application linked to the web experience.

source

pub fn get_application_id(&self) -> &Option<String>

The identifier of the Amazon Q Business application linked to the web experience.

source

pub fn web_experience_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q Business web experience.

source

pub fn set_web_experience_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q Business web experience.

source

pub fn get_web_experience_id(&self) -> &Option<String>

The identifier of the Amazon Q Business web experience.

source

pub fn web_experience_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

source

pub fn set_web_experience_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

source

pub fn get_web_experience_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

source

pub fn default_endpoint(self, input: impl Into<String>) -> Self

The endpoint of your Amazon Q Business web experience.

source

pub fn set_default_endpoint(self, input: Option<String>) -> Self

The endpoint of your Amazon Q Business web experience.

source

pub fn get_default_endpoint(&self) -> &Option<String>

The endpoint of your Amazon Q Business web experience.

source

pub fn status(self, input: WebExperienceStatus) -> Self

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn set_status(self, input: Option<WebExperienceStatus>) -> Self

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn get_status(&self) -> &Option<WebExperienceStatus>

The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn created_at(self, input: DateTime) -> Self

The Unix timestamp when the Amazon Q Business web experience was last created.

source

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The Unix timestamp when the Amazon Q Business web experience was last created.

source

pub fn get_created_at(&self) -> &Option<DateTime>

The Unix timestamp when the Amazon Q Business web experience was last created.

source

pub fn updated_at(self, input: DateTime) -> Self

The Unix timestamp when the Amazon Q Business web experience was last updated.

source

pub fn set_updated_at(self, input: Option<DateTime>) -> Self

The Unix timestamp when the Amazon Q Business web experience was last updated.

source

pub fn get_updated_at(&self) -> &Option<DateTime>

The Unix timestamp when the Amazon Q Business web experience was last updated.

source

pub fn title(self, input: impl Into<String>) -> Self

The title for your Amazon Q Business web experience.

source

pub fn set_title(self, input: Option<String>) -> Self

The title for your Amazon Q Business web experience.

source

pub fn get_title(&self) -> &Option<String>

The title for your Amazon Q Business web experience.

source

pub fn subtitle(self, input: impl Into<String>) -> Self

The subtitle for your Amazon Q Business web experience.

source

pub fn set_subtitle(self, input: Option<String>) -> Self

The subtitle for your Amazon Q Business web experience.

source

pub fn get_subtitle(&self) -> &Option<String>

The subtitle for your Amazon Q Business web experience.

source

pub fn welcome_message(self, input: impl Into<String>) -> Self

The customized welcome message for end users of an Amazon Q Business web experience.

source

pub fn set_welcome_message(self, input: Option<String>) -> Self

The customized welcome message for end users of an Amazon Q Business web experience.

source

pub fn get_welcome_message(&self) -> &Option<String>

The customized welcome message for end users of an Amazon Q Business web experience.

source

pub fn sample_prompts_control_mode( self, input: WebExperienceSamplePromptsControlMode, ) -> Self

Determines whether sample prompts are enabled in the web experience for an end user.

source

pub fn set_sample_prompts_control_mode( self, input: Option<WebExperienceSamplePromptsControlMode>, ) -> Self

Determines whether sample prompts are enabled in the web experience for an end user.

source

pub fn get_sample_prompts_control_mode( &self, ) -> &Option<WebExperienceSamplePromptsControlMode>

Determines whether sample prompts are enabled in the web experience for an end user.

source

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the service role attached to your web experience.

source

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the service role attached to your web experience.

source

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the service role attached to your web experience.

source

pub fn identity_provider_configuration( self, input: IdentityProviderConfiguration, ) -> Self

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

source

pub fn set_identity_provider_configuration( self, input: Option<IdentityProviderConfiguration>, ) -> Self

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

source

pub fn get_identity_provider_configuration( &self, ) -> &Option<IdentityProviderConfiguration>

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

source

pub fn authentication_configuration( self, input: WebExperienceAuthConfiguration, ) -> Self

👎Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration information for your Amazon Q Business web experience.

source

pub fn set_authentication_configuration( self, input: Option<WebExperienceAuthConfiguration>, ) -> Self

👎Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration information for your Amazon Q Business web experience.

source

pub fn get_authentication_configuration( &self, ) -> &Option<WebExperienceAuthConfiguration>

👎Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration information for your Amazon Q Business web experience.

source

pub fn error(self, input: ErrorDetail) -> Self

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn set_error(self, input: Option<ErrorDetail>) -> Self

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn get_error(&self) -> &Option<ErrorDetail>

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

source

pub fn build(self) -> GetWebExperienceOutput

Consumes the builder and constructs a GetWebExperienceOutput.

Trait Implementations§

source§

impl Clone for GetWebExperienceOutputBuilder

source§

fn clone(&self) -> GetWebExperienceOutputBuilder

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for GetWebExperienceOutputBuilder

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for GetWebExperienceOutputBuilder

source§

fn default() -> GetWebExperienceOutputBuilder

Returns the “default value” for a type. Read more
source§

impl PartialEq for GetWebExperienceOutputBuilder

source§

fn eq(&self, other: &GetWebExperienceOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for GetWebExperienceOutputBuilder

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Paint for T
where T: ?Sized,

source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
source§

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>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
source§

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>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
source§

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>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
source§

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>

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>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
source§

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>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
source§

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>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
source§

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>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
source§

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>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
source§

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);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more