software.amazon.awssdk.services.pinpointemail.model

Class GetDeliverabilityDashboardOptionsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pinpointemail.model.PinpointEmailResponse

software.amazon.awssdk.services.pinpointemail.model.GetDeliverabilityDashboardOptionsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDeliverabilityDashboardOptionsResponse
extends PinpointEmailResponse
implements ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>

An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDeliverabilityDashboardOptionsResponse.Builder

Method Summary

Modifier and Type	Method and Description
DeliverabilityDashboardAccountStatus	accountStatus() The current status of your Deliverability dashboard subscription.
String	accountStatusAsString() The current status of your Deliverability dashboard subscription.
List<DomainDeliverabilityTrackingOption>	activeSubscribedDomains() An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.
static GetDeliverabilityDashboardOptionsResponse.Builder	builder()
Boolean	dashboardEnabled() Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActiveSubscribedDomains() Returns true if the ActiveSubscribedDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPendingExpirationSubscribedDomains() Returns true if the PendingExpirationSubscribedDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<DomainDeliverabilityTrackingOption>	pendingExpirationSubscribedDomains() An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDeliverabilityDashboardOptionsResponse.Builder>	serializableBuilderClass()
Instant	subscriptionExpiryDate() The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month.
GetDeliverabilityDashboardOptionsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.pinpointemail.model.PinpointEmailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

dashboardEnabled

public final Boolean dashboardEnabled()

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

Returns:

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

subscriptionExpiryDate

public final Instant subscriptionExpiryDate()

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

Returns:

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

accountStatus

public final DeliverabilityDashboardAccountStatus accountStatus()

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

If the service returns an enum value that is not available in the current SDK version, accountStatus will return DeliverabilityDashboardAccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountStatusAsString().

Returns:

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

See Also:

DeliverabilityDashboardAccountStatus

accountStatusAsString

public final String accountStatusAsString()

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

If the service returns an enum value that is not available in the current SDK version, accountStatus will return DeliverabilityDashboardAccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accountStatusAsString().

Returns:

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

See Also:

DeliverabilityDashboardAccountStatus

hasActiveSubscribedDomains

public final boolean hasActiveSubscribedDomains()

Returns true if the ActiveSubscribedDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

activeSubscribedDomains

public final List<DomainDeliverabilityTrackingOption> activeSubscribedDomains()

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

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

You can use hasActiveSubscribedDomains() to see if a value was sent in this field.

Returns:

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

hasPendingExpirationSubscribedDomains

public final boolean hasPendingExpirationSubscribedDomains()

Returns true if the PendingExpirationSubscribedDomains property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

pendingExpirationSubscribedDomains

public final List<DomainDeliverabilityTrackingOption> pendingExpirationSubscribedDomains()

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

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

You can use hasPendingExpirationSubscribedDomains() to see if a value was sent in this field.

Returns:

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

toBuilder

public GetDeliverabilityDashboardOptionsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetDeliverabilityDashboardOptionsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo