Class NotificationSpecification

java.lang.Object
software.amazon.awssdk.services.mturk.model.NotificationSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>
@Generated("software.amazon.awssdk:codegen") public final class NotificationSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>

The NotificationSpecification data structure describes a HIT event notification for a HIT type.

See Also:

  • Method Details

    • destination

      public final String destination()

      The target for notification messages. The Destination’s format is determined by the specified Transport:

      • When Transport is Email, the Destination is your email address.

      • When Transport is SQS, the Destination is your queue URL.

      • When Transport is SNS, the Destination is the ARN of your topic.

      Returns:
      The target for notification messages. The Destination’s format is determined by the specified Transport:

      • When Transport is Email, the Destination is your email address.

      • When Transport is SQS, the Destination is your queue URL.

      • When Transport is SNS, the Destination is the ARN of your topic.

    • transport

      public final NotificationTransport transport()

      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

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

      Returns:
      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
      See Also:

    • transportAsString

      public final String transportAsString()

      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

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

      Returns:
      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
      See Also:

    • version

      public final String version()

      The version of the Notification API to use. Valid value is 2006-05-05.

      Returns:
      The version of the Notification API to use. Valid value is 2006-05-05.

    • eventTypes

      public final List<EventType> eventTypes()

      The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

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

      Returns:
      The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

    • hasEventTypes

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

    • eventTypesAsStrings

      public final List<String> eventTypesAsStrings()

      The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

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

      Returns:
      The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

    • toBuilder

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

    • builder

      public static NotificationSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NotificationSpecification.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.