io.nosqlbench.engine.api.activityconfig.yaml.OpTemplate Maven / Gradle / Ivy

Go to download

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

The engine API for nosqlbench; Provides the interfaces needed to build internal modules for the nosqlbench core engine

There is a newer version: 5.17.0

package io.nosqlbench.engine.api.activityconfig.yaml;

import io.nosqlbench.engine.api.activityconfig.ParsedStmt;
import io.nosqlbench.engine.api.util.Tagged;

import java.util.Map;
import java.util.Optional;

public interface OpTemplate extends Tagged {

    String getName();

    String getStmt();

    Map getBindings();

    Map getParams();

     Map getParamsAsValueType(Class type);

    @SuppressWarnings("unchecked")
     V getParamOrDefault(String name, V defaultValue);

     V getParam(String name, Class type);

    @SuppressWarnings("unchecked")
     Optional getOptionalStringParam(String name, Class type);

    Optional getOptionalStringParam(String name);

    Map getTags();

    /**
     * Parse the statement for anchors and return a richer view of the StmtDef which
     * is simpler to use for most statement configuration needs.
     * @return a new {@link ParsedStmt}
     */
    ParsedStmt getParsed();

    String getDesc();
}