com.amazonaws.services.elastictranscoder.model
Class Pipeline

java.lang.Object
  com.amazonaws.services.elastictranscoder.model.Pipeline

All Implemented Interfaces:

java.io.Serializable

public class Pipeline
extends java.lang.Object
implements java.io.Serializable

The pipeline (queue) that is used to manage jobs.

See Also:

Serialized Form

Constructor Summary

Pipeline()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getId() The identifier for the pipeline.
java.lang.String	getInputBucket() The Amazon S3 bucket in which you saved the media files that you want to transcode.
java.lang.String	getName() The name of the pipeline.
Notifications	getNotifications() The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
java.lang.String	getOutputBucket() The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.
java.lang.String	getRole() The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
java.lang.String	getStatus() The current status of the pipeline: active: The pipeline is processing jobs. paused: The pipeline is not currently processing jobs.
int	hashCode()
void	setId(java.lang.String id) The identifier for the pipeline.
void	setInputBucket(java.lang.String inputBucket) The Amazon S3 bucket in which you saved the media files that you want to transcode.
void	setName(java.lang.String name) The name of the pipeline.
void	setNotifications(Notifications notifications) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
void	setOutputBucket(java.lang.String outputBucket) The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.
void	setRole(java.lang.String role) The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
void	setStatus(java.lang.String status) The current status of the pipeline: active: The pipeline is processing jobs. paused: The pipeline is not currently processing jobs.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Pipeline	withId(java.lang.String id) The identifier for the pipeline.
Pipeline	withInputBucket(java.lang.String inputBucket) The Amazon S3 bucket in which you saved the media files that you want to transcode.
Pipeline	withName(java.lang.String name) The name of the pipeline.
Pipeline	withNotifications(Notifications notifications) The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
Pipeline	withOutputBucket(java.lang.String outputBucket) The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.
Pipeline	withRole(java.lang.String role) The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
Pipeline	withStatus(java.lang.String status) The current status of the pipeline: active: The pipeline is processing jobs. paused: The pipeline is not currently processing jobs.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pipeline

public Pipeline()

Method Detail

getId

public java.lang.String getId()

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

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

Returns:

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

setId

public void setId(java.lang.String id)

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

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

Parameters:

id - The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

withId

public Pipeline withId(java.lang.String id)

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

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

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

Parameters:

id - The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Returns:

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

getName

public java.lang.String getName()

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Constraints:
Length: 1 - 40

Returns:

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

setName

public void setName(java.lang.String name)

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Constraints:
Length: 1 - 40

Parameters:

name - The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

withName

public Pipeline withName(java.lang.String name)

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

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

Constraints:
Length: 1 - 40

Parameters:

name - The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Returns:

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

getStatus

public java.lang.String getStatus()

The current status of the pipeline:

• active: The pipeline is processing jobs.
• paused: The pipeline is not currently processing jobs.

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

Returns:

The current status of the pipeline:

• active: The pipeline is processing jobs.
• paused: The pipeline is not currently processing jobs.

setStatus

public void setStatus(java.lang.String status)

The current 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 current status of the pipeline:

• active: The pipeline is processing jobs.
• paused: The pipeline is not currently processing jobs.

withStatus

public Pipeline withStatus(java.lang.String status)

The current 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 current 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.

getInputBucket

public java.lang.String getInputBucket()

The Amazon S3 bucket in which you saved the media files that you want to transcode.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Returns:

The Amazon S3 bucket in which you saved the media files that you want to transcode.

setInputBucket

public void setInputBucket(java.lang.String inputBucket)

The Amazon S3 bucket in which you saved the media files that you want to transcode.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Parameters:

inputBucket - The Amazon S3 bucket in which you saved the media files that you want to transcode.

withInputBucket

public Pipeline withInputBucket(java.lang.String inputBucket)

The Amazon S3 bucket in which you saved the media files that you want to transcode.

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

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Parameters:

inputBucket - The Amazon S3 bucket in which you saved the media files that you want to transcode.

Returns:

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

getOutputBucket

public java.lang.String getOutputBucket()

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Returns:

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

setOutputBucket

public void setOutputBucket(java.lang.String outputBucket)

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Parameters:

outputBucket - The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

withOutputBucket

public Pipeline withOutputBucket(java.lang.String outputBucket)

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

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

Constraints:
Pattern: ^(\w|\.|-){1,255}$

Parameters:

outputBucket - The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.

Returns:

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

getRole

public java.lang.String getRole()

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

Returns:

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

setRole

public void setRole(java.lang.String role)

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

Parameters:

role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

withRole

public Pipeline withRole(java.lang.String role)

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

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

Constraints:
Pattern: ^arn:aws:iam::\w{12}:role/.+$

Parameters:

role - The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

Returns:

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

getNotifications

public Notifications getNotifications()

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Returns:

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

setNotifications

public void setNotifications(Notifications notifications)

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Parameters:

notifications - The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

withNotifications

public Pipeline withNotifications(Notifications notifications)

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

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

Parameters:

notifications - The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status. To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

• Progressing: The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.
• Completed: The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
• Warning: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
• Error: The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object