NotificationSpecification (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.mturk.model.NotificationSpecification

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public class NotificationSpecification
extends Object
implements StructuredPojo, ToCopyableBuilder<NotificationSpecification.Builder,NotificationSpecification>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NotificationSpecification.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NotificationSpecification.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - destination
```
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.
    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 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 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 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 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.
    
    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.
  - eventTypesAsStrings
```
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.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class NotificationSpecification

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

destination

transport

transportAsString

version

eventTypes

eventTypesAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall