com.amazonaws.services.kendra.model

Class UpdateFeaturedResultsSetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.UpdateFeaturedResultsSetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateFeaturedResultsSetRequest
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
UpdateFeaturedResultsSetRequest()

Method Summary

Modifier and Type	Method and Description
UpdateFeaturedResultsSetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDescription() A new 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	getFeaturedResultsSetId() The identifier of the set of featured results that you want to update.
String	getFeaturedResultsSetName() A new name for the set of featured results.
String	getIndexId() The identifier of the index used for featuring results.
List<String>	getQueryTexts() A list of queries for featuring results.
String	getStatus() You can set the status to ACTIVE or INACTIVE.
int	hashCode()
void	setDescription(String description) A new 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	setFeaturedResultsSetId(String featuredResultsSetId) The identifier of the set of featured results that you want to update.
void	setFeaturedResultsSetName(String featuredResultsSetName) A new name for the set of featured results.
void	setIndexId(String indexId) The identifier of the index used for featuring results.
void	setQueryTexts(Collection<String> queryTexts) A list of queries for featuring results.
void	setStatus(String status) You can set the status to ACTIVE or INACTIVE.
String	toString() Returns a string representation of this object.
UpdateFeaturedResultsSetRequest	withDescription(String description) A new description for the set of featured results.
UpdateFeaturedResultsSetRequest	withFeaturedDocuments(Collection<FeaturedDocument> featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
UpdateFeaturedResultsSetRequest	withFeaturedDocuments(FeaturedDocument... featuredDocuments) A list of document IDs for the documents you want to feature at the top of the search results page.
UpdateFeaturedResultsSetRequest	withFeaturedResultsSetId(String featuredResultsSetId) The identifier of the set of featured results that you want to update.
UpdateFeaturedResultsSetRequest	withFeaturedResultsSetName(String featuredResultsSetName) A new name for the set of featured results.
UpdateFeaturedResultsSetRequest	withIndexId(String indexId) The identifier of the index used for featuring results.
UpdateFeaturedResultsSetRequest	withQueryTexts(Collection<String> queryTexts) A list of queries for featuring results.
UpdateFeaturedResultsSetRequest	withQueryTexts(String... queryTexts) A list of queries for featuring results.
UpdateFeaturedResultsSetRequest	withStatus(FeaturedResultsSetStatus status) You can set the status to ACTIVE or INACTIVE.
UpdateFeaturedResultsSetRequest	withStatus(String status) You can set the status to ACTIVE or INACTIVE.

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

UpdateFeaturedResultsSetRequest

public UpdateFeaturedResultsSetRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index used for featuring results.

Parameters:

indexId - The identifier of the index used for featuring results.

getIndexId

public String getIndexId()

The identifier of the index used for featuring results.

Returns:

The identifier of the index used for featuring results.

withIndexId

public UpdateFeaturedResultsSetRequest withIndexId(String indexId)

The identifier of the index used for featuring results.

Parameters:

indexId - The identifier of the index used for featuring results.

Returns:

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

setFeaturedResultsSetId

public void setFeaturedResultsSetId(String featuredResultsSetId)

The identifier of the set of featured results that you want to update.

Parameters:

featuredResultsSetId - The identifier of the set of featured results that you want to update.

getFeaturedResultsSetId

public String getFeaturedResultsSetId()

The identifier of the set of featured results that you want to update.

Returns:

The identifier of the set of featured results that you want to update.

withFeaturedResultsSetId

public UpdateFeaturedResultsSetRequest withFeaturedResultsSetId(String featuredResultsSetId)

The identifier of the set of featured results that you want to update.

Parameters:

featuredResultsSetId - The identifier of the set of featured results that you want to update.

Returns:

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

setFeaturedResultsSetName

public void setFeaturedResultsSetName(String featuredResultsSetName)

A new name for the set of featured results.

Parameters:

featuredResultsSetName - A new name for the set of featured results.

getFeaturedResultsSetName

public String getFeaturedResultsSetName()

A new name for the set of featured results.

Returns:

A new name for the set of featured results.

withFeaturedResultsSetName

public UpdateFeaturedResultsSetRequest withFeaturedResultsSetName(String featuredResultsSetName)

A new name for the set of featured results.

Parameters:

featuredResultsSetName - A new 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 new description for the set of featured results.

Parameters:

description - A new description for the set of featured results.

getDescription

public String getDescription()

A new description for the set of featured results.

Returns:

A new description for the set of featured results.

withDescription

public UpdateFeaturedResultsSetRequest withDescription(String description)

A new description for the set of featured results.

Parameters:

description - A new description for the set of featured results.

Returns:

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

setStatus

public void setStatus(String status)

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 - You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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()

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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:

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 UpdateFeaturedResultsSetRequest withStatus(String status)

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 - You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 UpdateFeaturedResultsSetRequest withStatus(FeaturedResultsSetStatus status)

You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 - You can set the status to ACTIVE or INACTIVE. When the value is ACTIVE, featured results are ready for use. You can still configure your settings before setting the status to ACTIVE. 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 UpdateFeaturedResultsSetRequest 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 UpdateFeaturedResultsSetRequest 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 featured 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 featured 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 featured 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 featured documents, see FeaturedResultsSet.

withFeaturedDocuments

public UpdateFeaturedResultsSetRequest 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 featured 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 featured documents, see FeaturedResultsSet.

Returns:

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

withFeaturedDocuments

public UpdateFeaturedResultsSetRequest 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 featured 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 featured documents, see FeaturedResultsSet.

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 UpdateFeaturedResultsSetRequest 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()