AlertConditionRest.java

/*
 * RHQ Management Platform
 * Copyright (C) 2012-2013 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

package org.rhq.enterprise.server.rest.domain;

import javax.xml.bind.annotation.XmlRootElement;

import com.wordnik.swagger.annotations.ApiClass;
import com.wordnik.swagger.annotations.ApiProperty;

/**
 * One condition for an alert definition.
 * An alert definition can have any number of definitions
 * @author Heiko W. Rupp
 */
@ApiClass(value = "One condition for an alert definition")
@XmlRootElement(name = "condition")
public class AlertConditionRest {

    private String conditionName;
    private String category;
    private int id;
    private Double threshold;
    private String option;
    private Integer triggerId;
    private String comparator;
    private int measurementDefinition;

    public AlertConditionRest() {
    }

    @ApiProperty("Comparator to use with this definition. See POST /alert/defintion/{id}/condition for details.")
    public String getName() {
        return conditionName;
    }

    public void setName(String name) {
        this.conditionName = name;
    }

    @ApiProperty(value = "The category. See POST /alert/defintion/{id}/condition for details.",
        allowableValues = "AVAILABILITY, THRESHOLD, BASELINE, CHANGE, TRAIT, CONTROL, ALERT, RESOURCE_CONFIG, EVENT, DRIFT, RANGE, AVAIL_DURATION")
    public String getCategory() {
        return category;
    }

    public void setCategory(String category) {
        this.category = category;
    }

    public void setId(int id) {
        this.id = id;
    }

    @ApiProperty("Id of the condition. Note that this is not stable - when you update the condition, its id will change")
    public int getId() {
        return id;
    }

    @ApiProperty("The threshold to compare against. See POST /alert/defintion/{id}/condition for details.")
    public Double getThreshold() {
        return threshold;
    }

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

    @ApiProperty("Options to this condition. Depends on the category used. See POST /alert/defintion/{id}/condition for details.")
    public String getOption() {
        return option;
    }

    public void setOption(String option) {
        this.option = option;
    }

    public Integer getTriggerId() {
        return triggerId;
    }

    public void setTriggerId(Integer triggerId) {
        this.triggerId = triggerId;
    }

    @ApiProperty("Comparator for conditions. See POST /alert/defintion/{id}/condition for details.")
    public String getComparator() {
        return comparator;
    }

    public void setComparator(String comparator) {
        this.comparator = comparator;
    }

    @ApiProperty("The id of the measurement *definition*, this comparator should apply to. A metric schedule can be identified by a resource id and a definition id.")
    public int getMeasurementDefinition() {
        return measurementDefinition;
    }

    public void setMeasurementDefinition(int measurementDefinition) {
        this.measurementDefinition = measurementDefinition;
    }
}