#[non_exhaustive]pub struct GetIndexOutputBuilder { /* private fields */ }
Expand description
A builder for GetIndexOutput
.
Implementations§
Source§impl GetIndexOutputBuilder
impl GetIndexOutputBuilder
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 associated with the index.
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 associated with the index.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The identifier of the Amazon Q Business application associated with the index.
Sourcepub fn index_id(self, input: impl Into<String>) -> Self
pub fn index_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Q Business index.
Sourcepub fn set_index_id(self, input: Option<String>) -> Self
pub fn set_index_id(self, input: Option<String>) -> Self
The identifier of the Amazon Q Business index.
Sourcepub fn get_index_id(&self) -> &Option<String>
pub fn get_index_id(&self) -> &Option<String>
The identifier of the Amazon Q Business index.
Sourcepub fn display_name(self, input: impl Into<String>) -> Self
pub fn display_name(self, input: impl Into<String>) -> Self
The name of the Amazon Q Business index.
Sourcepub fn set_display_name(self, input: Option<String>) -> Self
pub fn set_display_name(self, input: Option<String>) -> Self
The name of the Amazon Q Business index.
Sourcepub fn get_display_name(&self) -> &Option<String>
pub fn get_display_name(&self) -> &Option<String>
The name of the Amazon Q Business index.
Sourcepub fn index_arn(self, input: impl Into<String>) -> Self
pub fn index_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon Q Business index.
Sourcepub fn set_index_arn(self, input: Option<String>) -> Self
pub fn set_index_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the Amazon Q Business index.
Sourcepub fn get_index_arn(&self) -> &Option<String>
pub fn get_index_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the Amazon Q Business index.
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 type(self, input: IndexType) -> Self
pub fn type(self, input: IndexType) -> Self
The type of index attached to your Amazon Q Business application.
Sourcepub fn set_type(self, input: Option<IndexType>) -> Self
pub fn set_type(self, input: Option<IndexType>) -> Self
The type of index attached to your Amazon Q Business application.
Sourcepub fn get_type(&self) -> &Option<IndexType>
pub fn get_type(&self) -> &Option<IndexType>
The type of index attached to your Amazon Q Business application.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description for the Amazon Q Business index.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description for the Amazon Q Business index.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description for the Amazon Q Business index.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The Unix timestamp when the Amazon Q Business 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 Amazon Q Business index was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The Unix timestamp when the Amazon Q Business index was created.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The Unix timestamp when the Amazon Q Business 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 Amazon Q Business 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 Amazon Q Business index was last updated.
Sourcepub fn capacity_configuration(self, input: IndexCapacityConfiguration) -> Self
pub fn capacity_configuration(self, input: IndexCapacityConfiguration) -> Self
The storage capacity units chosen for your Amazon Q Business index.
Sourcepub fn set_capacity_configuration(
self,
input: Option<IndexCapacityConfiguration>,
) -> Self
pub fn set_capacity_configuration( self, input: Option<IndexCapacityConfiguration>, ) -> Self
The storage capacity units chosen for your Amazon Q Business index.
Sourcepub fn get_capacity_configuration(&self) -> &Option<IndexCapacityConfiguration>
pub fn get_capacity_configuration(&self) -> &Option<IndexCapacityConfiguration>
The storage capacity units chosen for your Amazon Q Business index.
Sourcepub fn document_attribute_configurations(
self,
input: DocumentAttributeConfiguration,
) -> Self
pub fn document_attribute_configurations( self, input: DocumentAttributeConfiguration, ) -> Self
Appends an item to document_attribute_configurations
.
To override the contents of this collection use set_document_attribute_configurations
.
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
Sourcepub fn set_document_attribute_configurations(
self,
input: Option<Vec<DocumentAttributeConfiguration>>,
) -> Self
pub fn set_document_attribute_configurations( self, input: Option<Vec<DocumentAttributeConfiguration>>, ) -> Self
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
Sourcepub fn get_document_attribute_configurations(
&self,
) -> &Option<Vec<DocumentAttributeConfiguration>>
pub fn get_document_attribute_configurations( &self, ) -> &Option<Vec<DocumentAttributeConfiguration>>
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
Sourcepub fn error(self, input: ErrorDetail) -> Self
pub fn error(self, input: ErrorDetail) -> Self
When the Status
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
Sourcepub fn set_error(self, input: Option<ErrorDetail>) -> Self
pub fn set_error(self, input: Option<ErrorDetail>) -> Self
When the Status
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
Sourcepub fn get_error(&self) -> &Option<ErrorDetail>
pub fn get_error(&self) -> &Option<ErrorDetail>
When the Status
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
Sourcepub fn index_statistics(self, input: IndexStatistics) -> Self
pub fn index_statistics(self, input: IndexStatistics) -> Self
Provides information about the number of 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 documents indexed.
Sourcepub fn get_index_statistics(&self) -> &Option<IndexStatistics>
pub fn get_index_statistics(&self) -> &Option<IndexStatistics>
Provides information about the number of documents indexed.
Sourcepub fn build(self) -> GetIndexOutput
pub fn build(self) -> GetIndexOutput
Consumes the builder and constructs a GetIndexOutput
.
Trait Implementations§
Source§impl Clone for GetIndexOutputBuilder
impl Clone for GetIndexOutputBuilder
Source§fn clone(&self) -> GetIndexOutputBuilder
fn clone(&self) -> GetIndexOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetIndexOutputBuilder
impl Debug for GetIndexOutputBuilder
Source§impl Default for GetIndexOutputBuilder
impl Default for GetIndexOutputBuilder
Source§fn default() -> GetIndexOutputBuilder
fn default() -> GetIndexOutputBuilder
Source§impl PartialEq for GetIndexOutputBuilder
impl PartialEq for GetIndexOutputBuilder
impl StructuralPartialEq for GetIndexOutputBuilder
Auto Trait Implementations§
impl Freeze for GetIndexOutputBuilder
impl RefUnwindSafe for GetIndexOutputBuilder
impl Send for GetIndexOutputBuilder
impl Sync for GetIndexOutputBuilder
impl Unpin for GetIndexOutputBuilder
impl UnwindSafe for GetIndexOutputBuilder
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);