Package software.amazon.awssdk.services.snowball.model

Class Notification

java.lang.Object

software.amazon.awssdk.services.snowball.model.Notification

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Notification.Builder,Notification>

@Generated("software.amazon.awssdk:codegen")
public 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Notification.Builder

Method Summary

Modifier and Type	Method	Description
static Notification.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
List<String>	jobStatesToNotify()	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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

snsTopicARN

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.

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.

jobStatesToNotify

public List<String> jobStatesToNotify()

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

notifyAllJobStates

public Boolean notifyAllJobStates()

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.

toBuilder

public Notification.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Notification.Builder,Notification>

Returns:

a builder for type T

builder

public static Notification.Builder builder()

serializableBuilderClass

public static Class<? extends Notification.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString 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.