pub struct ApplyGuardrailFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ApplyGuardrail
.
The action to apply a guardrail.
For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail
API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide
Implementations§
Source§impl ApplyGuardrailFluentBuilder
impl ApplyGuardrailFluentBuilder
Sourcepub fn as_input(&self) -> &ApplyGuardrailInputBuilder
pub fn as_input(&self) -> &ApplyGuardrailInputBuilder
Access the ApplyGuardrail as a reference.
Sourcepub async fn send(
self,
) -> Result<ApplyGuardrailOutput, SdkError<ApplyGuardrailError, HttpResponse>>
pub async fn send( self, ) -> Result<ApplyGuardrailOutput, SdkError<ApplyGuardrailError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<ApplyGuardrailOutput, ApplyGuardrailError, Self>
pub fn customize( self, ) -> CustomizableOperation<ApplyGuardrailOutput, ApplyGuardrailError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn guardrail_identifier(self, input: impl Into<String>) -> Self
pub fn guardrail_identifier(self, input: impl Into<String>) -> Self
The guardrail identifier used in the request to apply the guardrail.
Sourcepub fn set_guardrail_identifier(self, input: Option<String>) -> Self
pub fn set_guardrail_identifier(self, input: Option<String>) -> Self
The guardrail identifier used in the request to apply the guardrail.
Sourcepub fn get_guardrail_identifier(&self) -> &Option<String>
pub fn get_guardrail_identifier(&self) -> &Option<String>
The guardrail identifier used in the request to apply the guardrail.
Sourcepub fn guardrail_version(self, input: impl Into<String>) -> Self
pub fn guardrail_version(self, input: impl Into<String>) -> Self
The guardrail version used in the request to apply the guardrail.
Sourcepub fn set_guardrail_version(self, input: Option<String>) -> Self
pub fn set_guardrail_version(self, input: Option<String>) -> Self
The guardrail version used in the request to apply the guardrail.
Sourcepub fn get_guardrail_version(&self) -> &Option<String>
pub fn get_guardrail_version(&self) -> &Option<String>
The guardrail version used in the request to apply the guardrail.
Sourcepub fn source(self, input: GuardrailContentSource) -> Self
pub fn source(self, input: GuardrailContentSource) -> Self
The source of data used in the request to apply the guardrail.
Sourcepub fn set_source(self, input: Option<GuardrailContentSource>) -> Self
pub fn set_source(self, input: Option<GuardrailContentSource>) -> Self
The source of data used in the request to apply the guardrail.
Sourcepub fn get_source(&self) -> &Option<GuardrailContentSource>
pub fn get_source(&self) -> &Option<GuardrailContentSource>
The source of data used in the request to apply the guardrail.
Sourcepub fn content(self, input: GuardrailContentBlock) -> Self
pub fn content(self, input: GuardrailContentBlock) -> Self
Appends an item to content
.
To override the contents of this collection use set_content
.
The content details used in the request to apply the guardrail.
Sourcepub fn set_content(self, input: Option<Vec<GuardrailContentBlock>>) -> Self
pub fn set_content(self, input: Option<Vec<GuardrailContentBlock>>) -> Self
The content details used in the request to apply the guardrail.
Sourcepub fn get_content(&self) -> &Option<Vec<GuardrailContentBlock>>
pub fn get_content(&self) -> &Option<Vec<GuardrailContentBlock>>
The content details used in the request to apply the guardrail.
Sourcepub fn output_scope(self, input: GuardrailOutputScope) -> Self
pub fn output_scope(self, input: GuardrailOutputScope) -> Self
Specifies the scope of the output that you get in the response. Set to FULL
to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
Sourcepub fn set_output_scope(self, input: Option<GuardrailOutputScope>) -> Self
pub fn set_output_scope(self, input: Option<GuardrailOutputScope>) -> Self
Specifies the scope of the output that you get in the response. Set to FULL
to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
Sourcepub fn get_output_scope(&self) -> &Option<GuardrailOutputScope>
pub fn get_output_scope(&self) -> &Option<GuardrailOutputScope>
Specifies the scope of the output that you get in the response. Set to FULL
to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
Trait Implementations§
Source§impl Clone for ApplyGuardrailFluentBuilder
impl Clone for ApplyGuardrailFluentBuilder
Source§fn clone(&self) -> ApplyGuardrailFluentBuilder
fn clone(&self) -> ApplyGuardrailFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ApplyGuardrailFluentBuilder
impl !RefUnwindSafe for ApplyGuardrailFluentBuilder
impl Send for ApplyGuardrailFluentBuilder
impl Sync for ApplyGuardrailFluentBuilder
impl Unpin for ApplyGuardrailFluentBuilder
impl !UnwindSafe for ApplyGuardrailFluentBuilder
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);