AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::MTurk::Model::NotificationSpecification Class Reference

#include <NotificationSpecification.h>

Public Member Functions

 NotificationSpecification ()
 
 NotificationSpecification (Aws::Utils::Json::JsonView jsonValue)
 
NotificationSpecificationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDestination () const
 
bool DestinationHasBeenSet () const
 
void SetDestination (const Aws::String &value)
 
void SetDestination (Aws::String &&value)
 
void SetDestination (const char *value)
 
NotificationSpecificationWithDestination (const Aws::String &value)
 
NotificationSpecificationWithDestination (Aws::String &&value)
 
NotificationSpecificationWithDestination (const char *value)
 
const NotificationTransportGetTransport () const
 
bool TransportHasBeenSet () const
 
void SetTransport (const NotificationTransport &value)
 
void SetTransport (NotificationTransport &&value)
 
NotificationSpecificationWithTransport (const NotificationTransport &value)
 
NotificationSpecificationWithTransport (NotificationTransport &&value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
NotificationSpecificationWithVersion (const Aws::String &value)
 
NotificationSpecificationWithVersion (Aws::String &&value)
 
NotificationSpecificationWithVersion (const char *value)
 
const Aws::Vector< EventType > & GetEventTypes () const
 
bool EventTypesHasBeenSet () const
 
void SetEventTypes (const Aws::Vector< EventType > &value)
 
void SetEventTypes (Aws::Vector< EventType > &&value)
 
NotificationSpecificationWithEventTypes (const Aws::Vector< EventType > &value)
 
NotificationSpecificationWithEventTypes (Aws::Vector< EventType > &&value)
 
NotificationSpecificationAddEventTypes (const EventType &value)
 
NotificationSpecificationAddEventTypes (EventType &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 35 of file NotificationSpecification.h.

Constructor & Destructor Documentation

◆ NotificationSpecification() [1/2]

Aws::MTurk::Model::NotificationSpecification::NotificationSpecification ( )

◆ NotificationSpecification() [2/2]

Aws::MTurk::Model::NotificationSpecification::NotificationSpecification ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddEventTypes() [1/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::AddEventTypes ( const EventType value)
inline

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.

Definition at line 256 of file NotificationSpecification.h.

◆ AddEventTypes() [2/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::AddEventTypes ( EventType &&  value)
inline

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.

Definition at line 265 of file NotificationSpecification.h.

◆ DestinationHasBeenSet()

bool Aws::MTurk::Model::NotificationSpecification::DestinationHasBeenSet ( ) const
inline

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.

Definition at line 60 of file NotificationSpecification.h.

◆ EventTypesHasBeenSet()

bool Aws::MTurk::Model::NotificationSpecification::EventTypesHasBeenSet ( ) const
inline

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.

Definition at line 211 of file NotificationSpecification.h.

◆ GetDestination()

const Aws::String& Aws::MTurk::Model::NotificationSpecification::GetDestination ( ) const
inline

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.

Definition at line 51 of file NotificationSpecification.h.

◆ GetEventTypes()

const Aws::Vector<EventType>& Aws::MTurk::Model::NotificationSpecification::GetEventTypes ( ) const
inline

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.

Definition at line 202 of file NotificationSpecification.h.

◆ GetTransport()

const NotificationTransport& Aws::MTurk::Model::NotificationSpecification::GetTransport ( ) const
inline

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

Definition at line 121 of file NotificationSpecification.h.

◆ GetVersion()

const Aws::String& Aws::MTurk::Model::NotificationSpecification::GetVersion ( ) const
inline

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

Definition at line 157 of file NotificationSpecification.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MTurk::Model::NotificationSpecification::Jsonize ( ) const

◆ operator=()

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDestination() [1/3]

void Aws::MTurk::Model::NotificationSpecification::SetDestination ( Aws::String &&  value)
inline

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.

Definition at line 78 of file NotificationSpecification.h.

◆ SetDestination() [2/3]

void Aws::MTurk::Model::NotificationSpecification::SetDestination ( const Aws::String value)
inline

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.

Definition at line 69 of file NotificationSpecification.h.

◆ SetDestination() [3/3]

void Aws::MTurk::Model::NotificationSpecification::SetDestination ( const char *  value)
inline

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.

Definition at line 87 of file NotificationSpecification.h.

◆ SetEventTypes() [1/2]

void Aws::MTurk::Model::NotificationSpecification::SetEventTypes ( Aws::Vector< EventType > &&  value)
inline

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.

Definition at line 229 of file NotificationSpecification.h.

◆ SetEventTypes() [2/2]

void Aws::MTurk::Model::NotificationSpecification::SetEventTypes ( const Aws::Vector< EventType > &  value)
inline

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.

Definition at line 220 of file NotificationSpecification.h.

◆ SetTransport() [1/2]

void Aws::MTurk::Model::NotificationSpecification::SetTransport ( const NotificationTransport value)
inline

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

Definition at line 133 of file NotificationSpecification.h.

◆ SetTransport() [2/2]

void Aws::MTurk::Model::NotificationSpecification::SetTransport ( NotificationTransport &&  value)
inline

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

Definition at line 139 of file NotificationSpecification.h.

◆ SetVersion() [1/3]

void Aws::MTurk::Model::NotificationSpecification::SetVersion ( Aws::String &&  value)
inline

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

Definition at line 172 of file NotificationSpecification.h.

◆ SetVersion() [2/3]

void Aws::MTurk::Model::NotificationSpecification::SetVersion ( const Aws::String value)
inline

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

Definition at line 167 of file NotificationSpecification.h.

◆ SetVersion() [3/3]

void Aws::MTurk::Model::NotificationSpecification::SetVersion ( const char *  value)
inline

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

Definition at line 177 of file NotificationSpecification.h.

◆ TransportHasBeenSet()

bool Aws::MTurk::Model::NotificationSpecification::TransportHasBeenSet ( ) const
inline

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

Definition at line 127 of file NotificationSpecification.h.

◆ VersionHasBeenSet()

bool Aws::MTurk::Model::NotificationSpecification::VersionHasBeenSet ( ) const
inline

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

Definition at line 162 of file NotificationSpecification.h.

◆ WithDestination() [1/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithDestination ( Aws::String &&  value)
inline

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.

Definition at line 105 of file NotificationSpecification.h.

◆ WithDestination() [2/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithDestination ( const Aws::String value)
inline

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.

Definition at line 96 of file NotificationSpecification.h.

◆ WithDestination() [3/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithDestination ( const char *  value)
inline

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.

Definition at line 114 of file NotificationSpecification.h.

◆ WithEventTypes() [1/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithEventTypes ( Aws::Vector< EventType > &&  value)
inline

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.

Definition at line 247 of file NotificationSpecification.h.

◆ WithEventTypes() [2/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithEventTypes ( const Aws::Vector< EventType > &  value)
inline

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.

Definition at line 238 of file NotificationSpecification.h.

◆ WithTransport() [1/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithTransport ( const NotificationTransport value)
inline

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

Definition at line 145 of file NotificationSpecification.h.

◆ WithTransport() [2/2]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithTransport ( NotificationTransport &&  value)
inline

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

Definition at line 151 of file NotificationSpecification.h.

◆ WithVersion() [1/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithVersion ( Aws::String &&  value)
inline

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

Definition at line 187 of file NotificationSpecification.h.

◆ WithVersion() [2/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithVersion ( const Aws::String value)
inline

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

Definition at line 182 of file NotificationSpecification.h.

◆ WithVersion() [3/3]

NotificationSpecification& Aws::MTurk::Model::NotificationSpecification::WithVersion ( const char *  value)
inline

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

Definition at line 192 of file NotificationSpecification.h.


The documentation for this class was generated from the following file: