Class Notification

java.lang.Object
software.amazon.awssdk.services.snowball.model.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:

  • Method Details

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

    • toBuilder

      public Notification.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<Notification.Builder,Notification>
      Returns:
      a builder for type T

    • builder

      public static Notification.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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