Class MediaWorkflowTask.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • type

        public MediaWorkflowTask.Builder type​(String type)
        The type of process to run at this task.

        Refers to the name of a MediaWorkflowTaskDeclaration.

        Parameters:
        type - the value to set
        Returns:
        this builder
      • version

        public MediaWorkflowTask.Builder version​(Long version)
        The version of the MediaWorkflowTaskDeclaration.
        Parameters:
        version - the value to set
        Returns:
        this builder
      • key

        public MediaWorkflowTask.Builder key​(String key)
        A unique identifier for this task within its workflow.

        Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.

        Parameters:
        key - the value to set
        Returns:
        this builder
      • prerequisites

        public MediaWorkflowTask.Builder prerequisites​(List<String> prerequisites)
        Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
        Parameters:
        prerequisites - the value to set
        Returns:
        this builder
      • enableParameterReference

        public MediaWorkflowTask.Builder enableParameterReference​(String enableParameterReference)
        Allows this task to be conditionally enabled.

        If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task’s workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.

        Parameters:
        enableParameterReference - the value to set
        Returns:
        this builder
      • enableWhenReferencedParameterEquals

        public MediaWorkflowTask.Builder enableWhenReferencedParameterEquals​(Map<String,​Object> enableWhenReferencedParameterEquals)
        Used in conjunction with enableParameterReference to conditionally enable a task.

        When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.

        Parameters:
        enableWhenReferencedParameterEquals - the value to set
        Returns:
        this builder
      • parameters

        public MediaWorkflowTask.Builder parameters​(Map<String,​Object> parameters)
        Data specifiying how this task is to be run.

        The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.

        Parameters:
        parameters - the value to set
        Returns:
        this builder