Package com.variant.share.schema

Interface Schema

public interface Schema
Representation of a experiment schema. The top-level object encapsulating a deployable schema document.
Since:
0.5

  • Method Details

    • getName

      String getName()
      The schema's name. Specified in the required /name key.
      Since:
      0.9

    • getDescription

      Optional<String> getDescription()
      The schema's description. Specified in the optional /description key.
      Since:
      0.9

    • getHooks

      List<SchemaHook> getHooks()
      List of schema-scoped lifecycle hooks. Specified in the optional /hooks key.
      Since:
      0.9

    • getFlusher

      Optional<EventFlusher> getFlusher()
      This schema's trace event flusher. Specified in the optional /flusher key. If no flusher is specified in the schema, this method will return an empty Optional, and a configurable server-wide default is used at run time.
      Since:
      0.9

    • getStates

      List<State> getStates()
      This schema's states. Specified in the required /states key.
      Returns:
      An immutable list of State objects in ordinal order.
      Since:
      0.5

    • getState

      Optional<State> getState(String name)
      Get a state by its name.
      Returns:
      An Optional, containing the state with the given name, if exists, or empty if no such state is present in the schema.
      Since:
      0.5

    • getExperiments

      List<Experiment> getExperiments()
      This schema's experiments. Specified in the required /experiments key.
      Returns:
      An immutable list of Experiment objects in ordinal order.
      Since:
      0.5

    • getExperiment

      Optional<Experiment> getExperiment(String name)
      Get a experiment by its name.
      Returns:
      An Optional, containing the experiment with the given name, if exists, or empty if no such experiment is present in the schema.
      Since:
      0.5