Notification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.snowball.model.Notification

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Notification()

Constructors
Constructor and Description
`Notification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Notification`	`clone()`
`boolean`	`equals(Object obj)`
`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`	`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; useful for testing and debugging.
`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.

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

- Constructor Detail
  - Notification
```
public Notification()
```
- Method Detail
  - setSnsTopicARN
```
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
    
    Parameters:
    
    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.
  - getSnsTopicARN
```
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
    
    Returns:
    
    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.
  - withSnsTopicARN
```
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getJobStatesToNotify
```
public List<String> getJobStatesToNotify()
```
    The list of job states that will trigger a notification for this job.
    
    Returns:
    
    The list of job states that will trigger a notification for this job.
    
    See Also:
    
    JobState
  - setJobStatesToNotify
```
public void setJobStatesToNotify(Collection<String> jobStatesToNotify)
```
    The list of job states that will trigger a notification for this job.
    
    Parameters:
    
    jobStatesToNotify - The list of job states that will trigger a notification for this job.
    
    See Also:
    
    JobState
  - withJobStatesToNotify
```
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.
    
    Parameters:
    
    jobStatesToNotify - The list of job states that will trigger a notification for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobState
  - withJobStatesToNotify
```
public Notification withJobStatesToNotify(Collection<String> jobStatesToNotify)
```
    The list of job states that will trigger a notification for this job.
    
    Parameters:
    
    jobStatesToNotify - The list of job states that will trigger a notification for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobState
  - withJobStatesToNotify
```
public Notification withJobStatesToNotify(JobState... jobStatesToNotify)
```
    The list of job states that will trigger a notification for this job.
    
    Parameters:
    
    jobStatesToNotify - The list of job states that will trigger a notification for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobState
  - setNotifyAll
```
public void setNotifyAll(Boolean notifyAll)
```
    Any change in job state will trigger a notification for this job.
    
    Parameters:
    
    notifyAll - Any change in job state will trigger a notification for this job.
  - getNotifyAll
```
public Boolean getNotifyAll()
```
    Any change in job state will trigger a notification for this job.
    
    Returns:
    
    Any change in job state will trigger a notification for this job.
  - withNotifyAll
```
public Notification withNotifyAll(Boolean notifyAll)
```
    Any change in job state will trigger a notification for this job.
    
    Parameters:
    
    notifyAll - Any change in job state will trigger a notification for this job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNotifyAll
```
public Boolean isNotifyAll()
```
    Any change in job state will trigger a notification for this job.
    
    Returns:
    
    Any change in job state will trigger a notification for this job.
  - 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 Notification 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 Notification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Notification

Method Detail

setSnsTopicARN

getSnsTopicARN

withSnsTopicARN

getJobStatesToNotify

setJobStatesToNotify

withJobStatesToNotify

withJobStatesToNotify

withJobStatesToNotify

setNotifyAll

getNotifyAll

withNotifyAll

isNotifyAll

toString

equals

hashCode

clone

marshall