apps/openstacktelemetry/api/src/main/java/org/onosproject/openstacktelemetry/api/TelemetryService.java

/*
 * Copyright 2018-present Open Networking Foundation
 *
 * 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 org.onosproject.openstacktelemetry.api;

/**
 * Service API for publishing openstack telemetry.
 */
public interface TelemetryService {

    /**
     * Telemetry service type.
     */
    enum ServiceType {
        /**
         * Indicates KAFKA telemetry service.
         */
        KAFKA,

        /**
         * Indicates GRPC telemetry service.
         */
        GRPC,

        /**
         * Indicates REST telemetry service.
         */
        REST,

        /**
         * Indicates InfluxDB telemetry service.
         */
        INFLUXDB,

        /**
         * Indicates prometheus telemetry service.
         */
        PROMETHEUS,

        /**
         * Indicates unknown telemetry service.
         */
        UNKNOWN
    }

    /**
     * Checks whether the telemetry service is running or not.
     *
     * @return telemetry service running status
     */
    boolean isRunning();

    /**
     * Obtains the service type.
     *
     * @return service type
     */
    ServiceType type();
}