software.amazon.awssdk.services.mturk.model

Class NotificationSpecification

java.lang.Object

software.amazon.awssdk.services.mturk.model.NotificationSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NotificationSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static NotificationSpecification.Builder	builder()
String	destination() The target for notification messages.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<EventType>	eventTypes() The list of events that should cause notifications to be sent.
List<String>	eventTypesAsStrings() The list of events that should cause notifications to be sent.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventTypes() For responses, this returns true if the service returned a value for the EventTypes property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends NotificationSpecification.Builder>	serializableBuilderClass()
NotificationSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.
NotificationTransport	transport() The method Amazon Mechanical Turk uses to send the notification.
String	transportAsString() The method Amazon Mechanical Turk uses to send the notification.
String	version() The version of the Notification API to use.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

NotificationTransport

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:

NotificationTransport

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

Specified by:

toBuilder in interface ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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