com.amazonaws.services.elastictranscoder.model

Class ListJobsByPipelineRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListJobsByPipelineRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListJobsByPipeline operation.

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

See Also:

AmazonElasticTranscoder.listJobsByPipeline(ListJobsByPipelineRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListJobsByPipelineRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListJobsByPipelineRequest	clone() Creates a shallow clone of this request.
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	getPipelineId() The ID of the pipeline for which you want to get job information.
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	setPipelineId(String pipelineId) The ID of the pipeline for which you want to get job information.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListJobsByPipelineRequest	withAscending(String ascending) To list jobs in chronological order by the date and time that they were submitted, enter true.
ListJobsByPipelineRequest	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.
ListJobsByPipelineRequest	withPipelineId(String pipelineId) The ID of the pipeline for which you want to get job information.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListJobsByPipelineRequest

public ListJobsByPipelineRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline for which you want to get job information.

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

Returns:

The ID of the pipeline for which you want to get job information.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline for which you want to get job information.

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

Parameters:

pipelineId - The ID of the pipeline for which you want to get job information.

withPipelineId

public ListJobsByPipelineRequest withPipelineId(String pipelineId)

The ID of the pipeline for which you want to get job information.

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

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

Parameters:

pipelineId - The ID of the pipeline for which you want to get job information.

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 ListJobsByPipelineRequest 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 ListJobsByPipelineRequest 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

clone

public ListJobsByPipelineRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()