Package software.amazon.awssdk.services.pinpointemail.model

Class OverallVolume

java.lang.Object

software.amazon.awssdk.services.pinpointemail.model.OverallVolume

All Implemented Interfaces:

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

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

An object that contains information about email that was sent from the selected domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OverallVolume.Builder

Method Summary

Modifier and Type	Method	Description
static OverallVolume.Builder	builder()
List<DomainIspPlacement>	domainIspPlacements()	An object that contains inbox and junk mail placement metrics for individual email providers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDomainIspPlacements()	For responses, this returns true if the service returned a value for the DomainIspPlacements property.
int	hashCode()
Double	readRatePercent()	The percentage of emails that were sent from the domain that were read by their recipients.
List<SdkField<?>>	sdkFields()
static Class<? extends OverallVolume.Builder>	serializableBuilderClass()
OverallVolume.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VolumeStatistics	volumeStatistics()	An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

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

volumeStatistics

public final VolumeStatistics volumeStatistics()

An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

Returns:

An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

readRatePercent

public final Double readRatePercent()

The percentage of emails that were sent from the domain that were read by their recipients.

Returns:

The percentage of emails that were sent from the domain that were read by their recipients.

hasDomainIspPlacements

public final boolean hasDomainIspPlacements()

For responses, this returns true if the service returned a value for the DomainIspPlacements 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.

domainIspPlacements

public final List<DomainIspPlacement> domainIspPlacements()

An object that contains inbox and junk mail placement metrics for individual email providers.

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 hasDomainIspPlacements() method.

Returns:

An object that contains inbox and junk mail placement metrics for individual email providers.

toBuilder

public OverallVolume.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OverallVolume.Builder,OverallVolume>

builder

public static OverallVolume.Builder builder()

serializableBuilderClass

public static Class<? extends OverallVolume.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