software.amazon.awssdk.services.pinpointemail.model

Class EventDestination

java.lang.Object

software.amazon.awssdk.services.pinpointemail.model.EventDestination

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EventDestination.Builder,EventDestination>

@Generated(value="software.amazon.awssdk:codegen")
public final class EventDestination
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EventDestination.Builder,EventDestination>

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. 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 Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventDestination.Builder

Method Summary

Modifier and Type	Method and Description
static EventDestination.Builder	builder()
CloudWatchDestination	cloudWatchDestination() An object that defines an Amazon CloudWatch destination for email events.
Boolean	enabled() If true, the event destination is enabled.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KinesisFirehoseDestination	kinesisFirehoseDestination() An object that defines an Amazon Kinesis Data Firehose destination for email events.
List<EventType>	matchingEventTypes() The types of events that Amazon Pinpoint sends to the specified event destinations.
List<String>	matchingEventTypesAsStrings() The types of events that Amazon Pinpoint sends to the specified event destinations.
String	name() A name that identifies the event destination.
PinpointDestination	pinpointDestination() An object that defines a Amazon Pinpoint destination for email events.
List<SdkField<?>>	sdkFields()
static Class<? extends EventDestination.Builder>	serializableBuilderClass()
SnsDestination	snsDestination() An object that defines an Amazon SNS destination for email events.
EventDestination.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public String name()

A name that identifies the event destination.

Returns:

A name that identifies the event destination.

enabled

public Boolean 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.

Returns:

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.

matchingEventTypes

public List<EventType> matchingEventTypes()

The types of events that Amazon Pinpoint sends to the specified event destinations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The types of events that Amazon Pinpoint sends to the specified event destinations.

matchingEventTypesAsStrings

public List<String> matchingEventTypesAsStrings()

The types of events that Amazon Pinpoint sends to the specified event destinations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The types of events that Amazon Pinpoint sends to the specified event destinations.

kinesisFirehoseDestination

public 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.

Returns:

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.

cloudWatchDestination

public 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.

Returns:

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.

snsDestination

public 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.

Returns:

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

pinpointDestination

public PinpointDestination pinpointDestination()

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

Returns:

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

toBuilder

public EventDestination.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<EventDestination.Builder,EventDestination>

Returns:

a builder for type T

builder

public static EventDestination.Builder builder()

serializableBuilderClass

public static Class<? extends EventDestination.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.