Job 参数类型

作业模板parameterDefinitions列表中的每个条目都声明了一个作业参数。每个参数都有 a name 和 atype，可以有 a description default、a 以及带有 a label、a 和 a groupLabel 的userInterface块control。类型决定了参数接受哪些值、它支持哪些约束字段，以及默认情况下为其显示的提交对话框的控件。模板将该值称为{{Param.Name}}。类型如下。

有些类型是基本的 Open Job Description 规范的一部分。其余的由EXPR扩展程序添加，使用它们的模板必须在其EXPR中列出extensions。有关每种类型的逐字段定义，请参阅网站上的 Open Job Description 职位参数定义。 GitHub

INT

一个整数，以数字或数字字符串的形式出现。限制：allowedValues、minValue、maxValue。控制:SPIN_BOX，或DROPDOWN_LIST何allowedValues时设置。

FLOAT

一个数字，以数字或数字字符串的形式出现。限制：allowedValues、minValue、maxValue。控制:SPIN_BOX，或DROPDOWN_LIST何allowedValues时设置。该decimals字段设置可编辑的小数位数。

STRING

一个字符串。限制：allowedValues、minLength、maxLength。控制:LINE_EDIT，或DROPDOWN_LIST何allowedValues时设置。也可以接受MULTILINE_EDIT，以及CHECK_BOX何时allowedValues持有一 true/false 对，例如["true", "false"]。

PATH

文件或目录路径。路径映射规则应用于工作器上的值。限制：allowedValues、minLength、maxLength、objectType、dataFlow。控制：CHOOSE_INPUT_FILECHOOSE_OUTPUT_FILE、或CHOOSE_DIRECTORY，取决于objectType和dataFlow。

BOOL（需要 EXPR）

true或false；数字1或0；或任何字母大小写的字符串trueyeson1false、no、off、、、、、0。没有限制。控制：CHECK_BOX。

RANGE_EXPR（需要 EXPR）

一个整数范围表达式"1-100"，例如"1-100:10"、或"1,3,5-9"。限制：minLength，maxLength。控制：LINE_EDIT。

LIST[STRING]（需要 EXPR）

字符串列表。约束条件：minLength以及maxLength针对列表；item.allowedValues、item.minLength、以及item.maxLength针对每个项目。控制：LINE_EDIT_LIST。

LIST[PATH]（需要 EXPR）

路径列表。路径映射规则适用于每个值。约束条件：列表和项目限制LIST[STRING]，加号objectType和dataFlow。控制：CHOOSE_INPUT_FILE_LISTCHOOSE_OUTPUT_FILE_LIST、或CHOOSE_DIRECTORY_LIST，取决于objectType和dataFlow。

LIST[INT]，LIST[FLOAT]（需要EXPR）

数字清单。约束条件：minLength以及maxLength针对列表；item.allowedValues、item.minValue、以及item.maxValue针对每个项目。控制：SPIN_BOX_LIST。

LIST[BOOL]（需要 EXPR）

布尔值列表，每个布尔值都接受与相同的值BOOL。限制：minLength，maxLength。控制：CHECK_BOX_LIST。

LIST[LIST[INT]]（需要 EXPR）

整数列表列表，用于结构化输入，例如邻接列表。约束：嵌套item约束。控制:HIDDEN; 这种类型没有视觉控制。

每种类型还接受HIDDEN作为其控件，这样可以将参数排除在提交对话框之外。HIDDEN为管道以编程方式提供的值进行设置。

PATH和LIST[PATH]类型带有两个额外的字段。 objectType是FILE或DIRECTORY，dataFlow是IN、OUT、INOUT、或NONE。Job 附件会读取这些字段，以决定将哪些路径作为输入上传，哪些路径需要监视输出。文件对话框还fileFilterDefault支持fileFilters和。PATH有关更多信息，请参阅 作业捆绑包的作业模板元素。

以下定义显示了复选框、帧范围、摄像机名称列表和输入文件列表。之EXPR所以列出模板，是因为最后四种类型需要它。

specificationVersion: 'jobtemplate-2023-09'
extensions:
  - EXPR
parameterDefinitions:
  - name: Samples
    type: INT
    default: 64
    minValue: 1
    maxValue: 4096
  - name: UseGpu
    type: BOOL
    default: false
    userInterface:
      label: Render on GPU
  - name: Frames
    type: RANGE_EXPR
    default: "1-100"
    userInterface:
      label: Frame Range
  - name: Cameras
    type: LIST[STRING]
    default: ["main", "closeup"]
    minLength: 1
    userInterface:
      label: Cameras to Render
  - name: Textures
    type: LIST[PATH]
    objectType: FILE
    dataFlow: IN
    default: []

在EXPR扩展名为的模板中，每个参数都有匹配的表达式类型：intfloat、string、path、bool、range_expr、或list[T]。RANGE_EXPR或列表参数可以直接作为任务参数，这样每个框架或项目就会变成一个任务。rangefo PATH r LIST[PATH] an RawParam.Name d，是路径映射之前提交的值，以字符串形式提交。

steps:
  - name: Render
    parameterSpace:
      taskParameterDefinitions:
        - name: Camera
          type: STRING
          range: "{{Param.Cameras}}"
        - name: Frame
          type: INT
          range: "{{Param.Frames}}"
    script:
      actions:
        onRun:
          command: render
          args:
            - "--camera"
            - "{{Task.Param.Camera}}"
            - "--frame"
            - "{{Task.Param.Frame}}"
            - "--samples"
            - "{{Param.Samples}}"
            - "{{ '--gpu' if Param.UseGpu else null }}"
            - "{{ ['--textures', Param.Textures.join(',')] if len(Param.Textures) > 0 else null }}"

最后两个参数是表达式。null结果不添加任何参数，列表结果将每个项目添加为单独的参数。有关更多信息，请参阅 作业模板中的表达式。

要提交使用EXPR参数类型的任务包，Deadline Cloud CLI 和中的提交对话框deadline bundle gui-submit以及 Deadline Cloud 监视器必须是支持该扩展的版本。较旧的客户会拒绝使用这些类型的模板。