software.amazon.awssdk.services.kendra.model

Interface DescribeFeaturedResultsSetResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>, KendraResponse.Builder, SdkBuilder<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeFeaturedResultsSetResponse

public static interface DescribeFeaturedResultsSetResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeFeaturedResultsSetResponse.Builder,DescribeFeaturedResultsSetResponse>

Method Summary

Modifier and Type	Method and Description
DescribeFeaturedResultsSetResponse.Builder	creationTimestamp(Long creationTimestamp) The Unix timestamp when the set of the featured results was created.
DescribeFeaturedResultsSetResponse.Builder	description(String description) The description for the set of featured results.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsMissing(Collection<FeaturedDocumentMissing> featuredDocumentsMissing) The list of document IDs that don't exist but you have specified as featured documents.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsMissing(Consumer<FeaturedDocumentMissing.Builder>... featuredDocumentsMissing) The list of document IDs that don't exist but you have specified as featured documents.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsMissing(FeaturedDocumentMissing... featuredDocumentsMissing) The list of document IDs that don't exist but you have specified as featured documents.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsWithMetadata(Collection<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata) The list of document IDs for the documents you want to feature with their metadata information.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsWithMetadata(Consumer<FeaturedDocumentWithMetadata.Builder>... featuredDocumentsWithMetadata) The list of document IDs for the documents you want to feature with their metadata information.
DescribeFeaturedResultsSetResponse.Builder	featuredDocumentsWithMetadata(FeaturedDocumentWithMetadata... featuredDocumentsWithMetadata) The list of document IDs for the documents you want to feature with their metadata information.
DescribeFeaturedResultsSetResponse.Builder	featuredResultsSetId(String featuredResultsSetId) The identifier of the set of featured results.
DescribeFeaturedResultsSetResponse.Builder	featuredResultsSetName(String featuredResultsSetName) The name for the set of featured results.
DescribeFeaturedResultsSetResponse.Builder	lastUpdatedTimestamp(Long lastUpdatedTimestamp) The timestamp when the set of featured results was last updated.
DescribeFeaturedResultsSetResponse.Builder	queryTexts(Collection<String> queryTexts) The list of queries for featuring results.
DescribeFeaturedResultsSetResponse.Builder	queryTexts(String... queryTexts) The list of queries for featuring results.
DescribeFeaturedResultsSetResponse.Builder	status(FeaturedResultsSetStatus status) The current status of the set of featured results.
DescribeFeaturedResultsSetResponse.Builder	status(String status) The current status of the set of featured results.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

featuredResultsSetId

DescribeFeaturedResultsSetResponse.Builder featuredResultsSetId(String featuredResultsSetId)

The identifier of the set of featured results.

Parameters:

featuredResultsSetId - The identifier of the set of featured results.

Returns:

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

featuredResultsSetName

DescribeFeaturedResultsSetResponse.Builder featuredResultsSetName(String featuredResultsSetName)

The name for the set of featured results.

Parameters:

featuredResultsSetName - The name for the set of featured results.

Returns:

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

description

DescribeFeaturedResultsSetResponse.Builder description(String description)

The description for the set of featured results.

Parameters:

description - The description for the set of featured results.

Returns:

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

status

DescribeFeaturedResultsSetResponse.Builder status(String status)

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Parameters:

status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Returns:

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

See Also:

FeaturedResultsSetStatus, FeaturedResultsSetStatus

status

DescribeFeaturedResultsSetResponse.Builder status(FeaturedResultsSetStatus status)

The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Parameters:

status - The current status of the set of featured results. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. You can set the status to ACTIVE or INACTIVE using the UpdateFeaturedResultsSet API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is ACTIVE or INACTIVE.

Returns:

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

See Also:

FeaturedResultsSetStatus, FeaturedResultsSetStatus

queryTexts

DescribeFeaturedResultsSetResponse.Builder queryTexts(Collection<String> queryTexts)

The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Parameters:

queryTexts - The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Returns:

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

queryTexts

DescribeFeaturedResultsSetResponse.Builder queryTexts(String... queryTexts)

The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Parameters:

queryTexts - The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.

Returns:

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

featuredDocumentsWithMetadata

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsWithMetadata(Collection<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata)

The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

Parameters:

featuredDocumentsWithMetadata - The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

Returns:

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

featuredDocumentsWithMetadata

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsWithMetadata(FeaturedDocumentWithMetadata... featuredDocumentsWithMetadata)

The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

Parameters:

featuredDocumentsWithMetadata - The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

Returns:

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

featuredDocumentsWithMetadata

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsWithMetadata(Consumer<FeaturedDocumentWithMetadata.Builder>... featuredDocumentsWithMetadata)

The list of document IDs for the documents you want to feature with their metadata information. For more information on the list of featured documents, see FeaturedResultsSet.

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

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

Parameters:

featuredDocumentsWithMetadata - a consumer that will call methods on FeaturedDocumentWithMetadata.Builder

Returns:

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

See Also:

#featuredDocumentsWithMetadata(java.util.Collection)

featuredDocumentsMissing

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsMissing(Collection<FeaturedDocumentMissing> featuredDocumentsMissing)

The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

Parameters:

featuredDocumentsMissing - The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

Returns:

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

featuredDocumentsMissing

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsMissing(FeaturedDocumentMissing... featuredDocumentsMissing)

The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

Parameters:

featuredDocumentsMissing - The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

Returns:

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

featuredDocumentsMissing

DescribeFeaturedResultsSetResponse.Builder featuredDocumentsMissing(Consumer<FeaturedDocumentMissing.Builder>... featuredDocumentsMissing)

The list of document IDs that don't exist but you have specified as featured documents. Amazon Kendra cannot feature these documents if they don't exist in the index. You can check the status of a document and its ID or check for documents with status errors using the BatchGetDocumentStatus API.

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

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

Parameters:

featuredDocumentsMissing - a consumer that will call methods on FeaturedDocumentMissing.Builder

Returns:

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

See Also:

#featuredDocumentsMissing(java.util.Collection)

lastUpdatedTimestamp

DescribeFeaturedResultsSetResponse.Builder lastUpdatedTimestamp(Long lastUpdatedTimestamp)

The timestamp when the set of featured results was last updated.

Parameters:

lastUpdatedTimestamp - The timestamp when the set of featured results was last updated.

Returns:

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

creationTimestamp

DescribeFeaturedResultsSetResponse.Builder creationTimestamp(Long creationTimestamp)

The Unix timestamp when the set of the featured results was created.

Parameters:

creationTimestamp - The Unix timestamp when the set of the featured results was created.

Returns:

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