Package software.amazon.awssdk.services.sesv2.model

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.

  • Method Details

    • 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, 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:

    • 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:

    • 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 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.

    • 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 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.

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetDeliverabilityDashboardOptionsResponse.Builder,GetDeliverabilityDashboardOptionsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.