Jenis parameter Job

Setiap entri dalam parameterDefinitions daftar template pekerjaan mendeklarasikan satu parameter pekerjaan. Setiap parameter memiliki a name dan atype, dan dapat memilikidescription, adefault, dan userInterface blok dengan alabel, agroupLabel, dan acontrol. Jenis menentukan nilai mana yang diterima parameter, bidang batasan mana yang didukungnya, dan yang mengontrol dialog pengiriman ditampilkan secara default. Template mengacu pada nilai sebagai{{Param.Name}}. Jenisnya adalah sebagai berikut.

Beberapa jenis merupakan bagian dari spesifikasi Open Job Description dasar. Sisanya ditambahkan oleh EXPR ekstensi, dan templat yang menggunakannya harus dicantumkan EXPR di dalamnyaextensions. Untuk definisi bidang demi bidang dari setiap jenis, lihat definisi parameter pekerjaan Open Job Description di situs web. GitHub

INT

Sebuah integer, sebagai angka atau string numerik. Kendala:allowedValues,,. minValue maxValue Kontrol:SPIN_BOX, atau DROPDOWN_LIST kapan allowedValues diatur.

FLOAT

Angka, sebagai angka atau string numerik. Kendala:allowedValues,,. minValue maxValue Kontrol:SPIN_BOX, atau DROPDOWN_LIST kapan allowedValues diatur. decimalsBidang menetapkan jumlah tempat desimal yang dapat diedit.

STRING

Sebuah string. Kendala:allowedValues,,. minLength maxLength Kontrol:LINE_EDIT, atau DROPDOWN_LIST kapan allowedValues diatur. Juga menerimaMULTILINE_EDIT, dan CHECK_BOX ketika allowedValues memegang true/false pasangan seperti["true", "false"].

PATH

Sebuah file atau jalur direktori. Aturan pemetaan jalur diterapkan pada nilai pada pekerja. Kendala:allowedValues,,,minLength,maxLength. objectType dataFlow Kontrol:CHOOSE_INPUT_FILE,CHOOSE_OUTPUT_FILE, atauCHOOSE_DIRECTORY, tergantung pada objectType dandataFlow.

BOOL(membutuhkanEXPR)

trueataufalse; angka 1 atau0; atau stringtrue,,,yes,on,1, false nooff, 0 dalam kasus surat apa pun. Tidak ada kendala. Kontrol:CHECK_BOX.

RANGE_EXPR(membutuhkanEXPR)

Ekspresi rentang bilangan bulat seperti"1-100","1-100:10", atau"1,3,5-9". Kendala:,. minLength maxLength Kontrol:LINE_EDIT.

LIST[STRING](membutuhkanEXPR)

Daftar string. Kendala: minLength dan maxLength untuk daftar;item.allowedValues,item.minLength, dan item.maxLength untuk setiap item. Kontrol:LINE_EDIT_LIST.

LIST[PATH](membutuhkanEXPR)

Daftar jalur. Aturan pemetaan jalur diterapkan untuk setiap nilai. Kendala: daftar dan item kendala, plus dan. LIST[STRING] objectType dataFlow Kontrol:CHOOSE_INPUT_FILE_LIST,CHOOSE_OUTPUT_FILE_LIST, atauCHOOSE_DIRECTORY_LIST, tergantung pada objectType dandataFlow.

LIST[INT], LIST[FLOAT] (membutuhkanEXPR)

Daftar angka. Kendala: minLength dan maxLength untuk daftar;item.allowedValues,item.minValue, dan item.maxValue untuk setiap item. Kontrol:SPIN_BOX_LIST.

LIST[BOOL](membutuhkanEXPR)

Daftar nilai boolean, masing-masing menerima nilai yang sama seperti. BOOL Kendala:,. minLength maxLength Kontrol:CHECK_BOX_LIST.

LIST[LIST[INT]](membutuhkanEXPR)

Daftar daftar integer, untuk masukan terstruktur seperti daftar kedekatan. Kendala: kendala bersarang. item Kontrol:HIDDEN; tidak ada kontrol visual untuk jenis ini.

Setiap jenis juga menerima HIDDEN sebagai kontrolnya, yang membuat parameter keluar dari dialog pengiriman. HIDDENTetapkan nilai yang disediakan pipa secara terprogram.

LIST[PATH]Tipe PATH dan membawa dua bidang tambahan. objectTypeadalah FILE atauDIRECTORY, dan dataFlow adalah INOUT,INOUT, atauNONE. Lampiran Job membaca bidang ini untuk menentukan jalur mana yang akan diunggah sebagai input dan mana yang harus diperhatikan untuk output. PATHParameter juga mendukung fileFilters dan fileFilterDefault untuk dialog file. Untuk informasi selengkapnya, lihat Elemen template Job untuk bundel pekerjaan.

Definisi berikut menunjukkan kotak centang, rentang bingkai, daftar nama kamera, dan daftar file input. Daftar template EXPR karena empat jenis terakhir memerlukannya.

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: []

Dalam template dengan EXPR ekstensi, setiap parameter memiliki tipe ekspresi yang cocok:int,float,string, pathbool,range_expr, ataulist[T]. Parameter RANGE_EXPR atau daftar dapat berupa parameter tugas secara langsung, sehingga setiap bingkai atau item menjadi tugas. range Untuk PATH danLIST[PATH], RawParam.Name adalah nilai seperti yang dikirimkan, sebagai string, sebelum pemetaan jalur.

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

Dua argumen terakhir adalah ekspresi. nullHasilnya tidak menambahkan argumen, dan hasil daftar menambahkan setiap item sebagai argumen terpisah. Untuk informasi selengkapnya, lihat Ekspresi dalam templat pekerjaan.

Untuk mengirimkan paket pekerjaan yang menggunakan jenis EXPR parameter, Deadline Cloud CLI dan dialog deadline bundle gui-submit pengiriman dan monitor Deadline Cloud harus merupakan versi yang mendukung ekstensi. Klien lama menolak template dengan jenis ini.