com.amazonaws.services.simpleemail.model.StopAction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.simpleemail.model;
import 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.
*
*/
public class StopAction implements Serializable, Cloneable {
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*/
private String scope;
/**
*
* 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.
*
*/
private String topicArn;
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*
* @param scope
* The scope to which the Stop action applies. That is, what is being
* stopped.
* @see StopScope
*/
public void setScope(String scope) {
this.scope = scope;
}
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*
* @return The scope to which the Stop action applies. That is, what is
* being stopped.
* @see StopScope
*/
public String getScope() {
return this.scope;
}
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*
* @param scope
* The scope to which the Stop action applies. That is, what is being
* stopped.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see StopScope
*/
public StopAction withScope(String scope) {
setScope(scope);
return this;
}
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*
* @param scope
* The scope to which the Stop action applies. That is, what is being
* stopped.
* @see StopScope
*/
public void setScope(StopScope scope) {
this.scope = scope.toString();
}
/**
*
* The scope to which the Stop action applies. That is, what is being
* stopped.
*
*
* @param scope
* The scope to which the Stop action applies. That is, what is being
* stopped.
* @return Returns a reference to this object so that method calls can be
* chained together.
* @see StopScope
*/
public StopAction withScope(StopScope scope) {
setScope(scope);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setTopicArn(String topicArn) {
this.topicArn = 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.
*
*
* @return 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.
*/
public String getTopicArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StopAction withTopicArn(String topicArn) {
setTopicArn(topicArn);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getScope() != null)
sb.append("Scope: " + getScope() + ",");
if (getTopicArn() != null)
sb.append("TopicArn: " + getTopicArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StopAction == false)
return false;
StopAction other = (StopAction) obj;
if (other.getScope() == null ^ this.getScope() == null)
return false;
if (other.getScope() != null
&& other.getScope().equals(this.getScope()) == false)
return false;
if (other.getTopicArn() == null ^ this.getTopicArn() == null)
return false;
if (other.getTopicArn() != null
&& other.getTopicArn().equals(this.getTopicArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode
+ ((getTopicArn() == null) ? 0 : getTopicArn().hashCode());
return hashCode;
}
@Override
public StopAction clone() {
try {
return (StopAction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}