com.amazonaws.services.simpleemail.model

Class StopAction

java.lang.Object

com.amazonaws.services.simpleemail.model.StopAction

All Implemented Interfaces:

java.io.Serializable

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

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopAction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getScope() The scope of the StopAction.
java.lang.String	getTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
int	hashCode()
void	setScope(StopScope scope) The scope of the StopAction.
void	setScope(java.lang.String scope) The scope of the StopAction.
void	setTopicArn(java.lang.String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StopAction	withScope(StopScope scope) The scope of the StopAction.
StopAction	withScope(java.lang.String scope) The scope of the StopAction.
StopAction	withTopicArn(java.lang.String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopAction

public StopAction()

Method Detail

getScope

public java.lang.String getScope()

The scope of the StopAction. The only acceptable value is RuleSet.

Constraints:
Allowed Values: RuleSet

Returns:

The scope of the StopAction. The only acceptable value is RuleSet.

See Also:

StopScope

setScope

public void setScope(java.lang.String scope)

The scope of the StopAction. The only acceptable value is RuleSet.

Constraints:
Allowed Values: RuleSet

Parameters:

scope -

The scope of the StopAction. The only acceptable value is RuleSet.

See Also:

StopScope

withScope

public StopAction withScope(java.lang.String scope)

The scope of the StopAction. The only acceptable value is RuleSet.

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

Constraints:
Allowed Values: RuleSet

Parameters:

scope -

The scope of the StopAction. The only acceptable value is RuleSet.

Returns:

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

See Also:

StopScope

setScope

public void setScope(StopScope scope)

The scope of the StopAction. The only acceptable value is RuleSet.

Constraints:
Allowed Values: RuleSet

Parameters:

scope -

The scope of the StopAction. The only acceptable value is RuleSet.

See Also:

StopScope

withScope

public StopAction withScope(StopScope scope)

The scope of the StopAction. The only acceptable value is RuleSet.

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

Constraints:
Allowed Values: RuleSet

Parameters:

scope -

The scope of the StopAction. The only acceptable value is RuleSet.

Returns:

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

See Also:

StopScope

getTopicArn

public java.lang.String getTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Returns:

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

setTopicArn

public void setTopicArn(java.lang.String topicArn)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

Parameters:

topicArn -

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

withTopicArn

public StopAction withTopicArn(java.lang.String topicArn)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

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

Parameters:

topicArn -

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

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