Interface GetIndexResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetIndexResponse.Builder,
,GetIndexResponse> QBusinessResponse.Builder
,SdkBuilder<GetIndexResponse.Builder,
,GetIndexResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetIndexResponse
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(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.capacityConfiguration
(IndexCapacityConfiguration capacityConfiguration) The storage capacity units chosen for your Amazon Q Business index.The Unix timestamp when the Amazon Q Business index was created.description
(String description) The description for the Amazon Q Business index.displayName
(String displayName) The name of the Amazon Q Business index.documentAttributeConfigurations
(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations) Configuration information for document attributes or metadata.documentAttributeConfigurations
(Consumer<DocumentAttributeConfiguration.Builder>... documentAttributeConfigurations) Configuration information for document attributes or metadata.documentAttributeConfigurations
(DocumentAttributeConfiguration... documentAttributeConfigurations) Configuration information for document attributes or metadata.default GetIndexResponse.Builder
error
(Consumer<ErrorDetail.Builder> error) When theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.error
(ErrorDetail error) When theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.The Amazon Resource Name (ARN) of the Amazon Q Business index.The identifier of the Amazon Q Business index.default GetIndexResponse.Builder
indexStatistics
(Consumer<IndexStatistics.Builder> indexStatistics) Provides information about the number of documents indexed.indexStatistics
(IndexStatistics indexStatistics) Provides information about the number of documents indexed.The current status of the index.status
(IndexStatus status) The current status of the index.The type of index attached to your Amazon Q Business application.The type of index attached to your Amazon Q Business application.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, sdkFieldNameToField, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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.
-
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
The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Parameters:
status
- The current status of the index. When the value isACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The current status of the index. When the value is
ACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Parameters:
status
- The current status of the index. When the value isACTIVE
, the index is ready for use. If theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
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
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
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
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 theIndexCapacityConfiguration.Builder
avoiding the need to create one manually viaIndexCapacityConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocapacityConfiguration(IndexCapacityConfiguration)
.- Parameters:
capacityConfiguration
- a consumer that will call methods onIndexCapacityConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDocumentAttributeConfiguration.Builder
avoiding the need to create one manually viaDocumentAttributeConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentAttributeConfigurations(List<DocumentAttributeConfiguration>)
.- Parameters:
documentAttributeConfigurations
- a consumer that will call methods onDocumentAttributeConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
error
When the
Status
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Parameters:
error
- When theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
error
When the
This is a convenience method that creates an instance of theStatus
field value isFAILED
, theErrorMessage
field contains a message that explains why.ErrorDetail.Builder
avoiding the need to create one manually viaErrorDetail.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toerror(ErrorDetail)
.- Parameters:
error
- a consumer that will call methods onErrorDetail.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Provides information about the number of documents indexed.
This is a convenience method that creates an instance of theIndexStatistics.Builder
avoiding the need to create one manually viaIndexStatistics.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toindexStatistics(IndexStatistics)
.- Parameters:
indexStatistics
- a consumer that will call methods onIndexStatistics.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-