Class OpsDoc

java.lang.Object
io.nosqlbench.adapters.api.activityconfig.yaml.OpsDoc
All Implemented Interfaces:
Tagged, Iterable<OpsBlock>
public class OpsDoc extends Object implements Tagged, Iterable<OpsBlock>
OpsDoc creates a logical view of a RawOpsDoc doc that includes all inherited and overridden values for bindings, tags, and params.

  • Constructor Details

    • OpsDoc

      public OpsDoc(RawOpsDoc rawOpsDoc)

  • Method Details

    • getBlocks

      public List<OpsBlock> getBlocks()
      Returns:
      a usable list of blocks, including inherited bindings, params, and tags from the parent doc

    • getTags

      public Map<String,String> getTags()
      Specified by:
      getTags in interface Tagged
      Returns:
      a usable map of tags, including those inherited from the parent doc

    • getParams

      public Map<String,Object> getParams()
      Returns:
      a usable map of parameters, including those inherited from the parent doc

    • getBindings

      public Map<String,String> getBindings()
      Returns:
      a usable map of bindings, including those inherited from the parent doc

    • getName

      public String getName()
      Returns:
      the name of this block

    • getOpTemplates

      public List<OpTemplate> getOpTemplates()
      Returns:
      The list of all included op templates for all included block in this document, including the inherited and overridden values from this doc and the parent block.

    • iterator

      public Iterator<OpsBlock> iterator()
      Allow StmtsDoc to be used in iterable loops.
      Specified by:
      iterator in interface Iterable<OpsBlock>
      Returns:
      An iterator of OpsBlock

    • getScenarios

      public Scenarios getScenarios()

    • getDescription

      public String getDescription()