EventDestination (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpointemail.model.EventDestination

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EventDestination
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EventDestination()

Constructors
Constructor and Description
`EventDestination()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EventDestination`	`clone()`
`boolean`	`equals(Object obj)`
`CloudWatchDestination`	`getCloudWatchDestination()` An object that defines an Amazon CloudWatch destination for email events.
`Boolean`	`getEnabled()` If `true`, the event destination is enabled.
`KinesisFirehoseDestination`	`getKinesisFirehoseDestination()` An object that defines an Amazon Kinesis Data Firehose destination for email events.
`List<String>`	`getMatchingEventTypes()` The types of events that Amazon Pinpoint sends to the specified event destinations.
`String`	`getName()` A name that identifies the event destination.
`PinpointDestination`	`getPinpointDestination()` An object that defines a Amazon Pinpoint destination for email events.
`SnsDestination`	`getSnsDestination()` An object that defines an Amazon SNS destination for email events.
`int`	`hashCode()`
`Boolean`	`isEnabled()` If `true`, the event destination is enabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCloudWatchDestination(CloudWatchDestination cloudWatchDestination)` An object that defines an Amazon CloudWatch destination for email events.
`void`	`setEnabled(Boolean enabled)` If `true`, the event destination is enabled.
`void`	`setKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination)` An object that defines an Amazon Kinesis Data Firehose destination for email events.
`void`	`setMatchingEventTypes(Collection<String> matchingEventTypes)` The types of events that Amazon Pinpoint sends to the specified event destinations.
`void`	`setName(String name)` A name that identifies the event destination.
`void`	`setPinpointDestination(PinpointDestination pinpointDestination)` An object that defines a Amazon Pinpoint destination for email events.
`void`	`setSnsDestination(SnsDestination snsDestination)` An object that defines an Amazon SNS destination for email events.
`String`	`toString()` Returns a string representation of this object.
`EventDestination`	`withCloudWatchDestination(CloudWatchDestination cloudWatchDestination)` An object that defines an Amazon CloudWatch destination for email events.
`EventDestination`	`withEnabled(Boolean enabled)` If `true`, the event destination is enabled.
`EventDestination`	`withKinesisFirehoseDestination(KinesisFirehoseDestination kinesisFirehoseDestination)` An object that defines an Amazon Kinesis Data Firehose destination for email events.
`EventDestination`	`withMatchingEventTypes(Collection<String> matchingEventTypes)` The types of events that Amazon Pinpoint sends to the specified event destinations.
`EventDestination`	`withMatchingEventTypes(EventType... matchingEventTypes)` The types of events that Amazon Pinpoint sends to the specified event destinations.
`EventDestination`	`withMatchingEventTypes(String... matchingEventTypes)` The types of events that Amazon Pinpoint sends to the specified event destinations.
`EventDestination`	`withName(String name)` A name that identifies the event destination.
`EventDestination`	`withPinpointDestination(PinpointDestination pinpointDestination)` An object that defines a Amazon Pinpoint destination for email events.
`EventDestination`	`withSnsDestination(SnsDestination snsDestination)` An object that defines an Amazon SNS destination for email events.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EventDestination
```
public EventDestination()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    A name that identifies the event destination.
    
    Parameters:
    
    name - A name that identifies the event destination.
  - getName
```
public String getName()
```
    A name that identifies the event destination.
    
    Returns:
    
    A name that identifies the event destination.
  - withName
```
public EventDestination withName(String name)
```
    A name that identifies the event destination.
    
    Parameters:
    
    name - A name that identifies the event destination.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnabled
```
public void setEnabled(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.
    
    Parameters:
    
    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.
  - getEnabled
```
public Boolean getEnabled()
```
    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.
  - withEnabled
```
public EventDestination withEnabled(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    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.
  - getMatchingEventTypes
```
public List<String> getMatchingEventTypes()
```
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Returns:
    
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    See Also:
    
    EventType
  - setMatchingEventTypes
```
public void setMatchingEventTypes(Collection<String> matchingEventTypes)
```
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Parameters:
    
    matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    See Also:
    
    EventType
  - withMatchingEventTypes
```
public EventDestination withMatchingEventTypes(String... matchingEventTypes)
```
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    NOTE: This method appends the values to the existing list (if any). Use setMatchingEventTypes(java.util.Collection) or withMatchingEventTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - withMatchingEventTypes
```
public EventDestination withMatchingEventTypes(Collection<String> matchingEventTypes)
```
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Parameters:
    
    matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - withMatchingEventTypes
```
public EventDestination withMatchingEventTypes(EventType... matchingEventTypes)
```
    The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Parameters:
    
    matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - setKinesisFirehoseDestination
```
public void setKinesisFirehoseDestination(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.
    
    Parameters:
    
    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.
  - getKinesisFirehoseDestination
```
public KinesisFirehoseDestination getKinesisFirehoseDestination()
```
    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.
  - withKinesisFirehoseDestination
```
public EventDestination withKinesisFirehoseDestination(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchDestination
```
public void setCloudWatchDestination(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.
    
    Parameters:
    
    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.
  - getCloudWatchDestination
```
public CloudWatchDestination getCloudWatchDestination()
```
    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.
  - withCloudWatchDestination
```
public EventDestination withCloudWatchDestination(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnsDestination
```
public void setSnsDestination(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.
    
    Parameters:
    
    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.
  - getSnsDestination
```
public SnsDestination getSnsDestination()
```
    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.
  - withSnsDestination
```
public EventDestination withSnsDestination(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPinpointDestination
```
public void setPinpointDestination(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.
    
    Parameters:
    
    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.
  - getPinpointDestination
```
public PinpointDestination getPinpointDestination()
```
    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.
  - withPinpointDestination
```
public EventDestination withPinpointDestination(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EventDestination clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EventDestination

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventDestination

Method Detail

setName

getName

withName

setEnabled

getEnabled

withEnabled

isEnabled

getMatchingEventTypes

setMatchingEventTypes

withMatchingEventTypes

withMatchingEventTypes

withMatchingEventTypes

setKinesisFirehoseDestination

getKinesisFirehoseDestination

withKinesisFirehoseDestination

setCloudWatchDestination

getCloudWatchDestination

withCloudWatchDestination

setSnsDestination

getSnsDestination

withSnsDestination

setPinpointDestination

getPinpointDestination

withPinpointDestination

toString

equals

hashCode

clone

marshall