#[non_exhaustive]pub struct CreateFaqInputBuilder { /* private fields */ }Expand description
A builder for CreateFaqInput.
Implementations§
Source§impl CreateFaqInputBuilder
impl CreateFaqInputBuilder
Sourcepub fn index_id(self, input: impl Into<String>) -> Self
pub fn index_id(self, input: impl Into<String>) -> Self
The identifier of the index for the FAQ.
This field is required.Sourcepub fn set_index_id(self, input: Option<String>) -> Self
pub fn set_index_id(self, input: Option<String>) -> Self
The identifier of the index for the FAQ.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index for the FAQ.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A name for the FAQ.
This field is required.Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the FAQ.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the FAQ.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the FAQ.
Sourcepub fn s3_path(self, input: S3Path) -> Self
pub fn s3_path(self, input: S3Path) -> Self
The path to the FAQ file in S3.
This field is required.Sourcepub fn set_s3_path(self, input: Option<S3Path>) -> Self
pub fn set_s3_path(self, input: Option<S3Path>) -> Self
The path to the FAQ file in S3.
Sourcepub fn get_s3_path(&self) -> &Option<S3Path>
pub fn get_s3_path(&self) -> &Option<S3Path>
The path to the FAQ file in S3.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see IAM access roles for Amazon Kendra.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see IAM access roles for Amazon Kendra.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see IAM access roles for Amazon Kendra.
Appends an item to tags.
To override the contents of this collection use set_tags.
A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.
Sourcepub fn file_format(self, input: FaqFileFormat) -> Self
pub fn file_format(self, input: FaqFileFormat) -> Self
The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The default format is CSV.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
Sourcepub fn set_file_format(self, input: Option<FaqFileFormat>) -> Self
pub fn set_file_format(self, input: Option<FaqFileFormat>) -> Self
The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The default format is CSV.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
Sourcepub fn get_file_format(&self) -> &Option<FaqFileFormat>
pub fn get_file_format(&self) -> &Option<FaqFileFormat>
The format of the FAQ input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.
The default format is CSV.
The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.
For more information, see Adding questions and answers.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest API with the same client token will create only one FAQ.
Sourcepub fn language_code(self, input: impl Into<String>) -> Self
pub fn language_code(self, input: impl Into<String>) -> Self
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
Sourcepub fn set_language_code(self, input: Option<String>) -> Self
pub fn set_language_code(self, input: Option<String>) -> Self
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
Sourcepub fn get_language_code(&self) -> &Option<String>
pub fn get_language_code(&self) -> &Option<String>
The code for a language. This allows you to support a language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
Sourcepub fn build(self) -> Result<CreateFaqInput, BuildError>
pub fn build(self) -> Result<CreateFaqInput, BuildError>
Consumes the builder and constructs a CreateFaqInput.
Source§impl CreateFaqInputBuilder
impl CreateFaqInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateFaqOutput, SdkError<CreateFaqError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateFaqOutput, SdkError<CreateFaqError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateFaqInputBuilder
impl Clone for CreateFaqInputBuilder
Source§fn clone(&self) -> CreateFaqInputBuilder
fn clone(&self) -> CreateFaqInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateFaqInputBuilder
impl Debug for CreateFaqInputBuilder
Source§impl Default for CreateFaqInputBuilder
impl Default for CreateFaqInputBuilder
Source§fn default() -> CreateFaqInputBuilder
fn default() -> CreateFaqInputBuilder
Source§impl PartialEq for CreateFaqInputBuilder
impl PartialEq for CreateFaqInputBuilder
impl StructuralPartialEq for CreateFaqInputBuilder
Auto Trait Implementations§
impl Freeze for CreateFaqInputBuilder
impl RefUnwindSafe for CreateFaqInputBuilder
impl Send for CreateFaqInputBuilder
impl Sync for CreateFaqInputBuilder
impl Unpin for CreateFaqInputBuilder
impl UnwindSafe for CreateFaqInputBuilder
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);