/*
 * Copyright 2020-2022 Equinix, Inc
 * Copyright 2014-2022 The Billing Project, LLC
 *
 * The Billing Project licenses this file to you 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 org.killbill.commons.health.api;

import java.util.Map;

public interface Result {

    boolean isHealthy();

    /**
     * Returns any additional message for the result, or {@code null} if the result has no
     * message.
     *
     * @return any additional message for the result, or {@code null}
     */
    String getMessage();

    /**
     * Returns any exception for the result, or {@code null} if the result has no exception.
     *
     * @return any exception for the result, or {@code null}
     */
    Throwable getError();

    /**
     * Returns the time when the result was created, in milliseconds since Epoch
     *
     * @return the time when the result was created
     */
    long getTime();

    Map<String, Object> getDetails();
}
