#[non_exhaustive]pub struct AiPromptDataBuilder { /* private fields */ }
Expand description
A builder for AiPromptData
.
Implementations§
Source§impl AiPromptDataBuilder
impl AiPromptDataBuilder
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_prompt_id(self, input: impl Into<String>) -> Self
pub fn ai_prompt_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q in Connect AI prompt.
This field is required.Sourcepub fn set_ai_prompt_id(self, input: Option<String>) -> Self
pub fn set_ai_prompt_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q in Connect AI prompt.
Sourcepub fn get_ai_prompt_id(&self) -> &Option<String>
pub fn get_ai_prompt_id(&self) -> &Option<String>
The identifier of the Amazon Q in Connect AI prompt.
Sourcepub fn ai_prompt_arn(self, input: impl Into<String>) -> Self
pub fn ai_prompt_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the AI Prompt.
This field is required.Sourcepub fn set_ai_prompt_arn(self, input: Option<String>) -> Self
pub fn set_ai_prompt_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the AI Prompt.
Sourcepub fn get_ai_prompt_arn(&self) -> &Option<String>
pub fn get_ai_prompt_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the AI Prompt.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the AI Prompt
This field is required.Sourcepub fn type(self, input: AiPromptType) -> Self
pub fn type(self, input: AiPromptType) -> Self
The type of this AI Prompt.
This field is required.Sourcepub fn set_type(self, input: Option<AiPromptType>) -> Self
pub fn set_type(self, input: Option<AiPromptType>) -> Self
The type of this AI Prompt.
Sourcepub fn get_type(&self) -> &Option<AiPromptType>
pub fn get_type(&self) -> &Option<AiPromptType>
The type of this AI Prompt.
Sourcepub fn template_type(self, input: AiPromptTemplateType) -> Self
pub fn template_type(self, input: AiPromptTemplateType) -> Self
The type of the prompt template for this AI Prompt.
This field is required.Sourcepub fn set_template_type(self, input: Option<AiPromptTemplateType>) -> Self
pub fn set_template_type(self, input: Option<AiPromptTemplateType>) -> Self
The type of the prompt template for this AI Prompt.
Sourcepub fn get_template_type(&self) -> &Option<AiPromptTemplateType>
pub fn get_template_type(&self) -> &Option<AiPromptTemplateType>
The type of the prompt template for this AI Prompt.
Sourcepub fn model_id(self, input: impl Into<String>) -> Self
pub fn model_id(self, input: impl Into<String>) -> Self
The identifier of the model used for this AI Prompt. The following model Ids are supported:
-
anthropic.claude-3-haiku--v1:0
-
apac.amazon.nova-lite-v1:0
-
apac.amazon.nova-micro-v1:0
-
apac.amazon.nova-pro-v1:0
-
apac.anthropic.claude-3-5-sonnet--v2:0
-
apac.anthropic.claude-3-haiku-20240307-v1:0
-
eu.amazon.nova-lite-v1:0
-
eu.amazon.nova-micro-v1:0
-
eu.amazon.nova-pro-v1:0
-
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
-
eu.anthropic.claude-3-haiku-20240307-v1:0
-
us.amazon.nova-lite-v1:0
-
us.amazon.nova-micro-v1:0
-
us.amazon.nova-pro-v1:0
-
us.anthropic.claude-3-5-haiku-20241022-v1:0
-
us.anthropic.claude-3-7-sonnet-20250219-v1:0
-
us.anthropic.claude-3-haiku-20240307-v1:0
Sourcepub fn set_model_id(self, input: Option<String>) -> Self
pub fn set_model_id(self, input: Option<String>) -> Self
The identifier of the model used for this AI Prompt. The following model Ids are supported:
-
anthropic.claude-3-haiku--v1:0
-
apac.amazon.nova-lite-v1:0
-
apac.amazon.nova-micro-v1:0
-
apac.amazon.nova-pro-v1:0
-
apac.anthropic.claude-3-5-sonnet--v2:0
-
apac.anthropic.claude-3-haiku-20240307-v1:0
-
eu.amazon.nova-lite-v1:0
-
eu.amazon.nova-micro-v1:0
-
eu.amazon.nova-pro-v1:0
-
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
-
eu.anthropic.claude-3-haiku-20240307-v1:0
-
us.amazon.nova-lite-v1:0
-
us.amazon.nova-micro-v1:0
-
us.amazon.nova-pro-v1:0
-
us.anthropic.claude-3-5-haiku-20241022-v1:0
-
us.anthropic.claude-3-7-sonnet-20250219-v1:0
-
us.anthropic.claude-3-haiku-20240307-v1:0
Sourcepub fn get_model_id(&self) -> &Option<String>
pub fn get_model_id(&self) -> &Option<String>
The identifier of the model used for this AI Prompt. The following model Ids are supported:
-
anthropic.claude-3-haiku--v1:0
-
apac.amazon.nova-lite-v1:0
-
apac.amazon.nova-micro-v1:0
-
apac.amazon.nova-pro-v1:0
-
apac.anthropic.claude-3-5-sonnet--v2:0
-
apac.anthropic.claude-3-haiku-20240307-v1:0
-
eu.amazon.nova-lite-v1:0
-
eu.amazon.nova-micro-v1:0
-
eu.amazon.nova-pro-v1:0
-
eu.anthropic.claude-3-7-sonnet-20250219-v1:0
-
eu.anthropic.claude-3-haiku-20240307-v1:0
-
us.amazon.nova-lite-v1:0
-
us.amazon.nova-micro-v1:0
-
us.amazon.nova-pro-v1:0
-
us.anthropic.claude-3-5-haiku-20241022-v1:0
-
us.anthropic.claude-3-7-sonnet-20250219-v1:0
-
us.anthropic.claude-3-haiku-20240307-v1:0
Sourcepub fn api_format(self, input: AiPromptApiFormat) -> Self
pub fn api_format(self, input: AiPromptApiFormat) -> Self
The API format used for this AI Prompt.
This field is required.Sourcepub fn set_api_format(self, input: Option<AiPromptApiFormat>) -> Self
pub fn set_api_format(self, input: Option<AiPromptApiFormat>) -> Self
The API format used for this AI Prompt.
Sourcepub fn get_api_format(&self) -> &Option<AiPromptApiFormat>
pub fn get_api_format(&self) -> &Option<AiPromptApiFormat>
The API format used for this AI Prompt.
Sourcepub fn template_configuration(
self,
input: AiPromptTemplateConfiguration,
) -> Self
pub fn template_configuration( self, input: AiPromptTemplateConfiguration, ) -> Self
The configuration of the prompt template for this AI Prompt.
This field is required.Sourcepub fn set_template_configuration(
self,
input: Option<AiPromptTemplateConfiguration>,
) -> Self
pub fn set_template_configuration( self, input: Option<AiPromptTemplateConfiguration>, ) -> Self
The configuration of the prompt template for this AI Prompt.
Sourcepub fn get_template_configuration(
&self,
) -> &Option<AiPromptTemplateConfiguration>
pub fn get_template_configuration( &self, ) -> &Option<AiPromptTemplateConfiguration>
The configuration of the prompt template for this AI Prompt.
Sourcepub fn modified_time(self, input: DateTime) -> Self
pub fn modified_time(self, input: DateTime) -> Self
The time the AI Prompt 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 Prompt was last modified.
Sourcepub fn get_modified_time(&self) -> &Option<DateTime>
pub fn get_modified_time(&self) -> &Option<DateTime>
The time the AI Prompt was last modified.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the AI Prompt.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the AI Prompt.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the AI Prompt.
Sourcepub fn visibility_status(self, input: VisibilityStatus) -> Self
pub fn visibility_status(self, input: VisibilityStatus) -> Self
The visibility status of the AI Prompt.
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 Prompt.
Sourcepub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
pub fn get_visibility_status(&self) -> &Option<VisibilityStatus>
The visibility status of the AI Prompt.
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 origin(self, input: Origin) -> Self
pub fn origin(self, input: Origin) -> Self
The origin of the AI Prompt. SYSTEM
for a default AI Prompt created by Q in Connect or CUSTOMER
for an AI Prompt created by calling AI Prompt creation APIs.
Sourcepub fn set_origin(self, input: Option<Origin>) -> Self
pub fn set_origin(self, input: Option<Origin>) -> Self
The origin of the AI Prompt. SYSTEM
for a default AI Prompt created by Q in Connect or CUSTOMER
for an AI Prompt created by calling AI Prompt creation APIs.
Sourcepub fn get_origin(&self) -> &Option<Origin>
pub fn get_origin(&self) -> &Option<Origin>
The origin of the AI Prompt. SYSTEM
for a default AI Prompt created by Q in Connect or CUSTOMER
for an AI Prompt created by calling AI Prompt creation APIs.
Sourcepub fn set_status(self, input: Option<Status>) -> Self
pub fn set_status(self, input: Option<Status>) -> Self
The status of the AI Prompt.
Sourcepub fn get_status(&self) -> &Option<Status>
pub fn get_status(&self) -> &Option<Status>
The status of the AI Prompt.
Sourcepub fn build(self) -> Result<AiPromptData, BuildError>
pub fn build(self) -> Result<AiPromptData, BuildError>
Consumes the builder and constructs a AiPromptData
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AiPromptDataBuilder
impl Clone for AiPromptDataBuilder
Source§fn clone(&self) -> AiPromptDataBuilder
fn clone(&self) -> AiPromptDataBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AiPromptDataBuilder
impl Debug for AiPromptDataBuilder
Source§impl Default for AiPromptDataBuilder
impl Default for AiPromptDataBuilder
Source§fn default() -> AiPromptDataBuilder
fn default() -> AiPromptDataBuilder
Source§impl PartialEq for AiPromptDataBuilder
impl PartialEq for AiPromptDataBuilder
impl StructuralPartialEq for AiPromptDataBuilder
Auto Trait Implementations§
impl Freeze for AiPromptDataBuilder
impl RefUnwindSafe for AiPromptDataBuilder
impl Send for AiPromptDataBuilder
impl Sync for AiPromptDataBuilder
impl Unpin for AiPromptDataBuilder
impl UnwindSafe for AiPromptDataBuilder
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);