com.amazonaws.services.iot.model.TopicRule Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-2016 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.iot.model;
import java.io.Serializable;
/**
 * 
 * Describes a rule.
 * 
 */
public class TopicRule implements Serializable, Cloneable {
    /**
     * 
     * The name of the rule.
     * 
     */
    private String ruleName;
    /**
     * 
     * The SQL statement used to query the topic. When using a SQL query with
     * multiple lines, be sure to escape the newline characters.
     * 
     */
    private String sql;
    /**
     * 
     * The description of the rule.
     * 
     */
    private String description;
    /**
     * 
     * The date and time the rule was created.
     * 
     */
    private java.util.Date createdAt;
    /**
     * 
     * The actions associated with the rule.
     * 
     */
    private java.util.List actions;
    /**
     * 
     * Specifies whether the rule is disabled.
     * 
     */
    private Boolean ruleDisabled;
    /**
     * 
     * The version of the SQL rules engine to use when evaluating the rule.
     * 
     */
    private String awsIotSqlVersion;
    /**
     * 
     * The name of the rule.
     * 
     * 
     * @param ruleName
     *        The name of the rule.
     */
    public void setRuleName(String ruleName) {
        this.ruleName = ruleName;
    }
    /**
     * 
     * The name of the rule.
     * 
     * 
     * @return The name of the rule.
     */
    public String getRuleName() {
        return this.ruleName;
    }
    /**
     * 
     * The name of the rule.
     * 
     * 
     * @param ruleName
     *        The name of the rule.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withRuleName(String ruleName) {
        setRuleName(ruleName);
        return this;
    }
    /**
     * 
     * The SQL statement used to query the topic. When using a SQL query with
     * multiple lines, be sure to escape the newline characters.
     * 
     * 
     * @param sql
     *        The SQL statement used to query the topic. When using a SQL query
     *        with multiple lines, be sure to escape the newline characters.
     */
    public void setSql(String sql) {
        this.sql = sql;
    }
    /**
     * 
     * The SQL statement used to query the topic. When using a SQL query with
     * multiple lines, be sure to escape the newline characters.
     * 
     * 
     * @return The SQL statement used to query the topic. When using a SQL query
     *         with multiple lines, be sure to escape the newline characters.
     */
    public String getSql() {
        return this.sql;
    }
    /**
     * 
     * The SQL statement used to query the topic. When using a SQL query with
     * multiple lines, be sure to escape the newline characters.
     * 
     * 
     * @param sql
     *        The SQL statement used to query the topic. When using a SQL query
     *        with multiple lines, be sure to escape the newline characters.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withSql(String sql) {
        setSql(sql);
        return this;
    }
    /**
     * 
     * The description of the rule.
     * 
     * 
     * @param description
     *        The description of the rule.
     */
    public void setDescription(String description) {
        this.description = description;
    }
    /**
     * 
     * The description of the rule.
     * 
     * 
     * @return The description of the rule.
     */
    public String getDescription() {
        return this.description;
    }
    /**
     * 
     * The description of the rule.
     * 
     * 
     * @param description
     *        The description of the rule.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withDescription(String description) {
        setDescription(description);
        return this;
    }
    /**
     * 
     * The date and time the rule was created.
     * 
     * 
     * @param createdAt
     *        The date and time the rule was created.
     */
    public void setCreatedAt(java.util.Date createdAt) {
        this.createdAt = createdAt;
    }
    /**
     * 
     * The date and time the rule was created.
     * 
     * 
     * @return The date and time the rule was created.
     */
    public java.util.Date getCreatedAt() {
        return this.createdAt;
    }
    /**
     * 
     * The date and time the rule was created.
     * 
     * 
     * @param createdAt
     *        The date and time the rule was created.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withCreatedAt(java.util.Date createdAt) {
        setCreatedAt(createdAt);
        return this;
    }
    /**
     * 
     * The actions associated with the rule.
     * 
     * 
     * @return The actions associated with the rule.
     */
    public java.util.List getActions() {
        return actions;
    }
    /**
     * 
     * The actions associated with the rule.
     * 
     * 
     * @param actions
     *        The actions associated with the rule.
     */
    public void setActions(java.util.Collection actions) {
        if (actions == null) {
            this.actions = null;
            return;
        }
        this.actions = new java.util.ArrayList(actions);
    }
    /**
     * 
     * The actions associated with the rule.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setActions(java.util.Collection)} or
     * {@link #withActions(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param actions
     *        The actions associated with the rule.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withActions(Action... actions) {
        if (this.actions == null) {
            setActions(new java.util.ArrayList(actions.length));
        }
        for (Action ele : actions) {
            this.actions.add(ele);
        }
        return this;
    }
    /**
     * 
     * The actions associated with the rule.
     * 
     * 
     * @param actions
     *        The actions associated with the rule.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withActions(java.util.Collection actions) {
        setActions(actions);
        return this;
    }
    /**
     * 
     * Specifies whether the rule is disabled.
     * 
     * 
     * @param ruleDisabled
     *        Specifies whether the rule is disabled.
     */
    public void setRuleDisabled(Boolean ruleDisabled) {
        this.ruleDisabled = ruleDisabled;
    }
    /**
     * 
     * Specifies whether the rule is disabled.
     * 
     * 
     * @return Specifies whether the rule is disabled.
     */
    public Boolean getRuleDisabled() {
        return this.ruleDisabled;
    }
    /**
     * 
     * Specifies whether the rule is disabled.
     * 
     * 
     * @param ruleDisabled
     *        Specifies whether the rule is disabled.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withRuleDisabled(Boolean ruleDisabled) {
        setRuleDisabled(ruleDisabled);
        return this;
    }
    /**
     * 
     * Specifies whether the rule is disabled.
     * 
     * 
     * @return Specifies whether the rule is disabled.
     */
    public Boolean isRuleDisabled() {
        return this.ruleDisabled;
    }
    /**
     * 
     * The version of the SQL rules engine to use when evaluating the rule.
     * 
     * 
     * @param awsIotSqlVersion
     *        The version of the SQL rules engine to use when evaluating the
     *        rule.
     */
    public void setAwsIotSqlVersion(String awsIotSqlVersion) {
        this.awsIotSqlVersion = awsIotSqlVersion;
    }
    /**
     * 
     * The version of the SQL rules engine to use when evaluating the rule.
     * 
     * 
     * @return The version of the SQL rules engine to use when evaluating the
     *         rule.
     */
    public String getAwsIotSqlVersion() {
        return this.awsIotSqlVersion;
    }
    /**
     * 
     * The version of the SQL rules engine to use when evaluating the rule.
     * 
     * 
     * @param awsIotSqlVersion
     *        The version of the SQL rules engine to use when evaluating the
     *        rule.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public TopicRule withAwsIotSqlVersion(String awsIotSqlVersion) {
        setAwsIotSqlVersion(awsIotSqlVersion);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getRuleName() != null)
            sb.append("RuleName: " + getRuleName() + ",");
        if (getSql() != null)
            sb.append("Sql: " + getSql() + ",");
        if (getDescription() != null)
            sb.append("Description: " + getDescription() + ",");
        if (getCreatedAt() != null)
            sb.append("CreatedAt: " + getCreatedAt() + ",");
        if (getActions() != null)
            sb.append("Actions: " + getActions() + ",");
        if (getRuleDisabled() != null)
            sb.append("RuleDisabled: " + getRuleDisabled() + ",");
        if (getAwsIotSqlVersion() != null)
            sb.append("AwsIotSqlVersion: " + getAwsIotSqlVersion());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof TopicRule == false)
            return false;
        TopicRule other = (TopicRule) obj;
        if (other.getRuleName() == null ^ this.getRuleName() == null)
            return false;
        if (other.getRuleName() != null
                && other.getRuleName().equals(this.getRuleName()) == false)
            return false;
        if (other.getSql() == null ^ this.getSql() == null)
            return false;
        if (other.getSql() != null
                && other.getSql().equals(this.getSql()) == false)
            return false;
        if (other.getDescription() == null ^ this.getDescription() == null)
            return false;
        if (other.getDescription() != null
                && other.getDescription().equals(this.getDescription()) == false)
            return false;
        if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
            return false;
        if (other.getCreatedAt() != null
                && other.getCreatedAt().equals(this.getCreatedAt()) == false)
            return false;
        if (other.getActions() == null ^ this.getActions() == null)
            return false;
        if (other.getActions() != null
                && other.getActions().equals(this.getActions()) == false)
            return false;
        if (other.getRuleDisabled() == null ^ this.getRuleDisabled() == null)
            return false;
        if (other.getRuleDisabled() != null
                && other.getRuleDisabled().equals(this.getRuleDisabled()) == false)
            return false;
        if (other.getAwsIotSqlVersion() == null
                ^ this.getAwsIotSqlVersion() == null)
            return false;
        if (other.getAwsIotSqlVersion() != null
                && other.getAwsIotSqlVersion().equals(
                        this.getAwsIotSqlVersion()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getRuleName() == null) ? 0 : getRuleName().hashCode());
        hashCode = prime * hashCode
                + ((getSql() == null) ? 0 : getSql().hashCode());
        hashCode = prime
                * hashCode
                + ((getDescription() == null) ? 0 : getDescription().hashCode());
        hashCode = prime * hashCode
                + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
        hashCode = prime * hashCode
                + ((getActions() == null) ? 0 : getActions().hashCode());
        hashCode = prime
                * hashCode
                + ((getRuleDisabled() == null) ? 0 : getRuleDisabled()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getAwsIotSqlVersion() == null) ? 0 : getAwsIotSqlVersion()
                        .hashCode());
        return hashCode;
    }
    @Override
    public TopicRule clone() {
        try {
            return (TopicRule) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}