Package software.amazon.awssdk.services.qbusiness.model

Interface GetIndexResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>, QBusinessResponse.Builder, SdkBuilder<GetIndexResponse.Builder,GetIndexResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetIndexResponse

public static interface GetIndexResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>

Method Summary

Modifier and Type	Method	Description
GetIndexResponse.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application associated with the index.
default GetIndexResponse.Builder	capacityConfiguration(Consumer<IndexCapacityConfiguration.Builder> capacityConfiguration)	The storage capacity units chosen for your Amazon Q Business index.
GetIndexResponse.Builder	capacityConfiguration(IndexCapacityConfiguration capacityConfiguration)	The storage capacity units chosen for your Amazon Q Business index.
GetIndexResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the Amazon Q Business index was created.
GetIndexResponse.Builder	description(String description)	The description for the Amazon Q Business index.
GetIndexResponse.Builder	displayName(String displayName)	The name of the Amazon Q Business index.
GetIndexResponse.Builder	documentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)	Configuration information for document attributes or metadata.
GetIndexResponse.Builder	documentAttributeConfigurations(Consumer<DocumentAttributeConfiguration.Builder>... documentAttributeConfigurations)	Configuration information for document attributes or metadata.
GetIndexResponse.Builder	documentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)	Configuration information for document attributes or metadata.
default GetIndexResponse.Builder	error(Consumer<ErrorDetail.Builder> error)	When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
GetIndexResponse.Builder	error(ErrorDetail error)	When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
GetIndexResponse.Builder	indexArn(String indexArn)	The Amazon Resource Name (ARN) of the Amazon Q Business index.
GetIndexResponse.Builder	indexId(String indexId)	The identifier of the Amazon Q Business index.
default GetIndexResponse.Builder	indexStatistics(Consumer<IndexStatistics.Builder> indexStatistics)	Provides information about the number of documents indexed.
GetIndexResponse.Builder	indexStatistics(IndexStatistics indexStatistics)	Provides information about the number of documents indexed.
GetIndexResponse.Builder	status(String status)	The current status of the index.
GetIndexResponse.Builder	status(IndexStatus status)	The current status of the index.
GetIndexResponse.Builder	type(String type)	The type of index attached to your Amazon Q Business application.
GetIndexResponse.Builder	type(IndexType type)	The type of index attached to your Amazon Q Business application.
GetIndexResponse.Builder	updatedAt(Instant updatedAt)	The Unix timestamp when the Amazon Q Business index was last updated.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

applicationId

GetIndexResponse.Builder applicationId(String applicationId)

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

Parameters:

applicationId - The identifier of the Amazon Q Business application associated with the index.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexId

GetIndexResponse.Builder indexId(String indexId)

The identifier of the Amazon Q Business index.

Parameters:

indexId - The identifier of the Amazon Q Business index.

Returns:

Returns a reference to this object so that method calls can be chained together.

displayName

GetIndexResponse.Builder displayName(String displayName)

The name of the Amazon Q Business index.

Parameters:

displayName - The name of the Amazon Q Business index.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

GetIndexResponse.Builder type(String type)

The type of index attached to your Amazon Q Business application.

Parameters:

type - The type of index attached to your Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IndexType, IndexType

type

GetIndexResponse.Builder type(IndexType type)

The type of index attached to your Amazon Q Business application.

Parameters:

type - The type of index attached to your Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IndexType, IndexType

indexArn

GetIndexResponse.Builder indexArn(String indexArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

GetIndexResponse.Builder status(String status)

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.

Parameters:

status - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IndexStatus, IndexStatus

status

GetIndexResponse.Builder status(IndexStatus status)

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.

Parameters:

status - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IndexStatus, IndexStatus

description

GetIndexResponse.Builder description(String description)

The description for the Amazon Q Business index.

Parameters:

description - The description for the Amazon Q Business index.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdAt

GetIndexResponse.Builder createdAt(Instant createdAt)

The Unix timestamp when the Amazon Q Business index was created.

Parameters:

createdAt - The Unix timestamp when the Amazon Q Business index was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

GetIndexResponse.Builder updatedAt(Instant updatedAt)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityConfiguration

GetIndexResponse.Builder capacityConfiguration(IndexCapacityConfiguration capacityConfiguration)

The storage capacity units chosen for your Amazon Q Business index.

Parameters:

capacityConfiguration - The storage capacity units chosen for your Amazon Q Business index.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityConfiguration

default GetIndexResponse.Builder capacityConfiguration(Consumer<IndexCapacityConfiguration.Builder> capacityConfiguration)

The storage capacity units chosen for your Amazon Q Business index.

This is a convenience method that creates an instance of the IndexCapacityConfiguration.Builder avoiding the need to create one manually via IndexCapacityConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityConfiguration(IndexCapacityConfiguration).

Parameters:

capacityConfiguration - a consumer that will call methods on IndexCapacityConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

capacityConfiguration(IndexCapacityConfiguration)

documentAttributeConfigurations

GetIndexResponse.Builder documentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)

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.

Parameters:

documentAttributeConfigurations - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentAttributeConfigurations

GetIndexResponse.Builder documentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)

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.

Parameters:

documentAttributeConfigurations - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

documentAttributeConfigurations

GetIndexResponse.Builder documentAttributeConfigurations(Consumer<DocumentAttributeConfiguration.Builder>... documentAttributeConfigurations)

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.

This is a convenience method that creates an instance of the DocumentAttributeConfiguration.Builder avoiding the need to create one manually via DocumentAttributeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #documentAttributeConfigurations(List).

Parameters:

documentAttributeConfigurations - a consumer that will call methods on DocumentAttributeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#documentAttributeConfigurations(java.util.Collection)

error

GetIndexResponse.Builder error(ErrorDetail error)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

error

default GetIndexResponse.Builder error(Consumer<ErrorDetail.Builder> error)

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

This is a convenience method that creates an instance of the ErrorDetail.Builder avoiding the need to create one manually via ErrorDetail.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to error(ErrorDetail).

Parameters:

error - a consumer that will call methods on ErrorDetail.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

error(ErrorDetail)

indexStatistics

GetIndexResponse.Builder indexStatistics(IndexStatistics indexStatistics)

Provides information about the number of documents indexed.

Parameters:

indexStatistics - Provides information about the number of documents indexed.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexStatistics

default GetIndexResponse.Builder indexStatistics(Consumer<IndexStatistics.Builder> indexStatistics)

Provides information about the number of documents indexed.

This is a convenience method that creates an instance of the IndexStatistics.Builder avoiding the need to create one manually via IndexStatistics.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to indexStatistics(IndexStatistics).

Parameters:

indexStatistics - a consumer that will call methods on IndexStatistics.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

indexStatistics(IndexStatistics)