com.amazonaws.services.kinesis.metrics.impl.ICWMetricsPublisher Maven / Gradle / Ivy

/*
 * Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Amazon Software License (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 * http://aws.amazon.com/asl/
 *
 * or in the "license" file accompanying this file. This file 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 com.amazonaws.services.kinesis.metrics.impl;

import java.util.List;

/**
 * An ICWMetricsPublisher is a publisher that contains the logic to publish metrics.
 * 
 * @param  is a class that stores information about a MetricDatum. This is useful when wanting
 *        to compare MetricDatums or aggregate similar MetricDatums.
 */

public interface ICWMetricsPublisher {

    /**
     * Given a list of MetricDatumWithKey, this method extracts the MetricDatum from each
     * MetricDatumWithKey and publishes those datums.
     * 
     * @param dataToPublish a list containing all the MetricDatums to publish
     */

    public void publishMetrics(List> dataToPublish);
}