com.amazonaws.services.elastictranscoder.model

Class ListJobsByStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elastictranscoder.model.ListJobsByStatusRequest

All Implemented Interfaces:

Serializable

public class ListJobsByStatusRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListJobsByStatus operation.

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

See Also:

AmazonElasticTranscoder.listJobsByStatus(ListJobsByStatusRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListJobsByStatusRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAscending() To list jobs in chronological order by the date and time that they were submitted, enter true.
String	getPageToken() When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
String	getStatus() To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.
int	hashCode()
void	setAscending(String ascending) To list jobs in chronological order by the date and time that they were submitted, enter true.
void	setPageToken(String pageToken) When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
void	setStatus(String status) To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListJobsByStatusRequest	withAscending(String ascending) To list jobs in chronological order by the date and time that they were submitted, enter true.
ListJobsByStatusRequest	withPageToken(String pageToken) When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.
ListJobsByStatusRequest	withStatus(String status) To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListJobsByStatusRequest

public ListJobsByStatusRequest()

Method Detail

getStatus

public String getStatus()

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Returns:

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

setStatus

public void setStatus(String status)

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Parameters:

status - To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

withStatus

public ListJobsByStatusRequest withStatus(String status)

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

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

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Parameters:

status - To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

Returns:

A reference to this updated object so that method calls can be chained together.

getAscending

public String getAscending()

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Constraints:
Pattern: (^true$)|(^false$)

Returns:

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

setAscending

public void setAscending(String ascending)

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Constraints:
Pattern: (^true$)|(^false$)

Parameters:

ascending - To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

withAscending

public ListJobsByStatusRequest withAscending(String ascending)

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

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

Constraints:
Pattern: (^true$)|(^false$)

Parameters:

ascending - To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

Returns:

A reference to this updated object so that method calls can be chained together.

getPageToken

public String getPageToken()

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Constraints:
Pattern: ^\d{13}-\w{6}$

Returns:

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

setPageToken

public void setPageToken(String pageToken)

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:

pageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

withPageToken

public ListJobsByStatusRequest withPageToken(String pageToken)

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

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

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:

pageToken - When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object