com.amazonaws.services.deadline.model

Class SearchTasksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.deadline.model.SearchTasksRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
SearchTasksRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getFarmId() The farm ID of the task.
SearchGroupedFilterExpressions	getFilterExpressions() The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
Integer	getItemOffset() Defines how far into the scrollable list to start the return of results.
String	getJobId() The job ID for the task search.
Integer	getPageSize() Specifies the number of items per page for the resource.
List<String>	getQueueIds() The queue IDs to include in the search.
List<SearchSortExpression>	getSortExpressions() The search terms for a resource.
int	hashCode()
void	setFarmId(String farmId) The farm ID of the task.
void	setFilterExpressions(SearchGroupedFilterExpressions filterExpressions) The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
void	setItemOffset(Integer itemOffset) Defines how far into the scrollable list to start the return of results.
void	setJobId(String jobId) The job ID for the task search.
void	setPageSize(Integer pageSize) Specifies the number of items per page for the resource.
void	setQueueIds(Collection<String> queueIds) The queue IDs to include in the search.
void	setSortExpressions(Collection<SearchSortExpression> sortExpressions) The search terms for a resource.
String	toString() Returns a string representation of this object.
SearchTasksRequest	withFarmId(String farmId) The farm ID of the task.
SearchTasksRequest	withFilterExpressions(SearchGroupedFilterExpressions filterExpressions) The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
SearchTasksRequest	withItemOffset(Integer itemOffset) Defines how far into the scrollable list to start the return of results.
SearchTasksRequest	withJobId(String jobId) The job ID for the task search.
SearchTasksRequest	withPageSize(Integer pageSize) Specifies the number of items per page for the resource.
SearchTasksRequest	withQueueIds(Collection<String> queueIds) The queue IDs to include in the search.
SearchTasksRequest	withQueueIds(String... queueIds) The queue IDs to include in the search.
SearchTasksRequest	withSortExpressions(Collection<SearchSortExpression> sortExpressions) The search terms for a resource.
SearchTasksRequest	withSortExpressions(SearchSortExpression... sortExpressions) The search terms for a resource.

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

SearchTasksRequest

public SearchTasksRequest()

Method Detail

setFarmId

public void setFarmId(String farmId)

The farm ID of the task.

Parameters:

farmId - The farm ID of the task.

getFarmId

public String getFarmId()

The farm ID of the task.

Returns:

The farm ID of the task.

withFarmId

public SearchTasksRequest withFarmId(String farmId)

The farm ID of the task.

Parameters:

farmId - The farm ID of the task.

Returns:

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

setFilterExpressions

public void setFilterExpressions(SearchGroupedFilterExpressions filterExpressions)

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

Parameters:

filterExpressions - The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

getFilterExpressions

public SearchGroupedFilterExpressions getFilterExpressions()

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

Returns:

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

withFilterExpressions

public SearchTasksRequest withFilterExpressions(SearchGroupedFilterExpressions filterExpressions)

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

Parameters:

filterExpressions - The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

Returns:

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

setItemOffset

public void setItemOffset(Integer itemOffset)

Defines how far into the scrollable list to start the return of results.

Parameters:

itemOffset - Defines how far into the scrollable list to start the return of results.

getItemOffset

public Integer getItemOffset()

Defines how far into the scrollable list to start the return of results.

Returns:

Defines how far into the scrollable list to start the return of results.

withItemOffset

public SearchTasksRequest withItemOffset(Integer itemOffset)

Defines how far into the scrollable list to start the return of results.

Parameters:

itemOffset - Defines how far into the scrollable list to start the return of results.

Returns:

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

setJobId

public void setJobId(String jobId)

The job ID for the task search.

Parameters:

jobId - The job ID for the task search.

getJobId

public String getJobId()

The job ID for the task search.

Returns:

The job ID for the task search.

withJobId

public SearchTasksRequest withJobId(String jobId)

The job ID for the task search.

Parameters:

jobId - The job ID for the task search.

Returns:

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

setPageSize

public void setPageSize(Integer pageSize)

Specifies the number of items per page for the resource.

Parameters:

pageSize - Specifies the number of items per page for the resource.

getPageSize

public Integer getPageSize()

Specifies the number of items per page for the resource.

Returns:

Specifies the number of items per page for the resource.

withPageSize

public SearchTasksRequest withPageSize(Integer pageSize)

Specifies the number of items per page for the resource.

Parameters:

pageSize - Specifies the number of items per page for the resource.

Returns:

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

getQueueIds

public List<String> getQueueIds()

The queue IDs to include in the search.

Returns:

The queue IDs to include in the search.

setQueueIds

public void setQueueIds(Collection<String> queueIds)

The queue IDs to include in the search.

Parameters:

queueIds - The queue IDs to include in the search.

withQueueIds

public SearchTasksRequest withQueueIds(String... queueIds)

The queue IDs to include in the search.

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

Parameters:

queueIds - The queue IDs to include in the search.

Returns:

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

withQueueIds

public SearchTasksRequest withQueueIds(Collection<String> queueIds)

The queue IDs to include in the search.

Parameters:

queueIds - The queue IDs to include in the search.

Returns:

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

getSortExpressions

public List<SearchSortExpression> getSortExpressions()

The search terms for a resource.

Returns:

The search terms for a resource.

setSortExpressions

public void setSortExpressions(Collection<SearchSortExpression> sortExpressions)

The search terms for a resource.

Parameters:

sortExpressions - The search terms for a resource.

withSortExpressions

public SearchTasksRequest withSortExpressions(SearchSortExpression... sortExpressions)

The search terms for a resource.

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

Parameters:

sortExpressions - The search terms for a resource.

Returns:

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

withSortExpressions

public SearchTasksRequest withSortExpressions(Collection<SearchSortExpression> sortExpressions)

The search terms for a resource.

Parameters:

sortExpressions - The search terms for a resource.

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