org.camunda.bpm.engine.management.MetricIntervalValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha1

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.management;

import java.util.Date;

/**
 * Represents a metric which contains a name, reporter like the node,
 * timestamp and corresponding value.
 *
 * @author Christopher Zell 
 * @since 7.6.0
 */
public interface MetricIntervalValue {

  /**
   * Returns the name of the metric.
   *
   * @see constants in {@link Metrics} for a list of names which can be returned here
   *
   * @return the name of the metric
   */
  String getName();

  /**
   * Returns
   *        the reporter name of the metric, identifies the node which generates this metric.
   *        'null' when the metrics are aggregated by reporter.
   *
   * @return the reporter name
   */
  String getReporter();

  /**
   * Returns the timestamp as date object, on which the metric was created.
   *
   * @return the timestamp
   */
  Date getTimestamp();

  /**
   * Returns the value of the metric.
   *
   * @return the value
   */
  long getValue();
}