#[non_exhaustive]pub struct AiGuardrailDataBuilder { /* private fields */ }
Expand description
A builder for AiGuardrailData
.
Implementations§
Source§impl AiGuardrailDataBuilder
impl AiGuardrailDataBuilder
Sourcepub fn assistant_id(self, input: impl Into<String>) -> Self
pub fn assistant_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
This field is required.Sourcepub fn set_assistant_id(self, input: Option<String>) -> Self
pub fn set_assistant_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn get_assistant_id(&self) -> &Option<String>
pub fn get_assistant_id(&self) -> &Option<String>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Sourcepub fn assistant_arn(self, input: impl Into<String>) -> Self
pub fn assistant_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
This field is required.Sourcepub fn set_assistant_arn(self, input: Option<String>) -> Self
pub fn set_assistant_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Sourcepub fn get_assistant_arn(&self) -> &Option<String>
pub fn get_assistant_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Sourcepub fn ai_guardrail_arn(self, input: impl Into<String>) -> Self
pub fn ai_guardrail_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the AI Guardrail.
This field is required.Sourcepub fn set_ai_guardrail_arn(self, input: Option<String>) -> Self
pub fn set_ai_guardrail_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the AI Guardrail.
Sourcepub fn get_ai_guardrail_arn(&self) -> &Option<String>
pub fn get_ai_guardrail_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the AI Guardrail.
Sourcepub fn ai_guardrail_id(self, input: impl Into<String>) -> Self
pub fn ai_guardrail_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q in Connect AI Guardrail.
This field is required.Sourcepub fn set_ai_guardrail_id(self, input: Option<String>) -> Self
pub fn set_ai_guardrail_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q in Connect AI Guardrail.
Sourcepub fn get_ai_guardrail_id(&self) -> &Option<String>
pub fn get_ai_guardrail_id(&self) -> &Option<String>
The identifier of the Amazon Q in Connect AI Guardrail.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the AI Guardrail.
This field is required.Sourcepub fn visibility_status(self, input: VisibilityStatus) -> Self
pub fn visibility_status(self, input: VisibilityStatus) -> Self
The visibility status of the AI Guardrail.
This field is required.Sourcepub fn set_visibility_status(self, input: Option<VisibilityStatus>) -> Self
pub fn set_visibility_status(self, input: Option<VisibilityStatus>) -> Self
The visibility status of the AI Guardrail.
Sourcepub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
pub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
The visibility status of the AI Guardrail.
Sourcepub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
The message to return when the AI Guardrail blocks a prompt.
This field is required.Sourcepub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
The message to return when the AI Guardrail blocks a prompt.
Sourcepub fn get_blocked_input_messaging(&self) -> &Option<String>
pub fn get_blocked_input_messaging(&self) -> &Option<String>
The message to return when the AI Guardrail blocks a prompt.
Sourcepub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
The message to return when the AI Guardrail blocks a model response.
This field is required.Sourcepub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
The message to return when the AI Guardrail blocks a model response.
Sourcepub fn get_blocked_outputs_messaging(&self) -> &Option<String>
pub fn get_blocked_outputs_messaging(&self) -> &Option<String>
The message to return when the AI Guardrail blocks a model response.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the AI Guardrail.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the AI Guardrail.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the AI Guardrail.
Sourcepub fn topic_policy_config(self, input: AiGuardrailTopicPolicyConfig) -> Self
pub fn topic_policy_config(self, input: AiGuardrailTopicPolicyConfig) -> Self
Contains details about topics that the AI Guardrail should identify and deny.
Sourcepub fn set_topic_policy_config(
self,
input: Option<AiGuardrailTopicPolicyConfig>,
) -> Self
pub fn set_topic_policy_config( self, input: Option<AiGuardrailTopicPolicyConfig>, ) -> Self
Contains details about topics that the AI Guardrail should identify and deny.
Sourcepub fn get_topic_policy_config(&self) -> &Option<AiGuardrailTopicPolicyConfig>
pub fn get_topic_policy_config(&self) -> &Option<AiGuardrailTopicPolicyConfig>
Contains details about topics that the AI Guardrail should identify and deny.
Sourcepub fn content_policy_config(
self,
input: AiGuardrailContentPolicyConfig,
) -> Self
pub fn content_policy_config( self, input: AiGuardrailContentPolicyConfig, ) -> Self
Contains details about how to handle harmful content.
Sourcepub fn set_content_policy_config(
self,
input: Option<AiGuardrailContentPolicyConfig>,
) -> Self
pub fn set_content_policy_config( self, input: Option<AiGuardrailContentPolicyConfig>, ) -> Self
Contains details about how to handle harmful content.
Sourcepub fn get_content_policy_config(
&self,
) -> &Option<AiGuardrailContentPolicyConfig>
pub fn get_content_policy_config( &self, ) -> &Option<AiGuardrailContentPolicyConfig>
Contains details about how to handle harmful content.
Sourcepub fn word_policy_config(self, input: AiGuardrailWordPolicyConfig) -> Self
pub fn word_policy_config(self, input: AiGuardrailWordPolicyConfig) -> Self
Contains details about the word policy to configured for the AI Guardrail.
Sourcepub fn set_word_policy_config(
self,
input: Option<AiGuardrailWordPolicyConfig>,
) -> Self
pub fn set_word_policy_config( self, input: Option<AiGuardrailWordPolicyConfig>, ) -> Self
Contains details about the word policy to configured for the AI Guardrail.
Sourcepub fn get_word_policy_config(&self) -> &Option<AiGuardrailWordPolicyConfig>
pub fn get_word_policy_config(&self) -> &Option<AiGuardrailWordPolicyConfig>
Contains details about the word policy to configured for the AI Guardrail.
Sourcepub fn sensitive_information_policy_config(
self,
input: AiGuardrailSensitiveInformationPolicyConfig,
) -> Self
pub fn sensitive_information_policy_config( self, input: AiGuardrailSensitiveInformationPolicyConfig, ) -> Self
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Sourcepub fn set_sensitive_information_policy_config(
self,
input: Option<AiGuardrailSensitiveInformationPolicyConfig>,
) -> Self
pub fn set_sensitive_information_policy_config( self, input: Option<AiGuardrailSensitiveInformationPolicyConfig>, ) -> Self
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Sourcepub fn get_sensitive_information_policy_config(
&self,
) -> &Option<AiGuardrailSensitiveInformationPolicyConfig>
pub fn get_sensitive_information_policy_config( &self, ) -> &Option<AiGuardrailSensitiveInformationPolicyConfig>
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Sourcepub fn contextual_grounding_policy_config(
self,
input: AiGuardrailContextualGroundingPolicyConfig,
) -> Self
pub fn contextual_grounding_policy_config( self, input: AiGuardrailContextualGroundingPolicyConfig, ) -> Self
The policy configuration details for the AI Guardrail's contextual grounding policy.
Sourcepub fn set_contextual_grounding_policy_config(
self,
input: Option<AiGuardrailContextualGroundingPolicyConfig>,
) -> Self
pub fn set_contextual_grounding_policy_config( self, input: Option<AiGuardrailContextualGroundingPolicyConfig>, ) -> Self
The policy configuration details for the AI Guardrail's contextual grounding policy.
Sourcepub fn get_contextual_grounding_policy_config(
&self,
) -> &Option<AiGuardrailContextualGroundingPolicyConfig>
pub fn get_contextual_grounding_policy_config( &self, ) -> &Option<AiGuardrailContextualGroundingPolicyConfig>
The policy configuration details for the AI Guardrail's contextual grounding policy.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
Sourcepub fn set_status(self, input: Option<Status>) -> Self
pub fn set_status(self, input: Option<Status>) -> Self
The status of the AI Guardrail.
Sourcepub fn get_status(&self) -> &Option<Status>
pub fn get_status(&self) -> &Option<Status>
The status of the AI Guardrail.
Sourcepub fn modified_time(self, input: DateTime) -> Self
pub fn modified_time(self, input: DateTime) -> Self
The time the AI Guardrail was last modified.
Sourcepub fn set_modified_time(self, input: Option<DateTime>) -> Self
pub fn set_modified_time(self, input: Option<DateTime>) -> Self
The time the AI Guardrail was last modified.
Sourcepub fn get_modified_time(&self) -> &Option<DateTime>
pub fn get_modified_time(&self) -> &Option<DateTime>
The time the AI Guardrail was last modified.
Sourcepub fn build(self) -> Result<AiGuardrailData, BuildError>
pub fn build(self) -> Result<AiGuardrailData, BuildError>
Consumes the builder and constructs a AiGuardrailData
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AiGuardrailDataBuilder
impl Clone for AiGuardrailDataBuilder
Source§fn clone(&self) -> AiGuardrailDataBuilder
fn clone(&self) -> AiGuardrailDataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AiGuardrailDataBuilder
impl Debug for AiGuardrailDataBuilder
Source§impl Default for AiGuardrailDataBuilder
impl Default for AiGuardrailDataBuilder
Source§fn default() -> AiGuardrailDataBuilder
fn default() -> AiGuardrailDataBuilder
Source§impl PartialEq for AiGuardrailDataBuilder
impl PartialEq for AiGuardrailDataBuilder
impl StructuralPartialEq for AiGuardrailDataBuilder
Auto Trait Implementations§
impl Freeze for AiGuardrailDataBuilder
impl RefUnwindSafe for AiGuardrailDataBuilder
impl Send for AiGuardrailDataBuilder
impl Sync for AiGuardrailDataBuilder
impl Unpin for AiGuardrailDataBuilder
impl UnwindSafe for AiGuardrailDataBuilder
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);