MessageInsightsFilters (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.sesv2.model.MessageInsightsFilters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MessageInsightsFilters.Builder,MessageInsightsFilters>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class MessageInsightsFilters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MessageInsightsFilters.Builder,MessageInsightsFilters>
```
An object containing Message Insights filters.

If you specify multiple filters, the filters are joined by AND.

If you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.

FromEmailAddress, Destination, and Subject filters support partial match. A partial match is performed by using the * wildcard character placed at the beginning (suffix match), the end (prefix match) or both ends of the string (contains match). In order to match the literal characters * or \, they must be escaped using the \ character. If no wildcard character is present, an exact match is performed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MessageInsightsFilters.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MessageInsightsFilters.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MessageInsightsFilters.Builder`	`builder()`
`List<String>`	`destination()` The recipient's email address.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`fromEmailAddress()` The from address used to send the message.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestination()` For responses, this returns true if the service returned a value for the Destination property.
`boolean`	`hasFromEmailAddress()` For responses, this returns true if the service returned a value for the FromEmailAddress property.
`int`	`hashCode()`
`boolean`	`hasIsp()` For responses, this returns true if the service returned a value for the Isp property.
`boolean`	`hasLastDeliveryEvent()` For responses, this returns true if the service returned a value for the LastDeliveryEvent property.
`boolean`	`hasLastEngagementEvent()` For responses, this returns true if the service returned a value for the LastEngagementEvent property.
`boolean`	`hasSubject()` For responses, this returns true if the service returned a value for the Subject property.
`List<String>`	`isp()` The recipient's ISP (e.g., `Gmail`, `Yahoo`, etc.).
`List<DeliveryEventType>`	`lastDeliveryEvent()` The last delivery-related event for the email, where the ordering is as follows: `SEND` < `BOUNCE` < `DELIVERY` < `COMPLAINT`.
`List<String>`	`lastDeliveryEventAsStrings()` The last delivery-related event for the email, where the ordering is as follows: `SEND` < `BOUNCE` < `DELIVERY` < `COMPLAINT`.
`List<EngagementEventType>`	`lastEngagementEvent()` The last engagement-related event for the email, where the ordering is as follows: `OPEN` < `CLICK`.
`List<String>`	`lastEngagementEventAsStrings()` The last engagement-related event for the email, where the ordering is as follows: `OPEN` < `CLICK`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MessageInsightsFilters.Builder>`	`serializableBuilderClass()`
`List<String>`	`subject()` The subject line of the message.
`MessageInsightsFilters.Builder`	`toBuilder()`
`String`	`toString()` 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
  - hasFromEmailAddress
```
public final boolean hasFromEmailAddress()
```
    For responses, this returns true if the service returned a value for the FromEmailAddress property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - fromEmailAddress
```
public final List<String> fromEmailAddress()
```
    The from address used to send the message.
    
    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 hasFromEmailAddress() method.
    
    Returns:
    
    The from address used to send the message.
  - hasDestination
```
public final boolean hasDestination()
```
    For responses, this returns true if the service returned a value for the Destination property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - destination
```
public final List<String> destination()
```
    The recipient's email address.
    
    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 hasDestination() method.
    
    Returns:
    
    The recipient's email address.
  - hasSubject
```
public final boolean hasSubject()
```
    For responses, this returns true if the service returned a value for the Subject property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - subject
```
public final List<String> subject()
```
    The subject line of the message.
    
    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 hasSubject() method.
    
    Returns:
    
    The subject line of the message.
  - hasIsp
```
public final boolean hasIsp()
```
    For responses, this returns true if the service returned a value for the Isp property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - isp
```
public final List<String> isp()
```
    The recipient's ISP (e.g., Gmail, Yahoo, etc.).
    
    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 hasIsp() method.
    
    Returns:
    
    The recipient's ISP (e.g., Gmail, Yahoo, etc.).
  - lastDeliveryEvent
```
public final List<DeliveryEventType> lastDeliveryEvent()
```
    The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT.
    
    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 hasLastDeliveryEvent() method.
    
    Returns:
    
    The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT.
  - hasLastDeliveryEvent
```
public final boolean hasLastDeliveryEvent()
```
    For responses, this returns true if the service returned a value for the LastDeliveryEvent property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - lastDeliveryEventAsStrings
```
public final List<String> lastDeliveryEventAsStrings()
```
    The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT.
    
    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 hasLastDeliveryEvent() method.
    
    Returns:
    
    The last delivery-related event for the email, where the ordering is as follows: SEND < BOUNCE < DELIVERY < COMPLAINT.
  - lastEngagementEvent
```
public final List<EngagementEventType> lastEngagementEvent()
```
    The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK.
    
    Engagement events are only available if Engagement tracking is enabled.
    
    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 hasLastEngagementEvent() method.
    
    Returns:
    
    The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK.
    
    Engagement events are only available if Engagement tracking is enabled.
  - hasLastEngagementEvent
```
public final boolean hasLastEngagementEvent()
```
    For responses, this returns true if the service returned a value for the LastEngagementEvent property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - lastEngagementEventAsStrings
```
public final List<String> lastEngagementEventAsStrings()
```
    The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK.
    
    Engagement events are only available if Engagement tracking is enabled.
    
    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 hasLastEngagementEvent() method.
    
    Returns:
    
    The last engagement-related event for the email, where the ordering is as follows: OPEN < CLICK.
    
    Engagement events are only available if Engagement tracking is enabled.
  - toBuilder
```
public MessageInsightsFilters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MessageInsightsFilters.Builder,MessageInsightsFilters>
  - builder
```
public static MessageInsightsFilters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MessageInsightsFilters.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MessageInsightsFilters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasFromEmailAddress

fromEmailAddress

hasDestination

destination

hasSubject

subject

hasIsp

isp

lastDeliveryEvent

hasLastDeliveryEvent

lastDeliveryEventAsStrings

lastEngagementEvent

hasLastEngagementEvent

lastEngagementEventAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields