admin.indicators.Indicator.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2023 e-voyageurs technologies
 *
 * 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 ai.tock.bot.admin.indicators

import org.litote.kmongo.Id
import org.litote.kmongo.newId

/**
 * Indicator data class
 * @param _id optional because autogenerated
 * @param name mandatory indicator name
 * @param label mandatory indicator label
 * @param description optional description
 * @param botId the application name
 * @param dimensions mandatory indicator dimensions
 * @param values set of [IndicatorValue]
 */
data class Indicator(
    val _id: Id = newId(),
    val name: String,
    val label: String,
    val description: String? = null,
    val botId: String,
    val dimensions: Set = mutableSetOf(),
    val values: Set
)