Package software.amazon.awssdk.services.qconnect.model

Class SearchQuickResponsesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qconnect.model.QConnectRequest

software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchQuickResponsesRequest.Builder,SearchQuickResponsesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchQuickResponsesRequest.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
static SearchQuickResponsesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes()	For responses, this returns true if the service returned a value for the Attributes property.
int	hashCode()
String	knowledgeBaseId()	The identifier of the knowledge base.
Integer	maxResults()	The maximum number of results to return per page.
String	nextToken()	The token for the next set of results.
List<SdkField<?>>	sdkFields()
QuickResponseSearchExpression	searchExpression()	The search expression for querying the quick response.
static Class<? extends SearchQuickResponsesRequest.Builder>	serializableBuilderClass()
SearchQuickResponsesRequest.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

hasAttributes

public final boolean hasAttributes()

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

attributes

public final Map<String,String> attributes()

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

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

Returns:

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

knowledgeBaseId

public final String knowledgeBaseId()

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

maxResults

public final Integer maxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

nextToken

public final String nextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchExpression

public final QuickResponseSearchExpression searchExpression()

The search expression for querying the quick response.

Returns:

The search expression for querying the quick response.

toBuilder

public SearchQuickResponsesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchQuickResponsesRequest.Builder,SearchQuickResponsesRequest>

Specified by:

toBuilder in class QConnectRequest

builder

public static SearchQuickResponsesRequest.Builder builder()

serializableBuilderClass

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