Package software.amazon.awssdk.services.ses.model

Class SetIdentityNotificationTopicRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ses.model.SesRequest
software.amazon.awssdk.services.ses.model.SetIdentityNotificationTopicRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SetIdentityNotificationTopicRequest.Builder,SetIdentityNotificationTopicRequest>
@Generated("software.amazon.awssdk:codegen") public final class SetIdentityNotificationTopicRequest extends SesRequest implements ToCopyableBuilder<SetIdentityNotificationTopicRequest.Builder,SetIdentityNotificationTopicRequest>

Represents a request to specify the Amazon SNS topic to which Amazon SES publishes bounce, complaint, or delivery notifications for emails sent with that identity as the source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

  • Method Details

    • identity

      public final String identity()

      The identity (email address or domain) for the Amazon SNS topic.

      You can only specify a verified identity for this parameter.

      You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

      Returns:
      The identity (email address or domain) for the Amazon SNS topic.

      You can only specify a verified identity for this parameter.

      You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    • notificationType

      public final NotificationType notificationType()

      The type of notifications that are published to the specified Amazon SNS topic.

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

      Returns:
      The type of notifications that are published to the specified Amazon SNS topic.
      See Also:

    • notificationTypeAsString

      public final String notificationTypeAsString()

      The type of notifications that are published to the specified Amazon SNS topic.

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

      Returns:
      The type of notifications that are published to the specified Amazon SNS topic.
      See Also:

    • snsTopic

      public final String snsTopic()

      The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

    • toBuilder

      public SetIdentityNotificationTopicRequest.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<SetIdentityNotificationTopicRequest.Builder,SetIdentityNotificationTopicRequest>
      Specified by:
      toBuilder in class SesRequest
      Returns:
      a builder for type T

    • builder

      public static SetIdentityNotificationTopicRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.