Class EventDestination
- java.lang.Object
-
- software.amazon.awssdk.services.pinpointemail.model.EventDestination
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EventDestination.Builder,EventDestination>
@Generated("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 Description static interfaceEventDestination.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EventDestination.Builderbuilder()CloudWatchDestinationcloudWatchDestination()An object that defines an Amazon CloudWatch destination for email events.Booleanenabled()Iftrue, the event destination is enabled.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMatchingEventTypes()For responses, this returns true if the service returned a value for the MatchingEventTypes property.KinesisFirehoseDestinationkinesisFirehoseDestination()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.Stringname()A name that identifies the event destination.PinpointDestinationpinpointDestination()An object that defines a Amazon Pinpoint destination for email events.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends EventDestination.Builder>serializableBuilderClass()SnsDestinationsnsDestination()An object that defines an Amazon SNS destination for email events.EventDestination.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
A name that identifies the event destination.
- Returns:
- A name that identifies the event destination.
-
enabled
public final 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 thisEventDestinationDefinition.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 thisEventDestinationDefinition.If
false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
-
matchingEventTypes
public final 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.
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
hasMatchingEventTypes()method.- Returns:
- The types of events that Amazon Pinpoint sends to the specified event destinations.
-
hasMatchingEventTypes
public final boolean hasMatchingEventTypes()
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 theisEmpty()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.
-
matchingEventTypesAsStrings
public final 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.
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
hasMatchingEventTypes()method.- Returns:
- The types of events that Amazon Pinpoint sends to the specified event destinations.
-
kinesisFirehoseDestination
public final 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 final 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 final 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 final 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EventDestination.Builder,EventDestination>
-
builder
public static EventDestination.Builder builder()
-
serializableBuilderClass
public static Class<? extends EventDestination.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-