com.amazonaws.services.deadline.model

Class SearchJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.deadline.model.SearchJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
SearchJobsRequest	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 job.
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.
Integer	getPageSize() Specifies the number of items per page for the resource.
List<String>	getQueueIds() The queue ID to use in the job search.
List<SearchSortExpression>	getSortExpressions() The search terms for a resource.
int	hashCode()
void	setFarmId(String farmId) The farm ID of the job.
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	setPageSize(Integer pageSize) Specifies the number of items per page for the resource.
void	setQueueIds(Collection<String> queueIds) The queue ID to use in the job search.
void	setSortExpressions(Collection<SearchSortExpression> sortExpressions) The search terms for a resource.
String	toString() Returns a string representation of this object.
SearchJobsRequest	withFarmId(String farmId) The farm ID of the job.
SearchJobsRequest	withFilterExpressions(SearchGroupedFilterExpressions filterExpressions) The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
SearchJobsRequest	withItemOffset(Integer itemOffset) Defines how far into the scrollable list to start the return of results.
SearchJobsRequest	withPageSize(Integer pageSize) Specifies the number of items per page for the resource.
SearchJobsRequest	withQueueIds(Collection<String> queueIds) The queue ID to use in the job search.
SearchJobsRequest	withQueueIds(String... queueIds) The queue ID to use in the job search.
SearchJobsRequest	withSortExpressions(Collection<SearchSortExpression> sortExpressions) The search terms for a resource.
SearchJobsRequest	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

SearchJobsRequest

public SearchJobsRequest()

Method Detail

setFarmId

public void setFarmId(String farmId)

The farm ID of the job.

Parameters:

farmId - The farm ID of the job.

getFarmId

public String getFarmId()

The farm ID of the job.

Returns:

The farm ID of the job.

withFarmId

public SearchJobsRequest withFarmId(String farmId)

The farm ID of the job.

Parameters:

farmId - The farm ID of the job.

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

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 SearchJobsRequest 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 ID to use in the job search.

Returns:

The queue ID to use in the job search.

setQueueIds

public void setQueueIds(Collection<String> queueIds)

The queue ID to use in the job search.

Parameters:

queueIds - The queue ID to use in the job search.

withQueueIds

public SearchJobsRequest withQueueIds(String... queueIds)

The queue ID to use in the job 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 ID to use in the job search.

Returns:

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

withQueueIds

public SearchJobsRequest withQueueIds(Collection<String> queueIds)

The queue ID to use in the job search.

Parameters:

queueIds - The queue ID to use in the job 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 SearchJobsRequest 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 SearchJobsRequest 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 SearchJobsRequest 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()