main.java.com.cloudant.client.api.query.ExecutionStats Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudant-client Show documentation
Official Cloudant client for Java
There is a newer version: 2.20.1
/*
 * Copyright © 2017 IBM Corp. 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. 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 com.cloudant.client.api.query;

import com.google.gson.annotations.SerializedName;

public class ExecutionStats {

    @SerializedName("total_keys_examined")
    private final long totalKeysExamined;
    @SerializedName("total_docs_examined")
    private final long totalDocsExamined;
    @SerializedName("total_quorum_docs_examined")
    private final long totalQuorumDocsExamined;
    @SerializedName("results_returned")
    private final long resultsReturned;
    @SerializedName("execution_time_ms")
    private final double executionTimeMs;

    public ExecutionStats(long totalKeysExamined, long totalDocsExamined, long
            totalQuorumDocsExamined, long resultsReturned, long executionTimeMs) {
        this.totalKeysExamined = totalKeysExamined;
        this.totalDocsExamined = totalDocsExamined;
        this.totalQuorumDocsExamined = totalQuorumDocsExamined;
        this.resultsReturned = resultsReturned;
        this.executionTimeMs = executionTimeMs;
    }

    /**
     * @return
     * Number of index keys examined. Currently always 0.
     */
    public long getTotalKeysExamined() {
        return totalKeysExamined;
    }

    /**
     * @return
     * Number of documents fetched from the database / index, equivalent to using include_docs=true in a view. These may then be filtered in-memory to further narrow down the result set based on the selector.
     */
    public long getTotalDocsExamined() {
        return totalDocsExamined;
    }

    /**
     * @return
     * Number of documents fetched from the database using an out-of-band document fetch. This is only non-zero when read quorum > 1 is specified in the query parameters.
     */
    public long getTotalQuorumDocsExamined() {
        return totalQuorumDocsExamined;
    }

    /**
     * @return
     * Number of results returned from the query. Ideally this should not be significantly lower than the total documents / keys examined.
     */
    public long getResultsReturned() {
        return resultsReturned;
    }

    /**
     * @return
     * Total execution time in milliseconds as measured by the database.
     */
    public double getExecutionTimeMs() {
        return executionTimeMs;
    }

    @Override
    public String toString() {
        return "ExecutionStats{" +
                "totalKeysExamined=" + totalKeysExamined +
                ", totalDocsExamined=" + totalDocsExamined +
                ", totalQuorumDocsExamined=" + totalQuorumDocsExamined +
                ", resultsReturned=" + resultsReturned +
                ", executionTimeMs=" + executionTimeMs +
                '}';
    }
}