com.amazonaws.services.connectcases.model

Class SearchCasesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connectcases.model.SearchCasesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchCasesRequest
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
SearchCasesRequest()

Method Summary

Modifier and Type	Method and Description
SearchCasesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDomainId() The unique identifier of the Cases domain.
List<FieldIdentifier>	getFields() The list of field identifiers to be returned as part of the response.
CaseFilter	getFilter() A list of filter objects.
Integer	getMaxResults() The maximum number of cases to return.
String	getNextToken() The token for the next set of results.
String	getSearchTerm() A word or phrase used to perform a quick search.
List<Sort>	getSorts() A list of sorts where each sort specifies a field and their sort order to be applied to the results.
int	hashCode()
void	setDomainId(String domainId) The unique identifier of the Cases domain.
void	setFields(Collection<FieldIdentifier> fields) The list of field identifiers to be returned as part of the response.
void	setFilter(CaseFilter filter) A list of filter objects.
void	setMaxResults(Integer maxResults) The maximum number of cases to return.
void	setNextToken(String nextToken) The token for the next set of results.
void	setSearchTerm(String searchTerm) A word or phrase used to perform a quick search.
void	setSorts(Collection<Sort> sorts) A list of sorts where each sort specifies a field and their sort order to be applied to the results.
String	toString() Returns a string representation of this object.
SearchCasesRequest	withDomainId(String domainId) The unique identifier of the Cases domain.
SearchCasesRequest	withFields(Collection<FieldIdentifier> fields) The list of field identifiers to be returned as part of the response.
SearchCasesRequest	withFields(FieldIdentifier... fields) The list of field identifiers to be returned as part of the response.
SearchCasesRequest	withFilter(CaseFilter filter) A list of filter objects.
SearchCasesRequest	withMaxResults(Integer maxResults) The maximum number of cases to return.
SearchCasesRequest	withNextToken(String nextToken) The token for the next set of results.
SearchCasesRequest	withSearchTerm(String searchTerm) A word or phrase used to perform a quick search.
SearchCasesRequest	withSorts(Collection<Sort> sorts) A list of sorts where each sort specifies a field and their sort order to be applied to the results.
SearchCasesRequest	withSorts(Sort... sorts) A list of sorts where each sort specifies a field and their sort order to be applied to the results.

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

SearchCasesRequest

public SearchCasesRequest()

Method Detail

setDomainId

public void setDomainId(String domainId)

The unique identifier of the Cases domain.

Parameters:

domainId - The unique identifier of the Cases domain.

getDomainId

public String getDomainId()

The unique identifier of the Cases domain.

Returns:

The unique identifier of the Cases domain.

withDomainId

public SearchCasesRequest withDomainId(String domainId)

The unique identifier of the Cases domain.

Parameters:

domainId - The unique identifier of the Cases domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFields

public List<FieldIdentifier> getFields()

The list of field identifiers to be returned as part of the response.

Returns:

The list of field identifiers to be returned as part of the response.

setFields

public void setFields(Collection<FieldIdentifier> fields)

The list of field identifiers to be returned as part of the response.

Parameters:

fields - The list of field identifiers to be returned as part of the response.

withFields

public SearchCasesRequest withFields(FieldIdentifier... fields)

The list of field identifiers to be returned as part of the response.

NOTE: This method appends the values to the existing list (if any). Use setFields(java.util.Collection) or withFields(java.util.Collection) if you want to override the existing values.

Parameters:

fields - The list of field identifiers to be returned as part of the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFields

public SearchCasesRequest withFields(Collection<FieldIdentifier> fields)

The list of field identifiers to be returned as part of the response.

Parameters:

fields - The list of field identifiers to be returned as part of the response.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilter

public void setFilter(CaseFilter filter)

A list of filter objects.

Parameters:

filter - A list of filter objects.

getFilter

public CaseFilter getFilter()

A list of filter objects.

Returns:

A list of filter objects.

withFilter

public SearchCasesRequest withFilter(CaseFilter filter)

A list of filter objects.

Parameters:

filter - A list of filter objects.

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 cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

Parameters:

maxResults - The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

getMaxResults

public Integer getMaxResults()

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

Returns:

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

withMaxResults

public SearchCasesRequest withMaxResults(Integer maxResults)

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

Parameters:

maxResults - The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

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

setSearchTerm

public void setSearchTerm(String searchTerm)

A word or phrase used to perform a quick search.

Parameters:

searchTerm - A word or phrase used to perform a quick search.

getSearchTerm

public String getSearchTerm()

A word or phrase used to perform a quick search.

Returns:

A word or phrase used to perform a quick search.

withSearchTerm

public SearchCasesRequest withSearchTerm(String searchTerm)

A word or phrase used to perform a quick search.

Parameters:

searchTerm - A word or phrase used to perform a quick search.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSorts

public List<Sort> getSorts()

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Returns:

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

setSorts

public void setSorts(Collection<Sort> sorts)

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Parameters:

sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.

withSorts

public SearchCasesRequest withSorts(Sort... sorts)

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

NOTE: This method appends the values to the existing list (if any). Use setSorts(java.util.Collection) or withSorts(java.util.Collection) if you want to override the existing values.

Parameters:

sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSorts

public SearchCasesRequest withSorts(Collection<Sort> sorts)

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

Parameters:

sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.

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 SearchCasesRequest 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()