Package software.amazon.awssdk.services.kendra.model

Class UpdateFeaturedResultsSetRequest

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.UpdateFeaturedResultsSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFeaturedResultsSetRequest.Builder,UpdateFeaturedResultsSetRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateFeaturedResultsSetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateFeaturedResultsSetRequest.Builder	builder()
String	description()	A new 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	featuredResultsSetId()	The identifier of the set of featured results that you want to update.
String	featuredResultsSetName()	A new 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.
String	indexId()	The identifier of the index used for featuring results.
List<String>	queryTexts()	A list of queries for featuring results.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateFeaturedResultsSetRequest.Builder>	serializableBuilderClass()
FeaturedResultsSetStatus	status()	You can set the status to ACTIVE or INACTIVE.
String	statusAsString()	You can set the status to ACTIVE or INACTIVE.
UpdateFeaturedResultsSetRequest.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 used for featuring results.

Returns:

The identifier of the index used for featuring results.

featuredResultsSetId

public final String featuredResultsSetId()

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.

featuredResultsSetName

public final String featuredResultsSetName()

A new name for the set of featured results.

Returns:

A new name for the set of featured results.

description

public final String description()

A new description for the set of featured results.

Returns:

A new description for the set of featured results.

status

public final 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.

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:

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

statusAsString

public final String statusAsString()

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.

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:

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

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

toBuilder

public UpdateFeaturedResultsSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFeaturedResultsSetRequest.Builder,UpdateFeaturedResultsSetRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static UpdateFeaturedResultsSetRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFeaturedResultsSetRequest.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