@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Notification extends Object implements Serializable, Cloneable, StructuredPojo
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notification
object is returned as a part of the response syntax of the DescribeJob
action
in the JobMetadata
data type.
When the notification settings are defined during job creation, you can choose to notify based on a specific set of
job states using the JobStatesToNotify
array of strings, or you can specify that you want to have Amazon
SNS notifications sent out for all job states with NotifyAll
set to true.
Constructor and Description |
---|
Notification() |
Modifier and Type | Method and Description |
---|---|
Notification |
clone() |
boolean |
equals(Object obj) |
String |
getDevicePickupSnsTopicARN()
Used to send SNS notifications for the person picking up the device (identified during job creation).
|
List<String> |
getJobStatesToNotify()
The list of job states that will trigger a notification for this job.
|
Boolean |
getNotifyAll()
Any change in job state will trigger a notification for this job.
|
String |
getSnsTopicARN()
The new SNS
TopicArn that you want to associate with this job. |
int |
hashCode() |
Boolean |
isNotifyAll()
Any change in job state will trigger a notification for this job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDevicePickupSnsTopicARN(String devicePickupSnsTopicARN)
Used to send SNS notifications for the person picking up the device (identified during job creation).
|
void |
setJobStatesToNotify(Collection<String> jobStatesToNotify)
The list of job states that will trigger a notification for this job.
|
void |
setNotifyAll(Boolean notifyAll)
Any change in job state will trigger a notification for this job.
|
void |
setSnsTopicARN(String snsTopicARN)
The new SNS
TopicArn that you want to associate with this job. |
String |
toString()
Returns a string representation of this object.
|
Notification |
withDevicePickupSnsTopicARN(String devicePickupSnsTopicARN)
Used to send SNS notifications for the person picking up the device (identified during job creation).
|
Notification |
withJobStatesToNotify(Collection<String> jobStatesToNotify)
The list of job states that will trigger a notification for this job.
|
Notification |
withJobStatesToNotify(JobState... jobStatesToNotify)
The list of job states that will trigger a notification for this job.
|
Notification |
withJobStatesToNotify(String... jobStatesToNotify)
The list of job states that will trigger a notification for this job.
|
Notification |
withNotifyAll(Boolean notifyAll)
Any change in job state will trigger a notification for this job.
|
Notification |
withSnsTopicARN(String snsTopicARN)
The new SNS
TopicArn that you want to associate with this job. |
public void setSnsTopicARN(String snsTopicARN)
The new SNS TopicArn
that you want to associate with this job. You can create Amazon Resource Names
(ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
snsTopicARN
- The new SNS TopicArn
that you want to associate with this job. You can create Amazon Resource
Names (ARNs) for topics by using the CreateTopic Amazon SNS API
action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
public String getSnsTopicARN()
The new SNS TopicArn
that you want to associate with this job. You can create Amazon Resource Names
(ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
TopicArn
that you want to associate with this job. You can create Amazon
Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API
action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
public Notification withSnsTopicARN(String snsTopicARN)
The new SNS TopicArn
that you want to associate with this job. You can create Amazon Resource Names
(ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
snsTopicARN
- The new SNS TopicArn
that you want to associate with this job. You can create Amazon Resource
Names (ARNs) for topics by using the CreateTopic Amazon SNS API
action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
public List<String> getJobStatesToNotify()
The list of job states that will trigger a notification for this job.
JobState
public void setJobStatesToNotify(Collection<String> jobStatesToNotify)
The list of job states that will trigger a notification for this job.
jobStatesToNotify
- The list of job states that will trigger a notification for this job.JobState
public Notification withJobStatesToNotify(String... jobStatesToNotify)
The list of job states that will trigger a notification for this job.
NOTE: This method appends the values to the existing list (if any). Use
setJobStatesToNotify(java.util.Collection)
or withJobStatesToNotify(java.util.Collection)
if
you want to override the existing values.
jobStatesToNotify
- The list of job states that will trigger a notification for this job.JobState
public Notification withJobStatesToNotify(Collection<String> jobStatesToNotify)
The list of job states that will trigger a notification for this job.
jobStatesToNotify
- The list of job states that will trigger a notification for this job.JobState
public Notification withJobStatesToNotify(JobState... jobStatesToNotify)
The list of job states that will trigger a notification for this job.
jobStatesToNotify
- The list of job states that will trigger a notification for this job.JobState
public void setNotifyAll(Boolean notifyAll)
Any change in job state will trigger a notification for this job.
notifyAll
- Any change in job state will trigger a notification for this job.public Boolean getNotifyAll()
Any change in job state will trigger a notification for this job.
public Notification withNotifyAll(Boolean notifyAll)
Any change in job state will trigger a notification for this job.
notifyAll
- Any change in job state will trigger a notification for this job.public Boolean isNotifyAll()
Any change in job state will trigger a notification for this job.
public void setDevicePickupSnsTopicARN(String devicePickupSnsTopicARN)
Used to send SNS notifications for the person picking up the device (identified during job creation).
devicePickupSnsTopicARN
- Used to send SNS notifications for the person picking up the device (identified during job creation).public String getDevicePickupSnsTopicARN()
Used to send SNS notifications for the person picking up the device (identified during job creation).
public Notification withDevicePickupSnsTopicARN(String devicePickupSnsTopicARN)
Used to send SNS notifications for the person picking up the device (identified during job creation).
devicePickupSnsTopicARN
- Used to send SNS notifications for the person picking up the device (identified during job creation).public String toString()
toString
in class Object
Object.toString()
public Notification clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.