/*
 * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.budgets.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * A notification that's associated with a budget. A budget can have up to ten notifications.
 * </p>
 * <p>
 * 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.
 * </p>
 * <p>
 * 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:
 * </p>
 * <ul>
 * <li>
 * <p>
 * A notificationType of <code>ACTUAL</code>
 * </p>
 * </li>
 * <li>
 * <p>
 * A <code>thresholdType</code> of <code>PERCENTAGE</code>
 * </p>
 * </li>
 * <li>
 * <p>
 * A <code>comparisonOperator</code> of <code>GREATER_THAN</code>
 * </p>
 * </li>
 * <li>
 * <p>
 * A notification <code>threshold</code> of <code>80</code>
 * </p>
 * </li>
 * </ul>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Notification implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     */
    private String notificationType;
    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     */
    private String comparisonOperator;
    /**
     * <p>
     * The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find
     * value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000%
     * above the budgeted amount.
     * </p>
     */
    private Double threshold;
    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     */
    private String thresholdType;
    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     */
    private String notificationState;

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     * 
     * @param notificationType
     *        Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much
     *        that you're forecasted to spend (<code>FORECASTED</code>).
     * @see NotificationType
     */

    public void setNotificationType(String notificationType) {
        this.notificationType = notificationType;
    }

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     * 
     * @return Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much
     *         that you're forecasted to spend (<code>FORECASTED</code>).
     * @see NotificationType
     */

    public String getNotificationType() {
        return this.notificationType;
    }

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     * 
     * @param notificationType
     *        Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much
     *        that you're forecasted to spend (<code>FORECASTED</code>).
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see NotificationType
     */

    public Notification withNotificationType(String notificationType) {
        setNotificationType(notificationType);
        return this;
    }

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     * 
     * @param notificationType
     *        Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much
     *        that you're forecasted to spend (<code>FORECASTED</code>).
     * @see NotificationType
     */

    public void setNotificationType(NotificationType notificationType) {
        withNotificationType(notificationType);
    }

    /**
     * <p>
     * Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that
     * you're forecasted to spend (<code>FORECASTED</code>).
     * </p>
     * 
     * @param notificationType
     *        Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much
     *        that you're forecasted to spend (<code>FORECASTED</code>).
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see NotificationType
     */

    public Notification withNotificationType(NotificationType notificationType) {
        this.notificationType = notificationType.toString();
        return this;
    }

    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     * 
     * @param comparisonOperator
     *        The comparison that's used for this notification.
     * @see ComparisonOperator
     */

    public void setComparisonOperator(String comparisonOperator) {
        this.comparisonOperator = comparisonOperator;
    }

    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     * 
     * @return The comparison that's used for this notification.
     * @see ComparisonOperator
     */

    public String getComparisonOperator() {
        return this.comparisonOperator;
    }

    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     * 
     * @param comparisonOperator
     *        The comparison that's used for this notification.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ComparisonOperator
     */

    public Notification withComparisonOperator(String comparisonOperator) {
        setComparisonOperator(comparisonOperator);
        return this;
    }

    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     * 
     * @param comparisonOperator
     *        The comparison that's used for this notification.
     * @see ComparisonOperator
     */

    public void setComparisonOperator(ComparisonOperator comparisonOperator) {
        withComparisonOperator(comparisonOperator);
    }

    /**
     * <p>
     * The comparison that's used for this notification.
     * </p>
     * 
     * @param comparisonOperator
     *        The comparison that's used for this notification.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ComparisonOperator
     */

    public Notification withComparisonOperator(ComparisonOperator comparisonOperator) {
        this.comparisonOperator = comparisonOperator.toString();
        return this;
    }

    /**
     * <p>
     * The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find
     * value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000%
     * above the budgeted amount.
     * </p>
     * 
     * @param threshold
     *        The threshold that's associated with a notification. Thresholds are always a percentage, and many
     *        customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your
     *        threshold is 1,000,000% above the budgeted amount.
     */

    public void setThreshold(Double threshold) {
        this.threshold = threshold;
    }

    /**
     * <p>
     * The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find
     * value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000%
     * above the budgeted amount.
     * </p>
     * 
     * @return The threshold that's associated with a notification. Thresholds are always a percentage, and many
     *         customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your
     *         threshold is 1,000,000% above the budgeted amount.
     */

    public Double getThreshold() {
        return this.threshold;
    }

    /**
     * <p>
     * The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find
     * value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000%
     * above the budgeted amount.
     * </p>
     * 
     * @param threshold
     *        The threshold that's associated with a notification. Thresholds are always a percentage, and many
     *        customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your
     *        threshold is 1,000,000% above the budgeted amount.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public Notification withThreshold(Double threshold) {
        setThreshold(threshold);
        return this;
    }

    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     * 
     * @param thresholdType
     *        The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     *        notifies you when you go over or are forecasted to go over your total cost threshold. For
     *        <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over
     *        160 dollars.
     * @see ThresholdType
     */

    public void setThresholdType(String thresholdType) {
        this.thresholdType = thresholdType;
    }

    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     * 
     * @return The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     *         notifies you when you go over or are forecasted to go over your total cost threshold. For
     *         <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when
     *         you go over 160 dollars.
     * @see ThresholdType
     */

    public String getThresholdType() {
        return this.thresholdType;
    }

    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     * 
     * @param thresholdType
     *        The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     *        notifies you when you go over or are forecasted to go over your total cost threshold. For
     *        <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over
     *        160 dollars.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ThresholdType
     */

    public Notification withThresholdType(String thresholdType) {
        setThresholdType(thresholdType);
        return this;
    }

    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     * 
     * @param thresholdType
     *        The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     *        notifies you when you go over or are forecasted to go over your total cost threshold. For
     *        <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over
     *        160 dollars.
     * @see ThresholdType
     */

    public void setThresholdType(ThresholdType thresholdType) {
        withThresholdType(thresholdType);
    }

    /**
     * <p>
     * The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     * notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code>
     * thresholds, Amazon Web Services 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
     * <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
     * </p>
     * 
     * @param thresholdType
     *        The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services
     *        notifies you when you go over or are forecasted to go over your total cost threshold. For
     *        <code>PERCENTAGE</code> thresholds, Amazon Web Services 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 <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over
     *        160 dollars.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ThresholdType
     */

    public Notification withThresholdType(ThresholdType thresholdType) {
        this.thresholdType = thresholdType.toString();
        return this;
    }

    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     * 
     * @param notificationState
     *        Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code>
     *        state, you passed the set threshold for the budget.
     * @see NotificationState
     */

    public void setNotificationState(String notificationState) {
        this.notificationState = notificationState;
    }

    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     * 
     * @return Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code>
     *         state, you passed the set threshold for the budget.
     * @see NotificationState
     */

    public String getNotificationState() {
        return this.notificationState;
    }

    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     * 
     * @param notificationState
     *        Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code>
     *        state, you passed the set threshold for the budget.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see NotificationState
     */

    public Notification withNotificationState(String notificationState) {
        setNotificationState(notificationState);
        return this;
    }

    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     * 
     * @param notificationState
     *        Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code>
     *        state, you passed the set threshold for the budget.
     * @see NotificationState
     */

    public void setNotificationState(NotificationState notificationState) {
        withNotificationState(notificationState);
    }

    /**
     * <p>
     * Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you
     * passed the set threshold for the budget.
     * </p>
     * 
     * @param notificationState
     *        Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code>
     *        state, you passed the set threshold for the budget.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see NotificationState
     */

    public Notification withNotificationState(NotificationState notificationState) {
        this.notificationState = notificationState.toString();
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getNotificationType() != null)
            sb.append("NotificationType: ").append(getNotificationType()).append(",");
        if (getComparisonOperator() != null)
            sb.append("ComparisonOperator: ").append(getComparisonOperator()).append(",");
        if (getThreshold() != null)
            sb.append("Threshold: ").append(getThreshold()).append(",");
        if (getThresholdType() != null)
            sb.append("ThresholdType: ").append(getThresholdType()).append(",");
        if (getNotificationState() != null)
            sb.append("NotificationState: ").append(getNotificationState());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof Notification == false)
            return false;
        Notification other = (Notification) obj;
        if (other.getNotificationType() == null ^ this.getNotificationType() == null)
            return false;
        if (other.getNotificationType() != null && other.getNotificationType().equals(this.getNotificationType()) == false)
            return false;
        if (other.getComparisonOperator() == null ^ this.getComparisonOperator() == null)
            return false;
        if (other.getComparisonOperator() != null && other.getComparisonOperator().equals(this.getComparisonOperator()) == false)
            return false;
        if (other.getThreshold() == null ^ this.getThreshold() == null)
            return false;
        if (other.getThreshold() != null && other.getThreshold().equals(this.getThreshold()) == false)
            return false;
        if (other.getThresholdType() == null ^ this.getThresholdType() == null)
            return false;
        if (other.getThresholdType() != null && other.getThresholdType().equals(this.getThresholdType()) == false)
            return false;
        if (other.getNotificationState() == null ^ this.getNotificationState() == null)
            return false;
        if (other.getNotificationState() != null && other.getNotificationState().equals(this.getNotificationState()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getNotificationType() == null) ? 0 : getNotificationType().hashCode());
        hashCode = prime * hashCode + ((getComparisonOperator() == null) ? 0 : getComparisonOperator().hashCode());
        hashCode = prime * hashCode + ((getThreshold() == null) ? 0 : getThreshold().hashCode());
        hashCode = prime * hashCode + ((getThresholdType() == null) ? 0 : getThresholdType().hashCode());
        hashCode = prime * hashCode + ((getNotificationState() == null) ? 0 : getNotificationState().hashCode());
        return hashCode;
    }

    @Override
    public Notification clone() {
        try {
            return (Notification) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.budgets.model.transform.NotificationMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}