#[non_exhaustive]pub struct CreateDataSourceInputBuilder { /* private fields */ }
Expand description
A builder for CreateDataSourceInput
.
Implementations§
Source§impl CreateDataSourceInputBuilder
impl CreateDataSourceInputBuilder
Sourcepub fn application_id(self, input: impl Into<String>) -> Self
pub fn application_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business application the data source will be attached to.
This field is required.Sourcepub fn set_application_id(self, input: Option<String>) -> Self
pub fn set_application_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business application the data source will be attached to.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The identifier of the Amazon Q Business application the data source will be attached to.
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 that you want to use with the data source connector.
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 that you want to use with the data source connector.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the index that you want to use with the data source connector.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
A name for the data source connector.
This field is required.Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
A name for the data source connector.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
A name for the data source connector.
Sourcepub fn configuration(self, input: Document) -> Self
pub fn configuration(self, input: Document) -> Self
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
You can find configuration templates for your specific data source using the following steps:
-
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
-
Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
Sourcepub fn set_configuration(self, input: Option<Document>) -> Self
pub fn set_configuration(self, input: Option<Document>) -> Self
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
You can find configuration templates for your specific data source using the following steps:
-
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
-
Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
Sourcepub fn get_configuration(&self) -> &Option<Document>
pub fn get_configuration(&self) -> &Option<Document>
Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector.
Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas:
You can find configuration templates for your specific data source using the following steps:
-
Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice.
-
Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
Sourcepub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self
pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
Sourcepub fn set_vpc_configuration(
self,
input: Option<DataSourceVpcConfiguration>,
) -> Self
pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
Sourcepub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>
pub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for the data source connector.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for the data source connector.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for the data source connector.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Sourcepub fn sync_schedule(self, input: impl Into<String>) -> Self
pub fn sync_schedule(self, input: impl Into<String>) -> Self
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a ValidationException
exception.
Sourcepub fn set_sync_schedule(self, input: Option<String>) -> Self
pub fn set_sync_schedule(self, input: Option<String>) -> Self
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a ValidationException
exception.
Sourcepub fn get_sync_schedule(&self) -> &Option<String>
pub fn get_sync_schedule(&self) -> &Option<String>
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a ValidationException
exception.
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 data source and required resources. This field is required for all connector types except custom connectors, where it is optional.
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 data source and required resources. This field is required for all connector types except custom connectors, where it is optional.
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 data source and required resources. This field is required for all connector types except custom connectors, where it is optional.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource
API with the same client token will create only one data source connector.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource
API with the same client token will create only one data source connector.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource
API with the same client token will create only one data source connector.
Sourcepub fn document_enrichment_configuration(
self,
input: DocumentEnrichmentConfiguration,
) -> Self
pub fn document_enrichment_configuration( self, input: DocumentEnrichmentConfiguration, ) -> Self
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
Sourcepub fn set_document_enrichment_configuration(
self,
input: Option<DocumentEnrichmentConfiguration>,
) -> Self
pub fn set_document_enrichment_configuration( self, input: Option<DocumentEnrichmentConfiguration>, ) -> Self
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
Sourcepub fn get_document_enrichment_configuration(
&self,
) -> &Option<DocumentEnrichmentConfiguration>
pub fn get_document_enrichment_configuration( &self, ) -> &Option<DocumentEnrichmentConfiguration>
Provides the configuration information for altering document metadata and content during the document ingestion process.
For more information, see Custom document enrichment.
Sourcepub fn media_extraction_configuration(
self,
input: MediaExtractionConfiguration,
) -> Self
pub fn media_extraction_configuration( self, input: MediaExtractionConfiguration, ) -> Self
The configuration for extracting information from media in documents during ingestion.
Sourcepub fn set_media_extraction_configuration(
self,
input: Option<MediaExtractionConfiguration>,
) -> Self
pub fn set_media_extraction_configuration( self, input: Option<MediaExtractionConfiguration>, ) -> Self
The configuration for extracting information from media in documents during ingestion.
Sourcepub fn get_media_extraction_configuration(
&self,
) -> &Option<MediaExtractionConfiguration>
pub fn get_media_extraction_configuration( &self, ) -> &Option<MediaExtractionConfiguration>
The configuration for extracting information from media in documents during ingestion.
Sourcepub fn build(self) -> Result<CreateDataSourceInput, BuildError>
pub fn build(self) -> Result<CreateDataSourceInput, BuildError>
Consumes the builder and constructs a CreateDataSourceInput
.
Source§impl CreateDataSourceInputBuilder
impl CreateDataSourceInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateDataSourceOutput, SdkError<CreateDataSourceError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateDataSourceOutput, SdkError<CreateDataSourceError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateDataSourceInputBuilder
impl Clone for CreateDataSourceInputBuilder
Source§fn clone(&self) -> CreateDataSourceInputBuilder
fn clone(&self) -> CreateDataSourceInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateDataSourceInputBuilder
impl Debug for CreateDataSourceInputBuilder
Source§impl Default for CreateDataSourceInputBuilder
impl Default for CreateDataSourceInputBuilder
Source§fn default() -> CreateDataSourceInputBuilder
fn default() -> CreateDataSourceInputBuilder
Source§impl PartialEq for CreateDataSourceInputBuilder
impl PartialEq for CreateDataSourceInputBuilder
Source§fn eq(&self, other: &CreateDataSourceInputBuilder) -> bool
fn eq(&self, other: &CreateDataSourceInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateDataSourceInputBuilder
Auto Trait Implementations§
impl Freeze for CreateDataSourceInputBuilder
impl RefUnwindSafe for CreateDataSourceInputBuilder
impl Send for CreateDataSourceInputBuilder
impl Sync for CreateDataSourceInputBuilder
impl Unpin for CreateDataSourceInputBuilder
impl UnwindSafe for CreateDataSourceInputBuilder
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);