Package software.amazon.awssdk.services.snowball.model

Class Notification

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<Notification.Builder,​Notification>
    @Generated("software.amazon.awssdk:codegen")
public final class Notification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Notification.Builder,​Notification>

    The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

    When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

    See Also:
    Serialized Form

    • Method Detail

      • snsTopicARN

        public final String snsTopicARN()

        The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

        You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

        Returns:
        The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

        You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

      • jobStatesToNotify

        public final List<JobState> jobStatesToNotify()

        The list of job states that will trigger a notification for this job.

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

        Returns:
        The list of job states that will trigger a notification for this job.

      • hasJobStatesToNotify

        public final boolean hasJobStatesToNotify()
        For responses, this returns true if the service returned a value for the JobStatesToNotify 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.

      • jobStatesToNotifyAsStrings

        public final List<String> jobStatesToNotifyAsStrings()

        The list of job states that will trigger a notification for this job.

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

        Returns:
        The list of job states that will trigger a notification for this job.

      • devicePickupSnsTopicARN

        public final String devicePickupSnsTopicARN()

        Used to send SNS notifications for the person picking up the device (identified during job creation).

        Returns:
        Used to send SNS notifications for the person picking up the device (identified during job creation).

      • notifyAllJobStates

        public final Boolean notifyAllJobStates()

        Any change in job state will trigger a notification for this job.

        Returns:
        Any change in job state will trigger a notification for this job.

      • hashCode

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

      • equals

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

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