org.eclipse.ditto.connectivity.model.Measurement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ditto-connectivity-model Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

The newest version!

/*
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.connectivity.model;

import java.time.Duration;
import java.time.Instant;
import java.util.Map;
import java.util.Optional;

import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonField;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonFieldSelector;
import org.eclipse.ditto.json.JsonObject;

/**
 * Represent a measurement of a value for multiple time intervals.
 */
public interface Measurement extends Jsonifiable.WithFieldSelectorAndPredicate {

    /**
     * @return the type of the measurement e.g. "consumed" or "mapped"
     */
    MetricType getMetricType();

    /**
     * @return if the measurement represents a successful operation or a failure
     */
    boolean isSuccess();

    /**
     * @return the actual counter values for different intervals
     */
    Map getCounts();

    /**
     * @return last instant when the counter was updated - if ever
     */
    Optional getLastMessageAt();

    /**
     * Returns all non-hidden marked fields of this {@code AddressMetric}.
     *
     * @return a JSON object representation of this Source including only non-hidden marked fields.
     */
    @Override
    default JsonObject toJson() {
        return toJson(FieldType.notHidden());
    }

    @Override
    default JsonObject toJson(final JsonSchemaVersion schemaVersion, final JsonFieldSelector fieldSelector) {
        return toJson(schemaVersion, FieldType.notHidden()).get(fieldSelector);
    }

    /**
     * An enumeration of the known {@code JsonField}s of an {@code Measurement}.
     */
    @Immutable
    final class JsonFields {

        /**
         * JSON field containing the timestamp when the last message was consumed/published.
         */
        public static final JsonFieldDefinition LAST_MESSAGE_AT =
                JsonFactory.newStringFieldDefinition("lastMessageAt", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        JsonFields() {
            throw new AssertionError();
        }
    }

}