#[non_exhaustive]pub struct DescribeIndexOutputBuilder { /* private fields */ }Expand description
A builder for DescribeIndexOutput.
Implementations§
Source§impl DescribeIndexOutputBuilder
impl DescribeIndexOutputBuilder
Sourcepub fn edition(self, input: IndexEdition) -> Self
pub fn edition(self, input: IndexEdition) -> Self
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
Sourcepub fn set_edition(self, input: Option<IndexEdition>) -> Self
pub fn set_edition(self, input: Option<IndexEdition>) -> Self
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
Sourcepub fn get_edition(&self) -> &Option<IndexEdition>
pub fn get_edition(&self) -> &Option<IndexEdition>
The Amazon Kendra edition used for the index. You decide the edition when you create the index.
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 the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
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 the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
Sourcepub fn server_side_encryption_configuration(
self,
input: ServerSideEncryptionConfiguration,
) -> Self
pub fn server_side_encryption_configuration( self, input: ServerSideEncryptionConfiguration, ) -> Self
The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn set_server_side_encryption_configuration(
self,
input: Option<ServerSideEncryptionConfiguration>,
) -> Self
pub fn set_server_side_encryption_configuration( self, input: Option<ServerSideEncryptionConfiguration>, ) -> Self
The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn get_server_side_encryption_configuration(
&self,
) -> &Option<ServerSideEncryptionConfiguration>
pub fn get_server_side_encryption_configuration( &self, ) -> &Option<ServerSideEncryptionConfiguration>
The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
Sourcepub fn status(self, input: IndexStatus) -> Self
pub fn status(self, input: IndexStatus) -> Self
The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn set_status(self, input: Option<IndexStatus>) -> Self
pub fn set_status(self, input: Option<IndexStatus>) -> Self
The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn get_status(&self) -> &Option<IndexStatus>
pub fn get_status(&self) -> &Option<IndexStatus>
The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description for the index.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description for the index.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description for the index.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The Unix timestamp when the index was created.
Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The Unix timestamp when the index was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The Unix timestamp when the index was created.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The Unix timestamp when the index was last updated.
Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The Unix timestamp when the index was last updated.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The Unix timestamp when the index was last updated.
Sourcepub fn document_metadata_configurations(
self,
input: DocumentMetadataConfiguration,
) -> Self
pub fn document_metadata_configurations( self, input: DocumentMetadataConfiguration, ) -> Self
Appends an item to document_metadata_configurations.
To override the contents of this collection use set_document_metadata_configurations.
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
Sourcepub fn set_document_metadata_configurations(
self,
input: Option<Vec<DocumentMetadataConfiguration>>,
) -> Self
pub fn set_document_metadata_configurations( self, input: Option<Vec<DocumentMetadataConfiguration>>, ) -> Self
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
Sourcepub fn get_document_metadata_configurations(
&self,
) -> &Option<Vec<DocumentMetadataConfiguration>>
pub fn get_document_metadata_configurations( &self, ) -> &Option<Vec<DocumentMetadataConfiguration>>
Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
Sourcepub fn index_statistics(self, input: IndexStatistics) -> Self
pub fn index_statistics(self, input: IndexStatistics) -> Self
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
Sourcepub fn set_index_statistics(self, input: Option<IndexStatistics>) -> Self
pub fn set_index_statistics(self, input: Option<IndexStatistics>) -> Self
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
Sourcepub fn get_index_statistics(&self) -> &Option<IndexStatistics>
pub fn get_index_statistics(&self) -> &Option<IndexStatistics>
Provides information about the number of FAQ questions and answers and the number of text documents indexed.
Sourcepub fn error_message(self, input: impl Into<String>) -> Self
pub fn error_message(self, input: impl Into<String>) -> Self
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn set_error_message(self, input: Option<String>) -> Self
pub fn set_error_message(self, input: Option<String>) -> Self
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn get_error_message(&self) -> &Option<String>
pub fn get_error_message(&self) -> &Option<String>
When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
Sourcepub fn capacity_units(self, input: CapacityUnitsConfiguration) -> Self
pub fn capacity_units(self, input: CapacityUnitsConfiguration) -> Self
For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
Sourcepub fn set_capacity_units(
self,
input: Option<CapacityUnitsConfiguration>,
) -> Self
pub fn set_capacity_units( self, input: Option<CapacityUnitsConfiguration>, ) -> Self
For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
Sourcepub fn get_capacity_units(&self) -> &Option<CapacityUnitsConfiguration>
pub fn get_capacity_units(&self) -> &Option<CapacityUnitsConfiguration>
For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
Sourcepub fn user_token_configurations(self, input: UserTokenConfiguration) -> Self
pub fn user_token_configurations(self, input: UserTokenConfiguration) -> Self
Appends an item to user_token_configurations.
To override the contents of this collection use set_user_token_configurations.
The user token configuration for the Amazon Kendra index.
Sourcepub fn set_user_token_configurations(
self,
input: Option<Vec<UserTokenConfiguration>>,
) -> Self
pub fn set_user_token_configurations( self, input: Option<Vec<UserTokenConfiguration>>, ) -> Self
The user token configuration for the Amazon Kendra index.
Sourcepub fn get_user_token_configurations(
&self,
) -> &Option<Vec<UserTokenConfiguration>>
pub fn get_user_token_configurations( &self, ) -> &Option<Vec<UserTokenConfiguration>>
The user token configuration for the Amazon Kendra index.
Sourcepub fn user_context_policy(self, input: UserContextPolicy) -> Self
pub fn user_context_policy(self, input: UserContextPolicy) -> Self
The user context policy for the Amazon Kendra index.
Sourcepub fn set_user_context_policy(self, input: Option<UserContextPolicy>) -> Self
pub fn set_user_context_policy(self, input: Option<UserContextPolicy>) -> Self
The user context policy for the Amazon Kendra index.
Sourcepub fn get_user_context_policy(&self) -> &Option<UserContextPolicy>
pub fn get_user_context_policy(&self) -> &Option<UserContextPolicy>
The user context policy for the Amazon Kendra index.
Sourcepub fn user_group_resolution_configuration(
self,
input: UserGroupResolutionConfiguration,
) -> Self
pub fn user_group_resolution_configuration( self, input: UserGroupResolutionConfiguration, ) -> Self
Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Sourcepub fn set_user_group_resolution_configuration(
self,
input: Option<UserGroupResolutionConfiguration>,
) -> Self
pub fn set_user_group_resolution_configuration( self, input: Option<UserGroupResolutionConfiguration>, ) -> Self
Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Sourcepub fn get_user_group_resolution_configuration(
&self,
) -> &Option<UserGroupResolutionConfiguration>
pub fn get_user_group_resolution_configuration( &self, ) -> &Option<UserGroupResolutionConfiguration>
Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
Sourcepub fn build(self) -> DescribeIndexOutput
pub fn build(self) -> DescribeIndexOutput
Consumes the builder and constructs a DescribeIndexOutput.
Trait Implementations§
Source§impl Clone for DescribeIndexOutputBuilder
impl Clone for DescribeIndexOutputBuilder
Source§fn clone(&self) -> DescribeIndexOutputBuilder
fn clone(&self) -> DescribeIndexOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribeIndexOutputBuilder
impl Debug for DescribeIndexOutputBuilder
Source§impl Default for DescribeIndexOutputBuilder
impl Default for DescribeIndexOutputBuilder
Source§fn default() -> DescribeIndexOutputBuilder
fn default() -> DescribeIndexOutputBuilder
impl StructuralPartialEq for DescribeIndexOutputBuilder
Auto Trait Implementations§
impl Freeze for DescribeIndexOutputBuilder
impl RefUnwindSafe for DescribeIndexOutputBuilder
impl Send for DescribeIndexOutputBuilder
impl Sync for DescribeIndexOutputBuilder
impl Unpin for DescribeIndexOutputBuilder
impl UnwindSafe for DescribeIndexOutputBuilder
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);