Struct aws_sdk_qbusiness::operation::create_index::builders::CreateIndexFluentBuilder

pub struct CreateIndexFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateIndex.

Creates an Amazon Q index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Implementations

impl CreateIndexFluentBuilder

pub fn as_input(&self) -> &CreateIndexInputBuilder

Access the CreateIndex as a reference.

pub async fn send( self ) -> Result<CreateIndexOutput, SdkError<CreateIndexError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateIndexOutput, CreateIndexError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The identifier of the Amazon Q application using the index.

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

The identifier of the Amazon Q application using the index.

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

The identifier of the Amazon Q application using the index.

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

A name for the Amazon Q index.

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

A name for the Amazon Q index.

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

A name for the Amazon Q index.

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

A description for the Amazon Q index.

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

A description for the Amazon Q index.

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

A description for the Amazon Q index.

pub fn tags(self, input: Tag) -> Self

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 index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

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

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

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

The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

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

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

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

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

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

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Trait Implementations

impl Clone for CreateIndexFluentBuilder

fn clone(&self) -> CreateIndexFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIndexFluentBuilder

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

Formats the value using the given formatter.