com.amazonaws.services.kendra.model

Class CreateFeaturedResultsSetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateFeaturedResultsSetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFeaturedResultsSetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFeaturedResultsSetRequest()

Method Summary

Modifier and Type	Method and Description
CreateFeaturedResultsSetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A token that you provide to identify the request to create a set of featured results.
String	getDescription() A description for the set of featured results.
List<FeaturedDocument>	getFeaturedDocuments() A list of document IDs for the documents you want to feature at the top of the search results page.
String	getFeaturedResultsSetName() A name for the set of featured results.
String	getIndexId() The identifier of the index that you want to use for featuring results.
List<String>	getQueryTexts() A list of queries for featuring results.
String	getStatus() The current status of the set of featured results.
List<Tag>	getTags() A list of key-value pairs that identify or categorize the featured results set.
int	hashCode()
void	setClientToken(String clientToken) A token that you provide to identify the request to create a set of featured results.
void	setDescription(String description) A description for the set of featured results.
void	setFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
void	setFeaturedResultsSetName(String featuredResultsSetName) A name for the set of featured results.
void	setIndexId(String indexId) The identifier of the index that you want to use for featuring results.
void	setQueryTexts(Collection<String> queryTexts) A list of queries for featuring results.
void	setStatus(String status) The current status of the set of featured results.
void	setTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the featured results set.
String	toString() Returns a string representation of this object.
CreateFeaturedResultsSetRequest	withClientToken(String clientToken) A token that you provide to identify the request to create a set of featured results.
CreateFeaturedResultsSetRequest	withDescription(String description) A description for the set of featured results.
CreateFeaturedResultsSetRequest	withFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
CreateFeaturedResultsSetRequest	withFeaturedDocuments(FeaturedDocument... featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
CreateFeaturedResultsSetRequest	withFeaturedResultsSetName(String featuredResultsSetName) A name for the set of featured results.
CreateFeaturedResultsSetRequest	withIndexId(String indexId) The identifier of the index that you want to use for featuring results.
CreateFeaturedResultsSetRequest	withQueryTexts(Collection<String> queryTexts) A list of queries for featuring results.
CreateFeaturedResultsSetRequest	withQueryTexts(String... queryTexts) A list of queries for featuring results.
CreateFeaturedResultsSetRequest	withStatus(FeaturedResultsSetStatus status) The current status of the set of featured results.
CreateFeaturedResultsSetRequest	withStatus(String status) The current status of the set of featured results.
CreateFeaturedResultsSetRequest	withTags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the featured results set.
CreateFeaturedResultsSetRequest	withTags(Tag... tags) A list of key-value pairs that identify or categorize the featured results set.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFeaturedResultsSetRequest

public CreateFeaturedResultsSetRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index that you want to use for featuring results.

Parameters:

indexId - The identifier of the index that you want to use for featuring results.

getIndexId

public String getIndexId()

The identifier of the index that you want to use for featuring results.

Returns:

The identifier of the index that you want to use for featuring results.

withIndexId

public CreateFeaturedResultsSetRequest withIndexId(String indexId)

The identifier of the index that you want to use for featuring results.

Parameters:

indexId - The identifier of the index that you want to use for featuring results.

Returns:

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

setFeaturedResultsSetName

public void setFeaturedResultsSetName(String featuredResultsSetName)

A name for the set of featured results.

Parameters:

featuredResultsSetName - A name for the set of featured results.

getFeaturedResultsSetName

public String getFeaturedResultsSetName()

A name for the set of featured results.

Returns:

A name for the set of featured results.

withFeaturedResultsSetName

public CreateFeaturedResultsSetRequest withFeaturedResultsSetName(String featuredResultsSetName)

A name for the set of featured results.

Parameters:

featuredResultsSetName - A name for the set of featured results.

Returns:

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

setDescription

public void setDescription(String description)

A description for the set of featured results.

Parameters:

description - A description for the set of featured results.

getDescription

public String getDescription()

A description for the set of featured results.

Returns:

A description for the set of featured results.

withDescription

public CreateFeaturedResultsSetRequest withDescription(String description)

A description for the set of featured results.

Parameters:

description - A description for the set of featured results.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Parameters:

clientToken - A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Returns:

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

withClientToken

public CreateFeaturedResultsSetRequest withClientToken(String clientToken)

A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Parameters:

clientToken - A token that you provide to identify the request to create a set of featured results. Multiple calls to the CreateFeaturedResultsSet API with the same client token will create only one featured results set.

Returns:

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

setStatus

public void setStatus(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.

See Also:

FeaturedResultsSetStatus

getStatus

public String getStatus()

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:

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.

See Also:

FeaturedResultsSetStatus

withStatus

public CreateFeaturedResultsSetRequest withStatus(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

withStatus

public CreateFeaturedResultsSetRequest withStatus(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

getQueryTexts

public List<String> getQueryTexts()

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

Returns:

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

setQueryTexts

public void setQueryTexts(Collection<String> queryTexts)

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

Parameters:

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

withQueryTexts

public CreateFeaturedResultsSetRequest withQueryTexts(String... queryTexts)

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

NOTE: This method appends the values to the existing list (if any). Use setQueryTexts(java.util.Collection) or withQueryTexts(java.util.Collection) if you want to override the existing values.

Parameters:

queryTexts - A 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.

withQueryTexts

public CreateFeaturedResultsSetRequest withQueryTexts(Collection<String> queryTexts)

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

Parameters:

queryTexts - A 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.

getFeaturedDocuments

public List<FeaturedDocument> getFeaturedDocuments()

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Returns:

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

setFeaturedDocuments

public void setFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

withFeaturedDocuments

public CreateFeaturedResultsSetRequest withFeaturedDocuments(FeaturedDocument... featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

NOTE: This method appends the values to the existing list (if any). Use setFeaturedDocuments(java.util.Collection) or withFeaturedDocuments(java.util.Collection) if you want to override the existing values.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Returns:

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

withFeaturedDocuments

public CreateFeaturedResultsSetRequest withFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments)

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Parameters:

featuredDocuments - A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of documents, see FeaturedResultsSet.

Returns:

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

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateFeaturedResultsSetRequest withTags(Tag... tags)

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

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

withTags

public CreateFeaturedResultsSetRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateFeaturedResultsSetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()