com.amazonaws.services.elastictranscoder.model

Class UpdatePipelineStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusRequest

All Implemented Interfaces:

Serializable

public class UpdatePipelineStatusRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdatePipelineStatus operation.

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

See Also:

AmazonElasticTranscoder.updatePipelineStatus(UpdatePipelineStatusRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdatePipelineStatusRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId() The identifier of the pipeline to update.
String	getStatus() The desired status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs.
int	hashCode()
void	setId(String id) The identifier of the pipeline to update.
void	setStatus(String status) The desired status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdatePipelineStatusRequest	withId(String id) The identifier of the pipeline to update.
UpdatePipelineStatusRequest	withStatus(String status) The desired status of the pipeline: Active: The pipeline is processing jobs. Paused: The pipeline is not currently processing jobs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdatePipelineStatusRequest

public UpdatePipelineStatusRequest()

Method Detail

getId

public String getId()

The identifier of the pipeline to update.

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

Returns:

The identifier of the pipeline to update.

setId

public void setId(String id)

The identifier of the pipeline to update.

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

Parameters:

id - The identifier of the pipeline to update.

withId

public UpdatePipelineStatusRequest withId(String id)

The identifier of the pipeline to update.

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

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

Parameters:

id - The identifier of the pipeline to update.

Returns:

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

getStatus

public String getStatus()

The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

Constraints:
Pattern: (^Active$)|(^Paused$)

Returns:

The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

setStatus

public void setStatus(String status)

The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

Constraints:
Pattern: (^Active$)|(^Paused$)

Parameters:

status - The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

withStatus

public UpdatePipelineStatusRequest withStatus(String status)

The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

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

Constraints:
Pattern: (^Active$)|(^Paused$)

Parameters:

status - The desired status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

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