Class GetDeliverabilityDashboardOptionsResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.sesv2.model.SesV2Response
-
- software.amazon.awssdk.services.sesv2.model.GetDeliverabilityDashboardOptionsResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDeliverabilityDashboardOptionsResponse extends SesV2Response implements ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>
An object that shows the status of the Deliverability dashboard.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetDeliverabilityDashboardOptionsResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DeliverabilityDashboardAccountStatusaccountStatus()The current status of your Deliverability dashboard subscription.StringaccountStatusAsString()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.Builderbuilder()BooleandashboardEnabled()Specifies whether the Deliverability dashboard is enabled.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActiveSubscribedDomains()For responses, this returns true if the service returned a value for the ActiveSubscribedDomains property.inthashCode()booleanhasPendingExpirationSubscribedDomains()For responses, this returns true if the service returned a value for the PendingExpirationSubscribedDomains property.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()InstantsubscriptionExpiryDate()The date 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.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.sesv2.model.SesV2Response
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. If this value is
true, the dashboard is enabled.- Returns:
- Specifies whether the Deliverability dashboard is enabled. If this value is
true, the dashboard is enabled.
-
subscriptionExpiryDate
public final Instant subscriptionExpiryDate()
The date 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 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,
accountStatuswill returnDeliverabilityDashboardAccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaccountStatusAsString().- 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,
accountStatuswill returnDeliverabilityDashboardAccountStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromaccountStatusAsString().- 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()
For responses, this returns true if the service returned a value for the ActiveSubscribedDomains 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.
-
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.
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
hasActiveSubscribedDomains()method.- 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()
For responses, this returns true if the service returned a value for the PendingExpirationSubscribedDomains 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.
-
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.
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
hasPendingExpirationSubscribedDomains()method.- 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:
toBuilderin interfaceToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetDeliverabilityDashboardOptionsResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetDeliverabilityDashboardOptionsResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-