@Generated(value="software.amazon.awssdk:codegen") public final class Notification extends Object implements StructuredPojo, ToCopyableBuilder<Notification.Builder,Notification>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
Notification.Builder |
Modifier and Type | Method and Description |
---|---|
static Notification.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<JobState> |
jobStatesToNotify()
The list of job states that will trigger a notification for this job.
|
List<String> |
jobStatesToNotifyAsStrings()
The list of job states that will trigger a notification for this job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Boolean |
notifyAllJobStates()
Any change in job state will trigger a notification for this job.
|
static Class<? extends Notification.Builder> |
serializableBuilderClass() |
String |
snsTopicARN()
The new SNS
TopicArn that you want to associate with this job. |
Notification.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
public List<JobState> jobStatesToNotify()
The list of job states that will trigger a notification for this job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> jobStatesToNotifyAsStrings()
The list of job states that will trigger a notification for this job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean notifyAllJobStates()
Any change in job state will trigger a notification for this job.
public Notification.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Notification.Builder,Notification>
public static Notification.Builder builder()
public static Class<? extends Notification.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.