NotificationSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mturk.model.NotificationSpecification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NotificationSpecification
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The NotificationSpecification data structure describes a HIT event notification for a HIT type.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NotificationSpecification()

Constructors
Constructor and Description
`NotificationSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NotificationSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDestination()` The target for notification messages.
`List<String>`	`getEventTypes()` The list of events that should cause notifications to be sent.
`String`	`getTransport()` The method Amazon Mechanical Turk uses to send the notification.
`String`	`getVersion()` The version of the Notification API to use.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDestination(String destination)` The target for notification messages.
`void`	`setEventTypes(Collection<String> eventTypes)` The list of events that should cause notifications to be sent.
`void`	`setTransport(NotificationTransport transport)` The method Amazon Mechanical Turk uses to send the notification.
`void`	`setTransport(String transport)` The method Amazon Mechanical Turk uses to send the notification.
`void`	`setVersion(String version)` The version of the Notification API to use.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`NotificationSpecification`	`withDestination(String destination)` The target for notification messages.
`NotificationSpecification`	`withEventTypes(Collection<String> eventTypes)` The list of events that should cause notifications to be sent.
`NotificationSpecification`	`withEventTypes(EventType... eventTypes)` The list of events that should cause notifications to be sent.
`NotificationSpecification`	`withEventTypes(String... eventTypes)` The list of events that should cause notifications to be sent.
`NotificationSpecification`	`withTransport(NotificationTransport transport)` The method Amazon Mechanical Turk uses to send the notification.
`NotificationSpecification`	`withTransport(String transport)` The method Amazon Mechanical Turk uses to send the notification.
`NotificationSpecification`	`withVersion(String version)` The version of the Notification API to use.

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

- Constructor Detail
  - NotificationSpecification
```
public NotificationSpecification()
```
- Method Detail
  - setDestination
```
public void setDestination(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.
    Parameters:
    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.
  - getDestination
```
public String getDestination()
```
    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.
  - withDestination
```
public NotificationSpecification withDestination(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTransport
```
public void setTransport(String transport)
```
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Parameters:
    
    transport - The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    See Also:
    
    NotificationTransport
  - getTransport
```
public String getTransport()
```
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Returns:
    
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    See Also:
    
    NotificationTransport
  - withTransport
```
public NotificationSpecification withTransport(String transport)
```
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Parameters:
    
    transport - The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationTransport
  - setTransport
```
public void setTransport(NotificationTransport transport)
```
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Parameters:
    
    transport - The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    See Also:
    
    NotificationTransport
  - withTransport
```
public NotificationSpecification withTransport(NotificationTransport transport)
```
    The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Parameters:
    
    transport - The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotificationTransport
  - setVersion
```
public void setVersion(String version)
```
    The version of the Notification API to use. Valid value is 2006-05-05.
    
    Parameters:
    
    version - The version of the Notification API to use. Valid value is 2006-05-05.
  - getVersion
```
public String getVersion()
```
    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.
  - withVersion
```
public NotificationSpecification withVersion(String version)
```
    The version of the Notification API to use. Valid value is 2006-05-05.
    
    Parameters:
    
    version - The version of the Notification API to use. Valid value is 2006-05-05.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEventTypes
```
public List<String> getEventTypes()
```
    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.
    
    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.
    
    See Also:
    
    EventType
  - setEventTypes
```
public void setEventTypes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    EventType
  - withEventTypes
```
public NotificationSpecification withEventTypes(String... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setEventTypes(java.util.Collection) or withEventTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - withEventTypes
```
public NotificationSpecification withEventTypes(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - withEventTypes
```
public NotificationSpecification withEventTypes(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventType
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NotificationSpecification clone()
```
    Overrides:
    
    clone in class Object
  - 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.

Did this page help you?

Class NotificationSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NotificationSpecification

Method Detail

setDestination

getDestination

withDestination

setTransport

getTransport

withTransport

setTransport

withTransport

setVersion

getVersion

withVersion

getEventTypes

setEventTypes

withEventTypes

withEventTypes

withEventTypes

toString

equals

hashCode

clone

marshall