DescribeFeaturedResultsSetResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.DescribeFeaturedResultsSetResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeFeaturedResultsSetResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeFeaturedResultsSetResult()

Constructors
Constructor and Description
`DescribeFeaturedResultsSetResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeFeaturedResultsSetResult`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getCreationTimestamp()` The Unix timestamp when the set of the featured results was created.
`String`	`getDescription()` The description for the set of featured results.
`List<FeaturedDocumentMissing>`	`getFeaturedDocumentsMissing()` The list of document IDs that don't exist but you have specified as featured documents.
`List<FeaturedDocumentWithMetadata>`	`getFeaturedDocumentsWithMetadata()` The list of document IDs for the documents you want to feature with their metadata information.
`String`	`getFeaturedResultsSetId()` The identifier of the set of featured results.
`String`	`getFeaturedResultsSetName()` The name for the set of featured results.
`Long`	`getLastUpdatedTimestamp()` The timestamp when the set of featured results was last updated.
`List<String>`	`getQueryTexts()` The list of queries for featuring results.
`String`	`getStatus()` The current status of the set of featured results.
`int`	`hashCode()`
`void`	`setCreationTimestamp(Long creationTimestamp)` The Unix timestamp when the set of the featured results was created.
`void`	`setDescription(String description)` The description for the set of featured results.
`void`	`setFeaturedDocumentsMissing(Collection<FeaturedDocumentMissing> featuredDocumentsMissing)` The list of document IDs that don't exist but you have specified as featured documents.
`void`	`setFeaturedDocumentsWithMetadata(Collection<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata)` The list of document IDs for the documents you want to feature with their metadata information.
`void`	`setFeaturedResultsSetId(String featuredResultsSetId)` The identifier of the set of featured results.
`void`	`setFeaturedResultsSetName(String featuredResultsSetName)` The name for the set of featured results.
`void`	`setLastUpdatedTimestamp(Long lastUpdatedTimestamp)` The timestamp when the set of featured results was last updated.
`void`	`setQueryTexts(Collection<String> queryTexts)` The list of queries for featuring results.
`void`	`setStatus(String status)` The current status of the set of featured results.
`String`	`toString()` Returns a string representation of this object.
`DescribeFeaturedResultsSetResult`	`withCreationTimestamp(Long creationTimestamp)` The Unix timestamp when the set of the featured results was created.
`DescribeFeaturedResultsSetResult`	`withDescription(String description)` The description for the set of featured results.
`DescribeFeaturedResultsSetResult`	`withFeaturedDocumentsMissing(Collection<FeaturedDocumentMissing> featuredDocumentsMissing)` The list of document IDs that don't exist but you have specified as featured documents.
`DescribeFeaturedResultsSetResult`	`withFeaturedDocumentsMissing(FeaturedDocumentMissing... featuredDocumentsMissing)` The list of document IDs that don't exist but you have specified as featured documents.
`DescribeFeaturedResultsSetResult`	`withFeaturedDocumentsWithMetadata(Collection<FeaturedDocumentWithMetadata> featuredDocumentsWithMetadata)` The list of document IDs for the documents you want to feature with their metadata information.
`DescribeFeaturedResultsSetResult`	`withFeaturedDocumentsWithMetadata(FeaturedDocumentWithMetadata... featuredDocumentsWithMetadata)` The list of document IDs for the documents you want to feature with their metadata information.
`DescribeFeaturedResultsSetResult`	`withFeaturedResultsSetId(String featuredResultsSetId)` The identifier of the set of featured results.
`DescribeFeaturedResultsSetResult`	`withFeaturedResultsSetName(String featuredResultsSetName)` The name for the set of featured results.
`DescribeFeaturedResultsSetResult`	`withLastUpdatedTimestamp(Long lastUpdatedTimestamp)` The timestamp when the set of featured results was last updated.
`DescribeFeaturedResultsSetResult`	`withQueryTexts(Collection<String> queryTexts)` The list of queries for featuring results.
`DescribeFeaturedResultsSetResult`	`withQueryTexts(String... queryTexts)` The list of queries for featuring results.
`DescribeFeaturedResultsSetResult`	`withStatus(FeaturedResultsSetStatus status)` The current status of the set of featured results.
`DescribeFeaturedResultsSetResult`	`withStatus(String status)` The current status of the set of featured results.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeFeaturedResultsSetResult
```
public DescribeFeaturedResultsSetResult()
```
- Method Detail
  - setFeaturedResultsSetId
```
public void setFeaturedResultsSetId(String featuredResultsSetId)
```
    The identifier of the set of featured results.
    
    Parameters:
    
    featuredResultsSetId - The identifier of the set of featured results.
  - getFeaturedResultsSetId
```
public String getFeaturedResultsSetId()
```
    The identifier of the set of featured results.
    
    Returns:
    
    The identifier of the set of featured results.
  - withFeaturedResultsSetId
```
public DescribeFeaturedResultsSetResult withFeaturedResultsSetId(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.
  - setFeaturedResultsSetName
```
public void setFeaturedResultsSetName(String featuredResultsSetName)
```
    The name for the set of featured results.
    
    Parameters:
    
    featuredResultsSetName - The name for the set of featured results.
  - getFeaturedResultsSetName
```
public String getFeaturedResultsSetName()
```
    The name for the set of featured results.
    
    Returns:
    
    The name for the set of featured results.
  - withFeaturedResultsSetName
```
public DescribeFeaturedResultsSetResult withFeaturedResultsSetName(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.
  - setDescription
```
public void setDescription(String description)
```
    The description for the set of featured results.
    
    Parameters:
    
    description - The description for the set of featured results.
  - getDescription
```
public String getDescription()
```
    The description for the set of featured results.
    
    Returns:
    
    The description for the set of featured results.
  - withDescription
```
public DescribeFeaturedResultsSetResult withDescription(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.
  - 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 DescribeFeaturedResultsSetResult 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 DescribeFeaturedResultsSetResult 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()
```
    The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
    
    Returns:
    
    The list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
  - setQueryTexts
```
public void setQueryTexts(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.
  - withQueryTexts
```
public DescribeFeaturedResultsSetResult withQueryTexts(String... queryTexts)
```
    The 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 - 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.
  - withQueryTexts
```
public DescribeFeaturedResultsSetResult withQueryTexts(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.
  - getFeaturedDocumentsWithMetadata
```
public List<FeaturedDocumentWithMetadata> getFeaturedDocumentsWithMetadata()
```
    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:
    
    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.
  - setFeaturedDocumentsWithMetadata
```
public void setFeaturedDocumentsWithMetadata(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.
  - withFeaturedDocumentsWithMetadata
```
public DescribeFeaturedResultsSetResult withFeaturedDocumentsWithMetadata(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFeaturedDocumentsWithMetadata(java.util.Collection) or withFeaturedDocumentsWithMetadata(java.util.Collection) if you want to override the existing values.
    
    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.
  - withFeaturedDocumentsWithMetadata
```
public DescribeFeaturedResultsSetResult withFeaturedDocumentsWithMetadata(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.
  - getFeaturedDocumentsMissing
```
public List<FeaturedDocumentMissing> getFeaturedDocumentsMissing()
```
    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:
    
    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.
  - setFeaturedDocumentsMissing
```
public void setFeaturedDocumentsMissing(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.
  - withFeaturedDocumentsMissing
```
public DescribeFeaturedResultsSetResult withFeaturedDocumentsMissing(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFeaturedDocumentsMissing(java.util.Collection) or withFeaturedDocumentsMissing(java.util.Collection) if you want to override the existing values.
    
    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.
  - withFeaturedDocumentsMissing
```
public DescribeFeaturedResultsSetResult withFeaturedDocumentsMissing(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.
  - setLastUpdatedTimestamp
```
public void setLastUpdatedTimestamp(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.
  - getLastUpdatedTimestamp
```
public Long getLastUpdatedTimestamp()
```
    The timestamp when the set of featured results was last updated.
    
    Returns:
    
    The timestamp when the set of featured results was last updated.
  - withLastUpdatedTimestamp
```
public DescribeFeaturedResultsSetResult withLastUpdatedTimestamp(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.
  - setCreationTimestamp
```
public void setCreationTimestamp(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.
  - getCreationTimestamp
```
public Long getCreationTimestamp()
```
    The Unix timestamp when the set of the featured results was created.
    
    Returns:
    
    The Unix timestamp when the set of the featured results was created.
  - withCreationTimestamp
```
public DescribeFeaturedResultsSetResult withCreationTimestamp(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.
  - 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 DescribeFeaturedResultsSetResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.793

Class DescribeFeaturedResultsSetResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeFeaturedResultsSetResult

Method Detail

setFeaturedResultsSetId

getFeaturedResultsSetId

withFeaturedResultsSetId

setFeaturedResultsSetName

getFeaturedResultsSetName

withFeaturedResultsSetName

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

getQueryTexts

setQueryTexts

withQueryTexts

withQueryTexts

getFeaturedDocumentsWithMetadata

setFeaturedDocumentsWithMetadata

withFeaturedDocumentsWithMetadata

withFeaturedDocumentsWithMetadata

getFeaturedDocumentsMissing

setFeaturedDocumentsMissing

withFeaturedDocumentsMissing

withFeaturedDocumentsMissing

setLastUpdatedTimestamp

getLastUpdatedTimestamp

withLastUpdatedTimestamp

setCreationTimestamp

getCreationTimestamp

withCreationTimestamp

toString

equals

hashCode

clone