SearchQuickResponsesRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.qconnect.model

Class SearchQuickResponsesRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.qconnect.model.SearchQuickResponsesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchQuickResponsesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SearchQuickResponsesRequest ()

Constructors
Constructor and Description
`SearchQuickResponsesRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`SearchQuickResponsesRequest`	`addAttributesEntry (String key, String value)` Add a single Attributes entry
`SearchQuickResponsesRequest`	`clearAttributesEntries ()` Removes all the entries added into Attributes.
`SearchQuickResponsesRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`Map<String,String>`	`getAttributes ()` The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
`String`	`getKnowledgeBaseId ()` The identifier of the knowledge base.
`Integer`	`getMaxResults ()` The maximum number of results to return per page.
`String`	`getNextToken ()` The token for the next set of results.
`QuickResponseSearchExpression`	`getSearchExpression ()` The search expression for querying the quick response.
`int`	`hashCode ()`
`void`	`setAttributes (Map<String,String> attributes)` The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
`void`	`setKnowledgeBaseId (String knowledgeBaseId)` The identifier of the knowledge base.
`void`	`setMaxResults (Integer maxResults)` The maximum number of results to return per page.
`void`	`setNextToken (String nextToken)` The token for the next set of results.
`void`	`setSearchExpression (QuickResponseSearchExpression searchExpression)` The search expression for querying the quick response.
`String`	`toString ()` Returns a string representation of this object.
`SearchQuickResponsesRequest`	`withAttributes (Map<String,String> attributes)` The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
`SearchQuickResponsesRequest`	`withKnowledgeBaseId (String knowledgeBaseId)` The identifier of the knowledge base.
`SearchQuickResponsesRequest`	`withMaxResults (Integer maxResults)` The maximum number of results to return per page.
`SearchQuickResponsesRequest`	`withNextToken (String nextToken)` The token for the next set of results.
`SearchQuickResponsesRequest`	`withSearchExpression (QuickResponseSearchExpression searchExpression)` The search expression for querying the quick response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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

- Constructor Detail
  - SearchQuickResponsesRequest
```
public SearchQuickResponsesRequest()
```
- Method Detail
  - getAttributes
```
public Map<String,String> getAttributes()
```
    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
    
    Returns:
    
    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
    
    Parameters:
    
    attributes - The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
  - withAttributes
```
public SearchQuickResponsesRequest withAttributes(Map<String,String> attributes)
```
    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
    
    Parameters:
    
    attributes - The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public SearchQuickResponsesRequest addAttributesEntry(String key,
 String value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, java.lang.String>)
  - clearAttributesEntries
```
public SearchQuickResponsesRequest clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKnowledgeBaseId
```
public void setKnowledgeBaseId(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.
    
    Parameters:
    
    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.
  - getKnowledgeBaseId
```
public String getKnowledgeBaseId()
```
    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.
  - withKnowledgeBaseId
```
public SearchQuickResponsesRequest withKnowledgeBaseId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of results to return per page.
    
    Parameters:
    
    maxResults - The maximum number of results to return per page.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of results to return per page.
    
    Returns:
    
    The maximum number of results to return per page.
  - withMaxResults
```
public SearchQuickResponsesRequest withMaxResults(Integer maxResults)
```
    The maximum number of results to return per page.
    
    Parameters:
    
    maxResults - The maximum number of results to return per page.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(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.
    
    Parameters:
    
    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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public SearchQuickResponsesRequest withNextToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSearchExpression
```
public void setSearchExpression(QuickResponseSearchExpression searchExpression)
```
    The search expression for querying the quick response.
    
    Parameters:
    
    searchExpression - The search expression for querying the quick response.
  - getSearchExpression
```
public QuickResponseSearchExpression getSearchExpression()
```
    The search expression for querying the quick response.
    
    Returns:
    
    The search expression for querying the quick response.
  - withSearchExpression
```
public SearchQuickResponsesRequest withSearchExpression(QuickResponseSearchExpression searchExpression)
```
    The search expression for querying the quick response.
    
    Parameters:
    
    searchExpression - The search expression for querying the quick response.
    
    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 SearchQuickResponsesRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class SearchQuickResponsesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SearchQuickResponsesRequest

Method Detail

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setKnowledgeBaseId

getKnowledgeBaseId

withKnowledgeBaseId

setMaxResults

getMaxResults

withMaxResults

setNextToken

getNextToken

withNextToken

setSearchExpression

getSearchExpression

withSearchExpression

toString

equals

hashCode

clone