com.amazonaws.services.simpleemail.model.WorkmailAction Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ses Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to
* Amazon Simple Notification Service (Amazon SNS). It usually isn't necessary to set this up manually, because Amazon
* WorkMail adds the rule automatically during its setup procedure.
*
*
* For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WorkmailAction implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find
* the ARN of a topic by using the ListTopics operation in Amazon SNS.
*
*
* For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
*
*/
private String topicArn;
/**
*
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations
* operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string
* of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*
*/
private String organizationArn;
/**
*
* The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. You can find
* the ARN of a topic by using the ListTopics operation in Amazon SNS.
*
*
* 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 WorkMail action is called. You
* can find the ARN of a topic by using the ListTopics operation in Amazon
* SNS.
*
* 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 WorkMail action is called. You can find
* the ARN of a topic by using the ListTopics operation in Amazon SNS.
*
*
* 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 WorkMail action is called. You
* can find the ARN of a topic by using the ListTopics operation in Amazon
* SNS.
*
* 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 WorkMail action is called. You can find
* the ARN of a topic by using the ListTopics operation in Amazon SNS.
*
*
* 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 WorkMail action is called. You
* can find the ARN of a topic by using the ListTopics operation in Amazon
* SNS.
*
* 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 WorkmailAction withTopicArn(String topicArn) {
setTopicArn(topicArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations
* operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string
* of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*
*
* @param organizationArn
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "
* m-", followed by a string of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*/
public void setOrganizationArn(String organizationArn) {
this.organizationArn = organizationArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations
* operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string
* of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*
*
* @return The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the
* following format:
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "
* m-", followed by a string of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*/
public String getOrganizationArn() {
return this.organizationArn;
}
/**
*
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations
* operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "m-", followed by a string
* of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
*
*
* @param organizationArn
* The Amazon Resource Name (ARN) of the Amazon WorkMail organization. Amazon WorkMail ARNs use the following
* format:
*
* arn:aws:workmail:<region>:<awsAccountId>:organization/<workmailOrganizationId>
*
*
* You can find the ID of your organization by using the ListOrganizations operation in Amazon WorkMail. Amazon WorkMail organization IDs begin with "
* m-", followed by a string of alphanumeric characters.
*
*
* For information about Amazon WorkMail organizations, see the Amazon WorkMail
* Administrator Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WorkmailAction withOrganizationArn(String organizationArn) {
setOrganizationArn(organizationArn);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTopicArn() != null)
sb.append("TopicArn: ").append(getTopicArn()).append(",");
if (getOrganizationArn() != null)
sb.append("OrganizationArn: ").append(getOrganizationArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof WorkmailAction == false)
return false;
WorkmailAction other = (WorkmailAction) obj;
if (other.getTopicArn() == null ^ this.getTopicArn() == null)
return false;
if (other.getTopicArn() != null && other.getTopicArn().equals(this.getTopicArn()) == false)
return false;
if (other.getOrganizationArn() == null ^ this.getOrganizationArn() == null)
return false;
if (other.getOrganizationArn() != null && other.getOrganizationArn().equals(this.getOrganizationArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTopicArn() == null) ? 0 : getTopicArn().hashCode());
hashCode = prime * hashCode + ((getOrganizationArn() == null) ? 0 : getOrganizationArn().hashCode());
return hashCode;
}
@Override
public WorkmailAction clone() {
try {
return (WorkmailAction) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}