com.amazonaws.services.budgets.model

Class Notification

java.lang.Object

com.amazonaws.services.budgets.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

A notification that is associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

• A notificationType of ACTUAL

• A thresholdType of PERCENTAGE

• A comparisonOperator of GREATER_THAN

• A notification threshold of 80

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
Notification	clone()
boolean	equals(Object obj)
String	getComparisonOperator() The comparison that is used for this notification.
String	getNotificationState() Whether this notification is in alarm.
String	getNotificationType() Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
Double	getThreshold() The threshold that is associated with a notification.
String	getThresholdType() The type of threshold for a notification.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setComparisonOperator(ComparisonOperator comparisonOperator) The comparison that is used for this notification.
void	setComparisonOperator(String comparisonOperator) The comparison that is used for this notification.
void	setNotificationState(NotificationState notificationState) Whether this notification is in alarm.
void	setNotificationState(String notificationState) Whether this notification is in alarm.
void	setNotificationType(NotificationType notificationType) Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
void	setNotificationType(String notificationType) Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
void	setThreshold(Double threshold) The threshold that is associated with a notification.
void	setThresholdType(String thresholdType) The type of threshold for a notification.
void	setThresholdType(ThresholdType thresholdType) The type of threshold for a notification.
String	toString() Returns a string representation of this object.
Notification	withComparisonOperator(ComparisonOperator comparisonOperator) The comparison that is used for this notification.
Notification	withComparisonOperator(String comparisonOperator) The comparison that is used for this notification.
Notification	withNotificationState(NotificationState notificationState) Whether this notification is in alarm.
Notification	withNotificationState(String notificationState) Whether this notification is in alarm.
Notification	withNotificationType(NotificationType notificationType) Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
Notification	withNotificationType(String notificationType) Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
Notification	withThreshold(Double threshold) The threshold that is associated with a notification.
Notification	withThresholdType(String thresholdType) The type of threshold for a notification.
Notification	withThresholdType(ThresholdType thresholdType) The type of threshold for a notification.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

setNotificationType

public void setNotificationType(String notificationType)

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Parameters:

notificationType - Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

See Also:

NotificationType

getNotificationType

public String getNotificationType()

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Returns:

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

See Also:

NotificationType

withNotificationType

public Notification withNotificationType(String notificationType)

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Parameters:

notificationType - Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationType

setNotificationType

public void setNotificationType(NotificationType notificationType)

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Parameters:

notificationType - Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

See Also:

NotificationType

withNotificationType

public Notification withNotificationType(NotificationType notificationType)

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Parameters:

notificationType - Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationType

setComparisonOperator

public void setComparisonOperator(String comparisonOperator)

The comparison that is used for this notification.

Parameters:

comparisonOperator - The comparison that is used for this notification.

See Also:

ComparisonOperator

getComparisonOperator

public String getComparisonOperator()

The comparison that is used for this notification.

Returns:

The comparison that is used for this notification.

See Also:

ComparisonOperator

withComparisonOperator

public Notification withComparisonOperator(String comparisonOperator)

The comparison that is used for this notification.

Parameters:

comparisonOperator - The comparison that is used for this notification.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperator

setComparisonOperator

public void setComparisonOperator(ComparisonOperator comparisonOperator)

The comparison that is used for this notification.

Parameters:

comparisonOperator - The comparison that is used for this notification.

See Also:

ComparisonOperator

withComparisonOperator

public Notification withComparisonOperator(ComparisonOperator comparisonOperator)

The comparison that is used for this notification.

Parameters:

comparisonOperator - The comparison that is used for this notification.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperator

setThreshold

public void setThreshold(Double threshold)

The threshold that is associated with a notification. Thresholds are always a percentage.

Parameters:

threshold - The threshold that is associated with a notification. Thresholds are always a percentage.

getThreshold

public Double getThreshold()

The threshold that is associated with a notification. Thresholds are always a percentage.

Returns:

The threshold that is associated with a notification. Thresholds are always a percentage.

withThreshold

public Notification withThreshold(Double threshold)

The threshold that is associated with a notification. Thresholds are always a percentage.

Parameters:

threshold - The threshold that is associated with a notification. Thresholds are always a percentage.

Returns:

Returns a reference to this object so that method calls can be chained together.

setThresholdType

public void setThresholdType(String thresholdType)

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Parameters:

thresholdType - The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

See Also:

ThresholdType

getThresholdType

public String getThresholdType()

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Returns:

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

See Also:

ThresholdType

withThresholdType

public Notification withThresholdType(String thresholdType)

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Parameters:

thresholdType - The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThresholdType

setThresholdType

public void setThresholdType(ThresholdType thresholdType)

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Parameters:

thresholdType - The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

See Also:

ThresholdType

withThresholdType

public Notification withThresholdType(ThresholdType thresholdType)

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Parameters:

thresholdType - The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ThresholdType

setNotificationState

public void setNotificationState(String notificationState)

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Parameters:

notificationState - Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

See Also:

NotificationState

getNotificationState

public String getNotificationState()

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Returns:

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

See Also:

NotificationState

withNotificationState

public Notification withNotificationState(String notificationState)

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Parameters:

notificationState - Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationState

setNotificationState

public void setNotificationState(NotificationState notificationState)

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Parameters:

notificationState - Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

See Also:

NotificationState

withNotificationState

public Notification withNotificationState(NotificationState notificationState)

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Parameters:

notificationState - Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationState

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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.