com.amazonaws.services.simpleemailv2.model.EventDestination Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sesv2 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.simpleemailv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and
* delivery delays. Event destinations are places that you can send information about these events to. For
* example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or
* you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EventDestination implements Serializable, Cloneable, StructuredPojo {
/**
*
* A name that identifies the event destination.
*
*/
private String name;
/**
*
* If true, the event destination is enabled. When the event destination is enabled, the specified
* event types are sent to the destinations in this EventDestinationDefinition.
*
*
* If false, the event destination is disabled. When the event destination is disabled, events aren't
* sent to the specified destinations.
*
*/
private Boolean enabled;
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*/
private java.util.List matchingEventTypes;
/**
*
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis
* Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*
*/
private KinesisFirehoseDestination kinesisFirehoseDestination;
/**
*
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
*
*/
private CloudWatchDestination cloudWatchDestination;
/**
*
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification
* when certain email events occur.
*
*/
private SnsDestination snsDestination;
/**
*
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to
* a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to
* Amazon Pinpoint. For more information, see Transactional
* Messaging Charts in the Amazon Pinpoint User Guide.
*
*/
private PinpointDestination pinpointDestination;
/**
*
* A name that identifies the event destination.
*
*
* @param name
* A name that identifies the event destination.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A name that identifies the event destination.
*
*
* @return A name that identifies the event destination.
*/
public String getName() {
return this.name;
}
/**
*
* A name that identifies the event destination.
*
*
* @param name
* A name that identifies the event destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withName(String name) {
setName(name);
return this;
}
/**
*
* If true, the event destination is enabled. When the event destination is enabled, the specified
* event types are sent to the destinations in this EventDestinationDefinition.
*
*
* If false, the event destination is disabled. When the event destination is disabled, events aren't
* sent to the specified destinations.
*
*
* @param enabled
* If true, the event destination is enabled. When the event destination is enabled, the
* specified event types are sent to the destinations in this EventDestinationDefinition.
*
* If false, the event destination is disabled. When the event destination is disabled, events
* aren't sent to the specified destinations.
*/
public void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
/**
*
* If true, the event destination is enabled. When the event destination is enabled, the specified
* event types are sent to the destinations in this EventDestinationDefinition.
*
*
* If false, the event destination is disabled. When the event destination is disabled, events aren't
* sent to the specified destinations.
*
*
* @return If true, the event destination is enabled. When the event destination is enabled, the
* specified event types are sent to the destinations in this EventDestinationDefinition.
*
* If false, the event destination is disabled. When the event destination is disabled, events
* aren't sent to the specified destinations.
*/
public Boolean getEnabled() {
return this.enabled;
}
/**
*
* If true, the event destination is enabled. When the event destination is enabled, the specified
* event types are sent to the destinations in this EventDestinationDefinition.
*
*
* If false, the event destination is disabled. When the event destination is disabled, events aren't
* sent to the specified destinations.
*
*
* @param enabled
* If true, the event destination is enabled. When the event destination is enabled, the
* specified event types are sent to the destinations in this EventDestinationDefinition.
*
* If false, the event destination is disabled. When the event destination is disabled, events
* aren't sent to the specified destinations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withEnabled(Boolean enabled) {
setEnabled(enabled);
return this;
}
/**
*
* If true, the event destination is enabled. When the event destination is enabled, the specified
* event types are sent to the destinations in this EventDestinationDefinition.
*
*
* If false, the event destination is disabled. When the event destination is disabled, events aren't
* sent to the specified destinations.
*
*
* @return If true, the event destination is enabled. When the event destination is enabled, the
* specified event types are sent to the destinations in this EventDestinationDefinition.
*
* If false, the event destination is disabled. When the event destination is disabled, events
* aren't sent to the specified destinations.
*/
public Boolean isEnabled() {
return this.enabled;
}
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*
* @return The types of events that Amazon SES sends to the specified event destinations.
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it
* as a send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt
* to deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email.
* (Soft bounces are only included when SES fails to deliver the email after retrying for a period of
* time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the
* recipient marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event
* type can occur when template data is missing, or when there is a mismatch between template parameters and
* data. (This event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a
* temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or
* when the receiving email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their
* subscription preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
* @see EventType
*/
public java.util.List getMatchingEventTypes() {
return matchingEventTypes;
}
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*
* @param matchingEventTypes
* The types of events that Amazon SES sends to the specified event destinations.
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as
* a send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt
* to deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email.
* (Soft bounces are only included when SES fails to deliver the email after retrying for a period of
* time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the
* recipient marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event
* type can occur when template data is missing, or when there is a mismatch between template parameters and
* data. (This event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a
* temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or
* when the receiving email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their
* subscription preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
* @see EventType
*/
public void setMatchingEventTypes(java.util.Collection matchingEventTypes) {
if (matchingEventTypes == null) {
this.matchingEventTypes = null;
return;
}
this.matchingEventTypes = new java.util.ArrayList(matchingEventTypes);
}
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setMatchingEventTypes(java.util.Collection)} or {@link #withMatchingEventTypes(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param matchingEventTypes
* The types of events that Amazon SES sends to the specified event destinations.
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as
* a send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt
* to deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email.
* (Soft bounces are only included when SES fails to deliver the email after retrying for a period of
* time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the
* recipient marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event
* type can occur when template data is missing, or when there is a mismatch between template parameters and
* data. (This event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a
* temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or
* when the receiving email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their
* subscription preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventType
*/
public EventDestination withMatchingEventTypes(String... matchingEventTypes) {
if (this.matchingEventTypes == null) {
setMatchingEventTypes(new java.util.ArrayList(matchingEventTypes.length));
}
for (String ele : matchingEventTypes) {
this.matchingEventTypes.add(ele);
}
return this;
}
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*
* @param matchingEventTypes
* The types of events that Amazon SES sends to the specified event destinations.
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as
* a send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt
* to deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email.
* (Soft bounces are only included when SES fails to deliver the email after retrying for a period of
* time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the
* recipient marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event
* type can occur when template data is missing, or when there is a mismatch between template parameters and
* data. (This event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a
* temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or
* when the receiving email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their
* subscription preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventType
*/
public EventDestination withMatchingEventTypes(java.util.Collection matchingEventTypes) {
setMatchingEventTypes(matchingEventTypes);
return this;
}
/**
*
* The types of events that Amazon SES sends to the specified event destinations.
*
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a
* send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to
* deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft
* bounces are only included when SES fails to deliver the email after retrying for a period of time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient
* marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can
* occur when template data is missing, or when there is a mismatch between template parameters and data. (This
* event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary
* issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving
* email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription
* preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
*
*
* @param matchingEventTypes
* The types of events that Amazon SES sends to the specified event destinations.
*
* -
*
* SEND - The send request was successful and SES will attempt to deliver the message to the
* recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as
* a send, but delivery is suppressed.)
*
*
* -
*
* REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt
* to deliver it to the recipient’s mail server.
*
*
* -
*
* BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email.
* (Soft bounces are only included when SES fails to deliver the email after retrying for a period of
* time.)
*
*
* -
*
* COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the
* recipient marked it as spam.
*
*
* -
*
* DELIVERY - SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* OPEN - The recipient received the message and opened it in their email client.
*
*
* -
*
* CLICK - The recipient clicked one or more links in the email.
*
*
* -
*
* RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event
* type can occur when template data is missing, or when there is a mismatch between template parameters and
* data. (This event type only occurs when you send email using the
* SendTemplatedEmail or
* SendBulkTemplatedEmail API operations.)
*
*
* -
*
* DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a
* temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or
* when the receiving email server experiences a transient issue.
*
*
* -
*
* SUBSCRIPTION - The email was successfully delivered, but the recipient updated their
* subscription preferences by clicking on an unsubscribe link as part of your subscription
* management.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EventType
*/
public EventDestination withMatchingEventTypes(EventType... matchingEventTypes) {
java.util.ArrayList matchingEventTypesCopy = new java.util.ArrayList(matchingEventTypes.length);
for (EventType value : matchingEventTypes) {
matchingEventTypesCopy.add(value.toString());
}
if (getMatchingEventTypes() == null) {
setMatchingEventTypes(matchingEventTypesCopy);
} else {
getMatchingEventTypes().addAll(matchingEventTypesCopy);
}
return this;
}
/**
*
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis
* Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*
*
* @param kinesisFirehoseDestination
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon
* Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*/
public void setKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination) {
this.kinesisFirehoseDestination = kinesisFirehoseDestination;
}
/**
*
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis
* Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*
*
* @return An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon
* Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*/
public KinesisFirehoseDestination getKinesisFirehoseDestination() {
return this.kinesisFirehoseDestination;
}
/**
*
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis
* Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
*
*
* @param kinesisFirehoseDestination
* An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon
* Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination) {
setKinesisFirehoseDestination(kinesisFirehoseDestination);
return this;
}
/**
*
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
*
*
* @param cloudWatchDestination
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
*/
public void setCloudWatchDestination(CloudWatchDestination cloudWatchDestination) {
this.cloudWatchDestination = cloudWatchDestination;
}
/**
*
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
*
*
* @return An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch
* to monitor and gain insights on your email sending metrics.
*/
public CloudWatchDestination getCloudWatchDestination() {
return this.cloudWatchDestination;
}
/**
*
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
*
*
* @param cloudWatchDestination
* An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to
* monitor and gain insights on your email sending metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withCloudWatchDestination(CloudWatchDestination cloudWatchDestination) {
setCloudWatchDestination(cloudWatchDestination);
return this;
}
/**
*
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification
* when certain email events occur.
*
*
* @param snsDestination
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send
* notification when certain email events occur.
*/
public void setSnsDestination(SnsDestination snsDestination) {
this.snsDestination = snsDestination;
}
/**
*
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification
* when certain email events occur.
*
*
* @return An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send
* notification when certain email events occur.
*/
public SnsDestination getSnsDestination() {
return this.snsDestination;
}
/**
*
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification
* when certain email events occur.
*
*
* @param snsDestination
* An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send
* notification when certain email events occur.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withSnsDestination(SnsDestination snsDestination) {
setSnsDestination(snsDestination);
return this;
}
/**
*
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to
* a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to
* Amazon Pinpoint. For more information, see Transactional
* Messaging Charts in the Amazon Pinpoint User Guide.
*
*
* @param pinpointDestination
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event
* data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are
* built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
*/
public void setPinpointDestination(PinpointDestination pinpointDestination) {
this.pinpointDestination = pinpointDestination;
}
/**
*
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to
* a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to
* Amazon Pinpoint. For more information, see Transactional
* Messaging Charts in the Amazon Pinpoint User Guide.
*
*
* @return An object that defines an Amazon Pinpoint project destination for email events. You can send email event
* data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are
* built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
*/
public PinpointDestination getPinpointDestination() {
return this.pinpointDestination;
}
/**
*
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to
* a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to
* Amazon Pinpoint. For more information, see Transactional
* Messaging Charts in the Amazon Pinpoint User Guide.
*
*
* @param pinpointDestination
* An object that defines an Amazon Pinpoint project destination for email events. You can send email event
* data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are
* built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EventDestination withPinpointDestination(PinpointDestination pinpointDestination) {
setPinpointDestination(pinpointDestination);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getEnabled() != null)
sb.append("Enabled: ").append(getEnabled()).append(",");
if (getMatchingEventTypes() != null)
sb.append("MatchingEventTypes: ").append(getMatchingEventTypes()).append(",");
if (getKinesisFirehoseDestination() != null)
sb.append("KinesisFirehoseDestination: ").append(getKinesisFirehoseDestination()).append(",");
if (getCloudWatchDestination() != null)
sb.append("CloudWatchDestination: ").append(getCloudWatchDestination()).append(",");
if (getSnsDestination() != null)
sb.append("SnsDestination: ").append(getSnsDestination()).append(",");
if (getPinpointDestination() != null)
sb.append("PinpointDestination: ").append(getPinpointDestination());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EventDestination == false)
return false;
EventDestination other = (EventDestination) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getEnabled() == null ^ this.getEnabled() == null)
return false;
if (other.getEnabled() != null && other.getEnabled().equals(this.getEnabled()) == false)
return false;
if (other.getMatchingEventTypes() == null ^ this.getMatchingEventTypes() == null)
return false;
if (other.getMatchingEventTypes() != null && other.getMatchingEventTypes().equals(this.getMatchingEventTypes()) == false)
return false;
if (other.getKinesisFirehoseDestination() == null ^ this.getKinesisFirehoseDestination() == null)
return false;
if (other.getKinesisFirehoseDestination() != null && other.getKinesisFirehoseDestination().equals(this.getKinesisFirehoseDestination()) == false)
return false;
if (other.getCloudWatchDestination() == null ^ this.getCloudWatchDestination() == null)
return false;
if (other.getCloudWatchDestination() != null && other.getCloudWatchDestination().equals(this.getCloudWatchDestination()) == false)
return false;
if (other.getSnsDestination() == null ^ this.getSnsDestination() == null)
return false;
if (other.getSnsDestination() != null && other.getSnsDestination().equals(this.getSnsDestination()) == false)
return false;
if (other.getPinpointDestination() == null ^ this.getPinpointDestination() == null)
return false;
if (other.getPinpointDestination() != null && other.getPinpointDestination().equals(this.getPinpointDestination()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getEnabled() == null) ? 0 : getEnabled().hashCode());
hashCode = prime * hashCode + ((getMatchingEventTypes() == null) ? 0 : getMatchingEventTypes().hashCode());
hashCode = prime * hashCode + ((getKinesisFirehoseDestination() == null) ? 0 : getKinesisFirehoseDestination().hashCode());
hashCode = prime * hashCode + ((getCloudWatchDestination() == null) ? 0 : getCloudWatchDestination().hashCode());
hashCode = prime * hashCode + ((getSnsDestination() == null) ? 0 : getSnsDestination().hashCode());
hashCode = prime * hashCode + ((getPinpointDestination() == null) ? 0 : getPinpointDestination().hashCode());
return hashCode;
}
@Override
public EventDestination clone() {
try {
return (EventDestination) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simpleemailv2.model.transform.EventDestinationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}