software.amazon.awssdk.services.budgets.model

Class Notification

java.lang.Object

software.amazon.awssdk.services.budgets.model.Notification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Notification.Builder,Notification>

@Generated(value="software.amazon.awssdk:codegen")
public final class Notification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Notification.Builder,Notification>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Notification.Builder

Method Summary

Modifier and Type	Method and Description
static Notification.Builder	builder()
ComparisonOperator	comparisonOperator() The comparison that is used for this notification.
String	comparisonOperatorAsString() The comparison that is used for this notification.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NotificationState	notificationState() Whether this notification is in alarm.
String	notificationStateAsString() Whether this notification is in alarm.
NotificationType	notificationType() Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
String	notificationTypeAsString() Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
List<SdkField<?>>	sdkFields()
static Class<? extends Notification.Builder>	serializableBuilderClass()
Double	threshold() The threshold that is associated with a notification.
ThresholdType	thresholdType() The type of threshold for a notification.
String	thresholdTypeAsString() The type of threshold for a notification.
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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

notificationType

public NotificationType notificationType()

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

If the service returns an enum value that is not available in the current SDK version, notificationType will return NotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationTypeAsString().

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

notificationTypeAsString

public String notificationTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, notificationType will return NotificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationTypeAsString().

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

comparisonOperator

public ComparisonOperator comparisonOperator()

The comparison that is used for this notification.

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

The comparison that is used for this notification.

See Also:

ComparisonOperator

comparisonOperatorAsString

public String comparisonOperatorAsString()

The comparison that is used for this notification.

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

The comparison that is used for this notification.

See Also:

ComparisonOperator

threshold

public Double threshold()

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.

thresholdType

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

If the service returns an enum value that is not available in the current SDK version, thresholdType will return ThresholdType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdTypeAsString().

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

thresholdTypeAsString

public String thresholdTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, thresholdType will return ThresholdType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdTypeAsString().

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

notificationState

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

If the service returns an enum value that is not available in the current SDK version, notificationState will return NotificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationStateAsString().

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

notificationStateAsString

public String notificationStateAsString()

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

If the service returns an enum value that is not available in the current SDK version, notificationState will return NotificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from notificationStateAsString().

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

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.