io.nosqlbench.nb.api.annotations.Annotator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of driver-cql-shaded Show documentation

A Shaded CQL ActivityType driver for http://nosqlbench.io/

There is a newer version: 4.15.102

package io.nosqlbench.nb.api.annotations;

/**
 * An implementation of this type is responsible for taking annotation details and
 * logging them in a useful place.
 */
public interface Annotator {

    /**
     * Submit an annotation to some type of annotation store, logging or eventing mechanism.
     * Implementations of this service are responsible for mapping the scenario and labels
     * into appropriate key data, and the details in to a native payload. The least surprising
     * and most obvious mapping should be used in each case.
     *
     * For details on constructing a useful annotation to submit to this service, see {@link Annotation#newBuilder()}
     */
    void recordAnnotation(Annotation annotation);

}