ジョブパラメータタイプ

ジョブテンプレートparameterDefinitionsのリストの各エントリは、1 つのジョブパラメータを宣言します。すべてのパラメータには nameと がありtype、、description、 を持つuserInterfaceブロックdefault、、groupLabelおよび labelを持つことができますcontrol。タイプは、パラメータが受け入れる値、サポートする制約フィールド、および送信ダイアログがデフォルトで表示するコントロールを決定します。テンプレートは、値を として参照します{{Param.Name}}。タイプは次のとおりです。

一部のタイプは、基本的な Open Job Description 仕様の一部です。残りは EXPR拡張機能によって追加され、それらを使用するテンプレートは EXPRにリストする必要がありますextensions。各タイプのfield-by-field定義については、GitHub ウェブサイトの Open Job Description ジョブパラメータ定義を参照してください。

INT

数値または数値文字列としての整数。制約: allowedValues、minValue、maxValue。コントロール: SPIN_BOX、または DROPDOWN_LISTallowedValuesが設定されている場合。

FLOAT

数値、数値または数値文字列。制約: allowedValues、minValue、maxValue。コントロール: SPIN_BOX、または DROPDOWN_LISTallowedValuesが設定されている場合。decimals フィールドは、編集可能な小数点以下の桁数を設定します。

STRING

文字列。制約: allowedValues、minLength、maxLength。コントロール: LINE_EDIT、または DROPDOWN_LISTallowedValuesが設定されている場合。またMULTILINE_EDIT、 が などの true/false ペアallowedValuesを保持するCHECK_BOX場合、 と も受け入れます["true", "false"]。

PATH

ファイルまたはディレクトリパス。パスマッピングルールは、ワーカーの値に適用されます。制約: allowedValues、minLength、、maxLengthobjectType、dataFlow。コントロール: CHOOSE_INPUT_FILEおよび に応じてCHOOSE_OUTPUT_FILE、CHOOSE_DIRECTORY、、または objectType dataFlow。

BOOL ( が必要ですEXPR)

true または false、数字1または yes、0または文字列 true、、on、1falsenooff、、、 は任意の文字の大文字と小文字0です。制約はありません。コントロール: CHECK_BOX。

RANGE_EXPR ( が必要ですEXPR)

"1-100"、、 "1-100:10"などの整数範囲式"1,3,5-9"。制約: minLength、maxLength。コントロール: LINE_EDIT。

LIST[STRING] ( が必要ですEXPR)

文字列のリスト。制約: リストmaxLengthの場合は minLengthと item.allowedValues、各項目item.maxLengthの場合は 、item.minLength、 です。コントロール: LINE_EDIT_LIST。

LIST[PATH] ( が必要ですEXPR)

パスのリスト。パスマッピングルールは各値に適用されます。制約: のリストと項目の制約LIST[STRING]、プラス objectType および dataFlow。コントロール: CHOOSE_INPUT_FILE_LISTおよび に応じてCHOOSE_OUTPUT_FILE_LIST、CHOOSE_DIRECTORY_LIST、、または objectType dataFlow。

LIST[INT]、 LIST[FLOAT] ( が必要EXPR)

数値のリスト。制約: リストmaxLengthの場合は minLengthと 、各項目item.maxValueの場合は item.allowedValues、item.minValue、 です。コントロール: SPIN_BOX_LIST。

LIST[BOOL] ( が必要ですEXPR)

ブール値のリスト。それぞれが と同じ値を受け入れますBOOL。制約: minLength、maxLength。コントロール: CHECK_BOX_LIST。

LIST[LIST[INT]] ( が必要ですEXPR)

隣接リストなどの構造化入力の整数リストのリスト。制約: ネストされたitem制約。コントロール: HIDDEN。このタイプのビジュアルコントロールはありません。

すべてのタイプはコントロールHIDDENとして も受け入れ、 パラメータを送信ダイアログから遠ざけます。パイプラインがプログラムで提供する値HIDDENに を設定します。

PATH 型と LIST[PATH]型には 2 つの追加フィールドがあります。 objectTypeは FILEまたは でDIRECTORY、 dataFlowは IN、OUT、INOUT、または ですNONE。ジョブアタッチメントはこれらのフィールドを読み取って、入力としてアップロードするパスと出力を監視するパスを決定します。PATH パラメータは、ファイルダイアログfileFilterDefaultの fileFiltersおよび もサポートします。詳細については、「ジョブバンドルのジョブテンプレート要素」を参照してください。

次の定義は、チェックボックス、フレーム範囲、カメラ名のリスト、および入力ファイルのリストを示しています。テンプレートは、最後の 4 つのタイプで必要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 拡張子を持つテンプレートでは、各パラメータに一致する式タイプが int、、float、string、pathbool、range_expr、または ですlist[T]。RANGE_EXPR または list パラメータは、各フレームまたは項目がタスクになるように、タスクパラメータrangeの を直接指定できます。PATH および の場合LIST[PATH]、 RawParam.Nameはパスマッピングの前に文字列として送信される値です。

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 }}"

最後の 2 つの引数は式です。null 結果は引数を追加せず、リスト結果は各項目を個別の引数として追加します。詳細については、「ジョブテンプレートの式」を参照してください。

EXPR パラメータタイプを使用するジョブバンドルを送信するには、Deadline Cloud CLI と の送信ダイアログdeadline bundle gui-submit、および Deadline Cloud モニターが拡張機能をサポートするバージョンである必要があります。古いクライアントは、これらのタイプのテンプレートを拒否します。