Struct aws_sdk_qbusiness::operation::get_index::builders::GetIndexOutputBuilder

#[non_exhaustive]
pub struct GetIndexOutputBuilder { /* private fields */ }

A builder for GetIndexOutput.

Implementations

impl GetIndexOutputBuilder

pub fn application_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q application associated with the index.

pub fn set_application_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q application associated with the index.

pub fn get_application_id(&self) -> &Option<String>

The identifier of the Amazon Q application associated with the index.

pub fn index_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q index.

pub fn set_index_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q index.

pub fn get_index_id(&self) -> &Option<String>

The identifier of the Amazon Q index.

pub fn display_name(self, input: impl Into<String>) -> Self

The name of the Amazon Q index.

pub fn set_display_name(self, input: Option<String>) -> Self

The name of the Amazon Q index.

pub fn get_display_name(&self) -> &Option<String>

The name of the Amazon Q index.

pub fn index_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon Q index.

pub fn set_index_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the Amazon Q index.

pub fn get_index_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the Amazon Q index.

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.

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.

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.

pub fn description(self, input: impl Into<String>) -> Self

The description for the Amazon Q index.

pub fn set_description(self, input: Option<String>) -> Self

The description for the Amazon Q index.

pub fn get_description(&self) -> &Option<String>

The description for the Amazon Q index.

pub fn created_at(self, input: DateTime) -> Self

The Unix timestamp when the Amazon Q index was created.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The Unix timestamp when the Amazon Q index was created.

pub fn get_created_at(&self) -> &Option<DateTime>

The Unix timestamp when the Amazon Q index was created.

pub fn updated_at(self, input: DateTime) -> Self

The Unix timestamp when the Amazon Q index was last updated.

pub fn set_updated_at(self, input: Option<DateTime>) -> Self

The Unix timestamp when the Amazon Q index was last updated.

pub fn get_updated_at(&self) -> &Option<DateTime>

The Unix timestamp when the Amazon Q index was last updated.

pub fn capacity_configuration(self, input: IndexCapacityConfiguration) -> Self

The storage capacity units chosen for your Amazon Q index.

pub fn set_capacity_configuration( self, input: Option<IndexCapacityConfiguration> ) -> Self

The storage capacity units chosen for your Amazon Q index.

pub fn get_capacity_configuration(&self) -> &Option<IndexCapacityConfiguration>

The storage capacity units chosen for your Amazon Q index.

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.

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.

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.

pub fn error(self, input: ErrorDetail) -> Self

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

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.

pub fn get_error(&self) -> &Option<ErrorDetail>

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

pub fn index_statistics(self, input: IndexStatistics) -> Self

Provides information about the number of documents indexed.

pub fn set_index_statistics(self, input: Option<IndexStatistics>) -> Self

Provides information about the number of documents indexed.

pub fn get_index_statistics(&self) -> &Option<IndexStatistics>

Provides information about the number of documents indexed.

pub fn build(self) -> GetIndexOutput

Consumes the builder and constructs a GetIndexOutput.

Trait Implementations

impl Clone for GetIndexOutputBuilder

fn clone(&self) -> GetIndexOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetIndexOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetIndexOutputBuilder

fn default() -> GetIndexOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetIndexOutputBuilder

fn eq(&self, other: &GetIndexOutputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetIndexOutputBuilder