Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.elastictranscoder.model
Class UpdatePipelineNotificationsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsRequest
All Implemented Interfaces:
Serializable

public class UpdatePipelineNotificationsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdatePipelineNotifications operation.

To update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline, send a POST request to the /2012-09-25/pipelines/[pipelineId]/notifications resource.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

See Also:
AmazonElasticTranscoder.updatePipelineNotifications(UpdatePipelineNotificationsRequest), Serialized Form

Constructor Summary
UpdatePipelineNotificationsRequest()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getId()
          The identifier of the pipeline for which you want to change notification settings.
 Notifications getNotifications()
          The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
 int hashCode()
           
 void setId(String id)
          The identifier of the pipeline for which you want to change notification settings.
 void setNotifications(Notifications notifications)
          The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 UpdatePipelineNotificationsRequest withId(String id)
          The identifier of the pipeline for which you want to change notification settings.
 UpdatePipelineNotificationsRequest withNotifications(Notifications notifications)
          The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UpdatePipelineNotificationsRequest

public UpdatePipelineNotificationsRequest()
Method Detail

getId

public String getId()
The identifier of the pipeline for which you want to change notification settings.

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

Returns:
The identifier of the pipeline for which you want to change notification settings.

setId

public void setId(String id)
The identifier of the pipeline for which you want to change notification settings.

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

Parameters:
id - The identifier of the pipeline for which you want to change notification settings.

withId

public UpdatePipelineNotificationsRequest withId(String id)
The identifier of the pipeline for which you want to change notification settings.

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 for which you want to change notification settings.
Returns:
A reference to this updated object so that method calls can be chained together.

getNotifications

public Notifications getNotifications()
The topic ARN for 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.

Returns:
The topic ARN for 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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

setNotifications

public void setNotifications(Notifications notifications)
The topic ARN for 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.

Parameters:
notifications - The topic ARN for 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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

withNotifications

public UpdatePipelineNotificationsRequest withNotifications(Notifications notifications)
The topic ARN for 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.

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

Parameters:
notifications - The topic ARN for 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 topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.