SearchPromptsRequest (aws-android-sdk-connect 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.connect.model.SearchPromptsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class SearchPromptsRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Searches prompts in an Amazon Connect instance, with optional filtering.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchPromptsRequest()

Constructors
Constructor and Description
`SearchPromptsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getInstanceId()` The identifier of the Amazon Connect instance.
`java.lang.Integer`	`getMaxResults()` The maximum number of results to return per page.
`java.lang.String`	`getNextToken()` The token for the next set of results.
`PromptSearchCriteria`	`getSearchCriteria()` The search criteria to be used to return prompts.
`PromptSearchFilter`	`getSearchFilter()` Filters to be applied to search results.
`int`	`hashCode()`
`void`	`setInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`void`	`setMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of results.
`void`	`setSearchCriteria(PromptSearchCriteria searchCriteria)` The search criteria to be used to return prompts.
`void`	`setSearchFilter(PromptSearchFilter searchFilter)` Filters to be applied to search results.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SearchPromptsRequest`	`withInstanceId(java.lang.String instanceId)` The identifier of the Amazon Connect instance.
`SearchPromptsRequest`	`withMaxResults(java.lang.Integer maxResults)` The maximum number of results to return per page.
`SearchPromptsRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of results.
`SearchPromptsRequest`	`withSearchCriteria(PromptSearchCriteria searchCriteria)` The search criteria to be used to return prompts.
`SearchPromptsRequest`	`withSearchFilter(PromptSearchFilter searchFilter)` Filters to be applied to search results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - SearchPromptsRequest
```
public SearchPromptsRequest()
```
- Method Detail
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Returns:
    
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
  - withInstanceId
```
public SearchPromptsRequest withInstanceId(java.lang.String instanceId)
```
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    
    Parameters:
    
    instanceId -
    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 2500
    
    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.
  - setNextToken
```
public void setNextToken(java.lang.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.
    
    Constraints:
    Length: 1 - 2500
    
    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.
  - withNextToken
```
public SearchPromptsRequest withNextToken(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2500
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getMaxResults
```
public java.lang.Integer getMaxResults()
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Returns:
    
    The maximum number of results to return per page.
  - setMaxResults
```
public void setMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
  - withMaxResults
```
public SearchPromptsRequest withMaxResults(java.lang.Integer maxResults)
```
    The maximum number of results to return per page.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 100
    
    Parameters:
    
    maxResults -
    The maximum number of results to return per page.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSearchFilter
```
public PromptSearchFilter getSearchFilter()
```
    Filters to be applied to search results.
    
    Returns:
    
    Filters to be applied to search results.
  - setSearchFilter
```
public void setSearchFilter(PromptSearchFilter searchFilter)
```
    Filters to be applied to search results.
    
    Parameters:
    
    searchFilter -
    Filters to be applied to search results.
  - withSearchFilter
```
public SearchPromptsRequest withSearchFilter(PromptSearchFilter searchFilter)
```
    Filters to be applied to search results.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    searchFilter -
    Filters to be applied to search results.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSearchCriteria
```
public PromptSearchCriteria getSearchCriteria()
```
    The search criteria to be used to return prompts.
    
    Returns:
    
    The search criteria to be used to return prompts.
  - setSearchCriteria
```
public void setSearchCriteria(PromptSearchCriteria searchCriteria)
```
    The search criteria to be used to return prompts.
    
    Parameters:
    
    searchCriteria -
    The search criteria to be used to return prompts.
  - withSearchCriteria
```
public SearchPromptsRequest withSearchCriteria(PromptSearchCriteria searchCriteria)
```
    The search criteria to be used to return prompts.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    searchCriteria -
    The search criteria to be used to return prompts.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class SearchPromptsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SearchPromptsRequest

Method Detail

getInstanceId

setInstanceId

withInstanceId

getNextToken

setNextToken

withNextToken

getMaxResults

setMaxResults

withMaxResults

getSearchFilter

setSearchFilter

withSearchFilter

getSearchCriteria

setSearchCriteria

withSearchCriteria

toString

hashCode

equals