models.internal.QueryResult 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.List;
import java.util.Optional;

/**
 * Internal model interface for a query result.
 *
 * @param  The result value type.
 *
 * @author Ville Koskela (vkoskela at groupon dot com)
 */
public interface QueryResult {

    /**
     * The matching instances of {@code }.
     *
     * @return The matching instances of {@code }.
     */
    List values();

    /**
     * The total number of matching instances of {@code }. This may be greater than the number of instances of
     * {@code } returned.
     *
     * @return The total number of matching hosts.
     */
    long total();

    /**
     * The etag representing the current state of the repository for this query. This should always exclude the
     * pagination. Otherwise, the etag may be specific to the query or general to the data store.
     *
     * @return The Optional etag.
     */
    Optional etag();
}