software.amazon.awssdk.services.ses.model.EventDestination Maven / Gradle / Ivy
Show all versions of ses Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.ses.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an event destination.
*
*
*
* When you create or update an event destination, you must provide one, and only one, destination. The destination can
* be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).
*
*
*
* Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon
* CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using
* configuration sets, see the Amazon
* SES Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class EventDestination implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(EventDestination::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Enabled").getter(getter(EventDestination::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Enabled").build()).build();
private static final SdkField> MATCHING_EVENT_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MatchingEventTypes")
.getter(getter(EventDestination::matchingEventTypesAsStrings))
.setter(setter(Builder::matchingEventTypesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MatchingEventTypes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField KINESIS_FIREHOSE_DESTINATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("KinesisFirehoseDestination")
.getter(getter(EventDestination::kinesisFirehoseDestination))
.setter(setter(Builder::kinesisFirehoseDestination))
.constructor(KinesisFirehoseDestination::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KinesisFirehoseDestination").build())
.build();
private static final SdkField CLOUD_WATCH_DESTINATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CloudWatchDestination")
.getter(getter(EventDestination::cloudWatchDestination)).setter(setter(Builder::cloudWatchDestination))
.constructor(CloudWatchDestination::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CloudWatchDestination").build())
.build();
private static final SdkField SNS_DESTINATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SNSDestination")
.getter(getter(EventDestination::snsDestination)).setter(setter(Builder::snsDestination))
.constructor(SNSDestination::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SNSDestination").build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(NAME_FIELD, ENABLED_FIELD, MATCHING_EVENT_TYPES_FIELD,
KINESIS_FIREHOSE_DESTINATION_FIELD, CLOUD_WATCH_DESTINATION_FIELD, SNS_DESTINATION_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Name", NAME_FIELD);
put("Enabled", ENABLED_FIELD);
put("MatchingEventTypes", MATCHING_EVENT_TYPES_FIELD);
put("KinesisFirehoseDestination", KINESIS_FIREHOSE_DESTINATION_FIELD);
put("CloudWatchDestination", CLOUD_WATCH_DESTINATION_FIELD);
put("SNSDestination", SNS_DESTINATION_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String name;
private final Boolean enabled;
private final List matchingEventTypes;
private final KinesisFirehoseDestination kinesisFirehoseDestination;
private final CloudWatchDestination cloudWatchDestination;
private final SNSDestination snsDestination;
private EventDestination(BuilderImpl builder) {
this.name = builder.name;
this.enabled = builder.enabled;
this.matchingEventTypes = builder.matchingEventTypes;
this.kinesisFirehoseDestination = builder.kinesisFirehoseDestination;
this.cloudWatchDestination = builder.cloudWatchDestination;
this.snsDestination = builder.snsDestination;
}
/**
*
* The name of the event destination. The name must meet the following requirements:
*
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
*
*
* -
*
* Contain 64 characters or fewer.
*
*
*
*
* @return The name of the event destination. The name must meet the following requirements:
*
* -
*
* Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
*
*
* -
*
* Contain 64 characters or fewer.
*
*
*/
public final String name() {
return name;
}
/**
*
* Sets whether Amazon SES publishes events to this destination when you send an email with the associated
* configuration set. Set to true
to enable publishing to this destination; set to false
* to prevent publishing to this destination. The default value is false
.
*
*
* @return Sets whether Amazon SES publishes events to this destination when you send an email with the associated
* configuration set. Set to true
to enable publishing to this destination; set to
* false
to prevent publishing to this destination. The default value is false
.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* The type of email sending events to publish to the event destination.
*
*
* -
*
* send
- The call was successful and Amazon SES is attempting to deliver the email.
*
*
* -
*
* reject
- Amazon SES determined that the email contained a virus and rejected it.
*
*
* -
*
* bounce
- The recipient's mail server permanently rejected the email. This corresponds to a hard
* bounce.
*
*
* -
*
* complaint
- The recipient marked the email as spam.
*
*
* -
*
* delivery
- Amazon SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* open
- The recipient received the email and opened it in their email client.
*
*
* -
*
* click
- The recipient clicked one or more links in the email.
*
*
* -
*
* renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasMatchingEventTypes} method.
*
*
* @return The type of email sending events to publish to the event destination.
*
* -
*
* send
- The call was successful and Amazon SES is attempting to deliver the email.
*
*
* -
*
* reject
- Amazon SES determined that the email contained a virus and rejected it.
*
*
* -
*
* bounce
- The recipient's mail server permanently rejected the email. This corresponds to a
* hard bounce.
*
*
* -
*
* complaint
- The recipient marked the email as spam.
*
*
* -
*
* delivery
- Amazon SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* open
- The recipient received the email and opened it in their email client.
*
*
* -
*
* click
- The recipient clicked one or more links in the email.
*
*
* -
*
* renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
*
*
*/
public final List matchingEventTypes() {
return EventTypesCopier.copyStringToEnum(matchingEventTypes);
}
/**
* For responses, this returns true if the service returned a value for the MatchingEventTypes property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasMatchingEventTypes() {
return matchingEventTypes != null && !(matchingEventTypes instanceof SdkAutoConstructList);
}
/**
*
* The type of email sending events to publish to the event destination.
*
*
* -
*
* send
- The call was successful and Amazon SES is attempting to deliver the email.
*
*
* -
*
* reject
- Amazon SES determined that the email contained a virus and rejected it.
*
*
* -
*
* bounce
- The recipient's mail server permanently rejected the email. This corresponds to a hard
* bounce.
*
*
* -
*
* complaint
- The recipient marked the email as spam.
*
*
* -
*
* delivery
- Amazon SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* open
- The recipient received the email and opened it in their email client.
*
*
* -
*
* click
- The recipient clicked one or more links in the email.
*
*
* -
*
* renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasMatchingEventTypes} method.
*
*
* @return The type of email sending events to publish to the event destination.
*
* -
*
* send
- The call was successful and Amazon SES is attempting to deliver the email.
*
*
* -
*
* reject
- Amazon SES determined that the email contained a virus and rejected it.
*
*
* -
*
* bounce
- The recipient's mail server permanently rejected the email. This corresponds to a
* hard bounce.
*
*
* -
*
* complaint
- The recipient marked the email as spam.
*
*
* -
*
* delivery
- Amazon SES successfully delivered the email to the recipient's mail server.
*
*
* -
*
* open
- The recipient received the email and opened it in their email client.
*
*
* -
*
* click
- The recipient clicked one or more links in the email.
*
*
* -
*
* renderingFailure
- Amazon SES did not send the email because of a template rendering issue.
*
*
*/
public final List matchingEventTypesAsStrings() {
return matchingEventTypes;
}
/**
*
* An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose
* event destination.
*
*
* @return An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis
* Firehose event destination.
*/
public final KinesisFirehoseDestination kinesisFirehoseDestination() {
return kinesisFirehoseDestination;
}
/**
*
* An object that contains the names, default values, and sources of the dimensions associated with an Amazon
* CloudWatch event destination.
*
*
* @return An object that contains the names, default values, and sources of the dimensions associated with an
* Amazon CloudWatch event destination.
*/
public final CloudWatchDestination cloudWatchDestination() {
return cloudWatchDestination;
}
/**
*
* An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event
* destination.
*
*
* @return An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS)
* event destination.
*/
public final SNSDestination snsDestination() {
return snsDestination;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(hasMatchingEventTypes() ? matchingEventTypesAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(kinesisFirehoseDestination());
hashCode = 31 * hashCode + Objects.hashCode(cloudWatchDestination());
hashCode = 31 * hashCode + Objects.hashCode(snsDestination());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof EventDestination)) {
return false;
}
EventDestination other = (EventDestination) obj;
return Objects.equals(name(), other.name()) && Objects.equals(enabled(), other.enabled())
&& hasMatchingEventTypes() == other.hasMatchingEventTypes()
&& Objects.equals(matchingEventTypesAsStrings(), other.matchingEventTypesAsStrings())
&& Objects.equals(kinesisFirehoseDestination(), other.kinesisFirehoseDestination())
&& Objects.equals(cloudWatchDestination(), other.cloudWatchDestination())
&& Objects.equals(snsDestination(), other.snsDestination());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("EventDestination").add("Name", name()).add("Enabled", enabled())
.add("MatchingEventTypes", hasMatchingEventTypes() ? matchingEventTypesAsStrings() : null)
.add("KinesisFirehoseDestination", kinesisFirehoseDestination())
.add("CloudWatchDestination", cloudWatchDestination()).add("SNSDestination", snsDestination()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "MatchingEventTypes":
return Optional.ofNullable(clazz.cast(matchingEventTypesAsStrings()));
case "KinesisFirehoseDestination":
return Optional.ofNullable(clazz.cast(kinesisFirehoseDestination()));
case "CloudWatchDestination":
return Optional.ofNullable(clazz.cast(cloudWatchDestination()));
case "SNSDestination":
return Optional.ofNullable(clazz.cast(snsDestination()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function