models.internal.ExpressionQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-portal_2.11 Show documentation
metrics-portal
There is a newer version: 0.9.2
/**
 * Copyright 2015 Groupon.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 models.internal;

import java.util.Optional;

/**
 * Internal model interface for an expression query.
 *
 * @author Ville Koskela (vkoskela at groupon dot com)
 */
public interface ExpressionQuery {

    /**
     * Set the text to query for. Optional. Defaults to no text.
     *
     * @param contains The text to match.
     * @return This instance of ExpressionQuery.
     */
    ExpressionQuery contains(final Optional contains);

    /**
     * Set the cluster to query for. Optional. Defaults to all clusters.
     *
     * @param cluster The cluster to match.
     * @return This instance of ExpressionQuery.
     */
    ExpressionQuery cluster(final Optional cluster);

    /**
     * Set the service to query for. Optional. Defaults to all services.
     *
     * @param service The service to match.
     * @return This instance of ExpressionQuery.
     */
    ExpressionQuery service(final Optional service);

    /**
     * The maximum number of expressions to return. Optional. Default is 1000.
     *
     * @param limit The maximum number of alerts to return.
     * @return This instance of ExpressionQuery.
     */
    ExpressionQuery limit(final int limit);

    /**
     * The offset into the result set. Optional. Default is not set.
     *
     * @param offset The offset into the result set.
     * @return This instance of ExpressionQuery.
     */
    ExpressionQuery offset(final Optional offset);

    /**
     * Execute the query and return the results.
     *
     * @return The results of the query as an {@code QueryResult} instance.
     */
    QueryResult execute();

    /**
     * Accessor for the contains.
     *
     * @return The contains.
     */
    Optional getContains();

    /**
     * Accessor for the cluster.
     *
     * @return The cluster.
     */
    Optional getCluster();

    /**
     * Accessor for the service.
     *
     * @return The service.
     */
    Optional getService();

    /**
     * Accessor for the limit.
     *
     * @return The limit.
     */
    int getLimit();

    /**
     * Accessor for the offset.
     *
     * @return The offset.
     */
    Optional getOffset();
}