CreateFeaturedResultsSetRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kendra.model.KendraRequest
    - - software.amazon.awssdk.services.kendra.model.CreateFeaturedResultsSetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFeaturedResultsSetRequest
extends KendraRequest
implements ToCopyableBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFeaturedResultsSetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFeaturedResultsSetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateFeaturedResultsSetRequest.Builder`	`builder()`
`String`	`clientToken()` A token that you provide to identify the request to create a set of featured results.
`String`	`description()` A description for the set of featured results.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FeaturedDocument>`	`featuredDocuments()` A list of document IDs for the documents you want to feature at the top of the search results page.
`String`	`featuredResultsSetName()` A name for the set of featured results.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFeaturedDocuments()` For responses, this returns true if the service returned a value for the FeaturedDocuments property.
`int`	`hashCode()`
`boolean`	`hasQueryTexts()` For responses, this returns true if the service returned a value for the QueryTexts property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`indexId()` The identifier of the index that you want to use for featuring results.
`List<String>`	`queryTexts()` A list of queries for featuring results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFeaturedResultsSetRequest.Builder>`	`serializableBuilderClass()`
`FeaturedResultsSetStatus`	`status()` The current status of the set of featured results.
`String`	`statusAsString()` The current status of the set of featured results.
`List<Tag>`	`tags()` A list of key-value pairs that identify or categorize the featured results set.
`CreateFeaturedResultsSetRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - indexId
```
public final String indexId()
```
    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.
  - featuredResultsSetName
```
public final String featuredResultsSetName()
```
    A name for the set of featured results.
    
    Returns:
    
    A name for the set of featured results.
  - description
```
public final String description()
```
    A description for the set of featured results.
    
    Returns:
    
    A description for the set of featured results.
  - clientToken
```
public final 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.
    
    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.
  - status
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return FeaturedResultsSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - statusAsString
```
public final String statusAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, status will return FeaturedResultsSetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    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
  - hasQueryTexts
```
public final boolean hasQueryTexts()
```
    For responses, this returns true if the service returned a value for the QueryTexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - queryTexts
```
public final List<String> queryTexts()
```
    A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryTexts() method.
    
    Returns:
    
    A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
  - hasFeaturedDocuments
```
public final boolean hasFeaturedDocuments()
```
    For responses, this returns true if the service returned a value for the FeaturedDocuments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - featuredDocuments
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeaturedDocuments() method.
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<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:_ . : / = + - @.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    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:_ . : / = + - @.
  - toBuilder
```
public CreateFeaturedResultsSetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFeaturedResultsSetRequest.Builder,CreateFeaturedResultsSetRequest>
    
    Specified by:
    
    toBuilder in class KendraRequest
  - builder
```
public static CreateFeaturedResultsSetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFeaturedResultsSetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFeaturedResultsSetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

indexId

featuredResultsSetName

description

clientToken

status

statusAsString

hasQueryTexts

queryTexts

hasFeaturedDocuments

featuredDocuments

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields