GetGuardrailOutputBuilder

Struct GetGuardrailOutputBuilder 

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

A builder for GetGuardrailOutput.

Implementations§

Source§

impl GetGuardrailOutputBuilder

Source

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

The name of the guardrail.

This field is required.
Source

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

The name of the guardrail.

Source

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

The name of the guardrail.

Source

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

The description of the guardrail.

Source

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

The description of the guardrail.

Source

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

The description of the guardrail.

Source

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

The unique identifier of the guardrail.

This field is required.
Source

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

The unique identifier of the guardrail.

Source

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

The unique identifier of the guardrail.

Source

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

The ARN of the guardrail.

This field is required.
Source

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

The ARN of the guardrail.

Source

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

The ARN of the guardrail.

Source

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

The version of the guardrail.

This field is required.
Source

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

The version of the guardrail.

Source

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

The version of the guardrail.

Source

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

The status of the guardrail.

This field is required.
Source

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

The status of the guardrail.

Source

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

The status of the guardrail.

Source

pub fn topic_policy(self, input: GuardrailTopicPolicy) -> Self

The topic policy that was configured for the guardrail.

Source

pub fn set_topic_policy(self, input: Option<GuardrailTopicPolicy>) -> Self

The topic policy that was configured for the guardrail.

Source

pub fn get_topic_policy(&self) -> &Option<GuardrailTopicPolicy>

The topic policy that was configured for the guardrail.

Source

pub fn content_policy(self, input: GuardrailContentPolicy) -> Self

The content policy that was configured for the guardrail.

Source

pub fn set_content_policy(self, input: Option<GuardrailContentPolicy>) -> Self

The content policy that was configured for the guardrail.

Source

pub fn get_content_policy(&self) -> &Option<GuardrailContentPolicy>

The content policy that was configured for the guardrail.

Source

pub fn word_policy(self, input: GuardrailWordPolicy) -> Self

The word policy that was configured for the guardrail.

Source

pub fn set_word_policy(self, input: Option<GuardrailWordPolicy>) -> Self

The word policy that was configured for the guardrail.

Source

pub fn get_word_policy(&self) -> &Option<GuardrailWordPolicy>

The word policy that was configured for the guardrail.

Source

pub fn sensitive_information_policy( self, input: GuardrailSensitiveInformationPolicy, ) -> Self

The sensitive information policy that was configured for the guardrail.

Source

pub fn set_sensitive_information_policy( self, input: Option<GuardrailSensitiveInformationPolicy>, ) -> Self

The sensitive information policy that was configured for the guardrail.

Source

pub fn get_sensitive_information_policy( &self, ) -> &Option<GuardrailSensitiveInformationPolicy>

The sensitive information policy that was configured for the guardrail.

Source

pub fn contextual_grounding_policy( self, input: GuardrailContextualGroundingPolicy, ) -> Self

The contextual grounding policy used in the guardrail.

Source

pub fn set_contextual_grounding_policy( self, input: Option<GuardrailContextualGroundingPolicy>, ) -> Self

The contextual grounding policy used in the guardrail.

Source

pub fn get_contextual_grounding_policy( &self, ) -> &Option<GuardrailContextualGroundingPolicy>

The contextual grounding policy used in the guardrail.

Source

pub fn automated_reasoning_policy( self, input: GuardrailAutomatedReasoningPolicy, ) -> Self

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

Source

pub fn set_automated_reasoning_policy( self, input: Option<GuardrailAutomatedReasoningPolicy>, ) -> Self

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

Source

pub fn get_automated_reasoning_policy( &self, ) -> &Option<GuardrailAutomatedReasoningPolicy>

The current Automated Reasoning policy configuration for the guardrail, if any is configured.

Source

pub fn cross_region_details(self, input: GuardrailCrossRegionDetails) -> Self

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Source

pub fn set_cross_region_details( self, input: Option<GuardrailCrossRegionDetails>, ) -> Self

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Source

pub fn get_cross_region_details(&self) -> &Option<GuardrailCrossRegionDetails>

Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).

Source

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

The date and time at which the guardrail was created.

This field is required.
Source

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

The date and time at which the guardrail was created.

Source

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

The date and time at which the guardrail was created.

Source

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

The date and time at which the guardrail was updated.

This field is required.
Source

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

The date and time at which the guardrail was updated.

Source

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

The date and time at which the guardrail was updated.

Source

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

Appends an item to status_reasons.

To override the contents of this collection use set_status_reasons.

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Source

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

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Source

pub fn get_status_reasons(&self) -> &Option<Vec<String>>

Appears if the status is FAILED. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

Source

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

Appends an item to failure_recommendations.

To override the contents of this collection use set_failure_recommendations.

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Source

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

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Source

pub fn get_failure_recommendations(&self) -> &Option<Vec<String>>

Appears if the status of the guardrail is FAILED. A list of recommendations to carry out before retrying the request.

Source

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

The message that the guardrail returns when it blocks a prompt.

This field is required.
Source

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

The message that the guardrail returns when it blocks a prompt.

Source

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

The message that the guardrail returns when it blocks a prompt.

Source

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

The message that the guardrail returns when it blocks a model response.

This field is required.
Source

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

The message that the guardrail returns when it blocks a model response.

Source

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

The message that the guardrail returns when it blocks a model response.

Source

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

The ARN of the KMS key that encrypts the guardrail.

Source

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

The ARN of the KMS key that encrypts the guardrail.

Source

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

The ARN of the KMS key that encrypts the guardrail.

Source

pub fn build(self) -> Result<GetGuardrailOutput, BuildError>

Consumes the builder and constructs a GetGuardrailOutput. This method will fail if any of the following fields are not set:

Trait Implementations§

Source§

impl Clone for GetGuardrailOutputBuilder

Source§

fn clone(&self) -> GetGuardrailOutputBuilder

Returns a duplicate 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 GetGuardrailOutputBuilder

Source§

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

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

impl Default for GetGuardrailOutputBuilder

Source§

fn default() -> GetGuardrailOutputBuilder

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

impl PartialEq for GetGuardrailOutputBuilder

Source§

fn eq(&self, other: &GetGuardrailOutputBuilder) -> 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 GetGuardrailOutputBuilder

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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