Package io.littlehorse.sdk.wfsdk

Interface WfRunVariable

  • All Superinterfaces:
    java.io.Serializable
    public interface WfRunVariable
extends java.io.Serializable
    A WfRunVariable is a handle on a Variable in a WfSpec.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WfRunVariable jsonPath​(java.lang.String path)
      Valid only for output of the JSON_OBJ or JSON_ARR types.
      WfRunVariable required()
      Marks the variable as "Required", meaning that the ThreadSpec cannot be started without this variable being provided as input.
      WfRunVariable searchable()
      Marks the Variable as "Searchable", which: - Creates an Index on the Variable in the LH Data Store - Due to the fact that the Variable is now Searchable, all future WfSpec versions must use the same Type for this Variable.
      WfRunVariable searchableOn​(java.lang.String fieldPath, io.littlehorse.sdk.common.proto.VariableType fieldType)
      Marks the JSON_OBJ or JSON_ARR Variable as "Searchable", and creates an index on the specified field.
      WfRunVariable withAccessLevel​(io.littlehorse.sdk.common.proto.WfRunVariableAccessLevel accessLevel)
      Sets the access level of a WfRunVariable.

    • Method Detail

      • jsonPath

        WfRunVariable jsonPath​(java.lang.String path)
        Valid only for output of the JSON_OBJ or JSON_ARR types. Returns a new WfRunVariable handle which points to Json element referred to by the json path.

        Can only be called once--you can't call node.jsonPath().jsonPath().

        Parameters:
        path - is the json path to evaluate.
        Returns:
        a WfRunVariable.

      • required

        WfRunVariable required()
        Marks the variable as "Required", meaning that the ThreadSpec cannot be started without this variable being provided as input. For Entrypoint ThreadSpec's, this also triggers the WfSpec Required Variable Compatibiltiy Rules.
        Returns:

      • searchable

        WfRunVariable searchable()
        Marks the Variable as "Searchable", which: - Creates an Index on the Variable in the LH Data Store - Due to the fact that the Variable is now Searchable, all future WfSpec versions must use the same Type for this Variable.
        Returns:
        same WfRunVariable instance

      • searchableOn

        WfRunVariable searchableOn​(java.lang.String fieldPath,
                           io.littlehorse.sdk.common.proto.VariableType fieldType)
        Marks the JSON_OBJ or JSON_ARR Variable as "Searchable", and creates an index on the specified field.
        Parameters:
        fieldPath - is the JSON Path to the field that we are indexing.
        fieldType - is the type of the field we are indexing.
        Returns:
        same WfRunVariable instance

      • withAccessLevel

        WfRunVariable withAccessLevel​(io.littlehorse.sdk.common.proto.WfRunVariableAccessLevel accessLevel)
        Sets the access level of a WfRunVariable.
        Parameters:
        accessLevel - is the access level to set.
        Returns:
        this WfRunVariable.