@Generated(value="software.amazon.awssdk:codegen") public final class NotificationSpecification extends Object implements StructuredPojo, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>
The NotificationSpecification data structure describes a HIT event notification for a HIT type.
Modifier and Type | Class and Description |
---|---|
static interface |
NotificationSpecification.Builder |
Modifier and Type | Method and Description |
---|---|
static NotificationSpecification.Builder |
builder() |
String |
destination()
The target for notification messages.
|
boolean |
equals(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) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends NotificationSpecification.Builder> |
serializableBuilderClass() |
NotificationSpecification.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
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.
|
copy
public 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.
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.
public 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()
.
NotificationTransport
public 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()
.
NotificationTransport
public String version()
The version of the Notification API to use. Valid value is 2006-05-05.
public 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.
public 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.
public NotificationSpecification.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>
public static NotificationSpecification.Builder builder()
public static Class<? extends NotificationSpecification.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.