software.amazon.awssdk.services.kendra.model

Class SubmitFeedbackRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SubmitFeedbackRequest.Builder,SubmitFeedbackRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SubmitFeedbackRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SubmitFeedbackRequest.Builder	builder()
List<ClickFeedback>	clickFeedbackItems() Tells Amazon Kendra that a particular search result link was chosen by the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClickFeedbackItems() For responses, this returns true if the service returned a value for the ClickFeedbackItems property.
int	hashCode()
boolean	hasRelevanceFeedbackItems() For responses, this returns true if the service returned a value for the RelevanceFeedbackItems property.
String	indexId() The identifier of the index that was queried.
String	queryId() The identifier of the specific query for which you are submitting feedback.
List<RelevanceFeedback>	relevanceFeedbackItems() Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
List<SdkField<?>>	sdkFields()
static Class<? extends SubmitFeedbackRequest.Builder>	serializableBuilderClass()
SubmitFeedbackRequest.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 was queried.

Returns:

The identifier of the index that was queried.

queryId

public final String queryId()

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

Returns:

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

hasClickFeedbackItems

public final boolean hasClickFeedbackItems()

For responses, this returns true if the service returned a value for the ClickFeedbackItems 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.

clickFeedbackItems

public final List<ClickFeedback> clickFeedbackItems()

Tells Amazon Kendra that a particular search result link was chosen by the user.

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 hasClickFeedbackItems() method.

Returns:

Tells Amazon Kendra that a particular search result link was chosen by the user.

hasRelevanceFeedbackItems

public final boolean hasRelevanceFeedbackItems()

For responses, this returns true if the service returned a value for the RelevanceFeedbackItems 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.

relevanceFeedbackItems

public final List<RelevanceFeedback> relevanceFeedbackItems()

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

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 hasRelevanceFeedbackItems() method.

Returns:

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

toBuilder

public SubmitFeedbackRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SubmitFeedbackRequest.Builder,SubmitFeedbackRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static SubmitFeedbackRequest.Builder builder()

serializableBuilderClass

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