Tipos de parámetros de trabajo

Cada entrada de la parameterDefinitions lista de una plantilla de trabajo declara un parámetro de trabajo. Cada parámetro tiene una name y atype, y puede tener una descriptiondefault, a y un userInterface bloque con alabel, a y acontrol. groupLabel El tipo determina qué valores acepta el parámetro, qué campos de restricción admite y qué controles muestra el cuadro de diálogo de envío de forma predeterminada. Una plantilla hace referencia al valor como{{Param.Name}}. Los tipos son los siguientes.

Algunos tipos forman parte de la especificación básica de Open Job Description. El resto lo añade la EXPR extensión, y la plantilla que los utilice debe figurar EXPR en la suyaextensions. Para ver la definición campo por campo de cada tipo, consulte las definiciones de parámetros de trabajo de Open Job Description en el sitio web. GitHub

INT

Un entero, como un número o una cadena numérica. Restricciones:allowedValues,minValue,maxValue. Control:SPIN_BOX, o DROPDOWN_LIST cuando allowedValues esté configurado.

FLOAT

Un número, como un número o una cadena numérica. Restricciones:allowedValues,minValue,maxValue. Control:SPIN_BOX, o DROPDOWN_LIST cuando allowedValues esté configurado. El decimals campo establece el número de decimales editables.

STRING

Una cadena. Restricciones:allowedValues,minLength,maxLength. Control:LINE_EDIT, o DROPDOWN_LIST cuando allowedValues esté configurado. También aceptaMULTILINE_EDIT, y CHECK_BOX cuando allowedValues sostiene un true/false par, como["true", "false"].

PATH

Una ruta de archivo o directorio. Las reglas de mapeo de rutas se aplican al valor del trabajador. Restricciones: allowedValuesminLength,maxLength,,objectType,dataFlow. Control:CHOOSE_INPUT_FILE,CHOOSE_OUTPUT_FILE, oCHOOSE_DIRECTORY, según objectType ydataFlow.

BOOL(requiereEXPR)

trueofalse; los números 1 o0; o las cadenastrue,,yes,on,1, false nooff, 0 en mayúsculas y minúsculas. Sin restricciones. Control:CHECK_BOX.

RANGE_EXPR(requiereEXPR)

Una expresión de rango de enteros como "1-100""1-100:10", o"1,3,5-9". Restricciones:minLength,maxLength. Control:LINE_EDIT.

LIST[STRING](requiereEXPR)

Una lista de cadenas. Restricciones: minLength y maxLength para la lista; item.allowedValuesitem.minLength, y item.maxLength para cada elemento. Control:LINE_EDIT_LIST.

LIST[PATH](requiereEXPR)

Una lista de rutas. Las reglas de mapeo de rutas se aplican a cada valor. Restricciones: las restricciones de lista y elemento deLIST[STRING], más objectType ydataFlow. Control: CHOOSE_INPUT_FILE_LISTCHOOSE_OUTPUT_FILE_LIST, oCHOOSE_DIRECTORY_LIST, según objectType ydataFlow.

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

Una lista de números. Restricciones: minLength y maxLength para la lista; item.allowedValuesitem.minValue, y item.maxValue para cada elemento. Control:SPIN_BOX_LIST.

LIST[BOOL](requiereEXPR)

Una lista de valores booleanos, cada uno de los cuales acepta los mismos valores que. BOOL Restricciones:minLength,. maxLength Control:CHECK_BOX_LIST.

LIST[LIST[INT]](requiereEXPR)

Una lista de listas de enteros, para entradas estructuradas, como una lista de adyacencias. Restricciones: restricciones anidadasitem. Control: HIDDEN no hay control visual para este tipo.

Todos los tipos también HIDDEN lo aceptan como control, lo que impide que el parámetro aparezca en el cuadro de diálogo de envío. HIDDENEstablézcalos para los valores que una canalización proporciona mediante programación.

Los LIST[PATH] tipos PATH y contienen dos campos adicionales. objectTypees FILE oDIRECTORY, y dataFlow es INOUT,INOUT, oNONE. Los adjuntos de trabajo leen estos campos para decidir qué rutas cargar como entradas y cuáles observar en busca de salidas. Un PATH parámetro también admite fileFilters y fileFilterDefault para el cuadro de diálogo del archivo. Para obtener más información, consulte Elementos de plantillas de trabajo para paquetes de trabajos.

Las siguientes definiciones muestran una casilla de verificación, un rango de fotogramas, una lista de nombres de cámaras y una lista de archivos de entrada. La plantilla se muestra EXPR porque los cuatro últimos tipos así lo requieren.

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

En una plantilla con la EXPR extensión, cada parámetro tiene un tipo de expresión coincidente: int floatstring,path,bool,range_expr, olist[T]. Un parámetro RANGE_EXPR o un parámetro de lista puede ser directamente el parámetro range de una tarea, de modo que cada marco o elemento se convierte en una tarea. Para PATH yLIST[PATH], RawParam.Name es el valor tal como se envió, en forma de cadena, antes del mapeo de rutas.

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

Los dos últimos argumentos son expresiones. Un null resultado no agrega ningún argumento y un resultado de lista agrega cada elemento como un argumento independiente. Para obtener más información, consulte Expresiones en las plantillas de trabajo.

Para enviar un paquete de trabajos que utilice los tipos de EXPR parámetros, la CLI de Deadline Cloud y el cuadro de diálogo de envío deadline bundle gui-submit y el monitor de Deadline Cloud deben ser una versión que admita la extensión. Los clientes más antiguos rechazan las plantillas con estos tipos.