NextGen UI documentation > Registry > Jobs > Define runtime parameters

Define runtime parameters¶

You can create and define runtime parameters to supply different values to scripts and tasks used by a custom job at runtime by including them in a metadata.yaml file, making your custom job easier to reuse. A template for this file is available from the Files > Create dropdown.

To define runtime parameters, you can add the following runtimeParameterDefinitions in metadata.yaml:

Key	Description
`fieldName`	Define the name of the runtime parameter.
`type`	Define the data type the runtime parameter contains: `string`, `boolean`, `numeric` `credential`, `deployment`.
`defaultValue`	(Optional) Set the default string value for the runtime parameter (the credential type doesn't support default values). If you define a runtime parameter without specifying a `defaultValue`, the default value is `None`.
`minValue`	(Optional) For `numeric` runtime parameters, set the minimum numeric value allowed in the runtime parameter.
`maxValue`	(Optional) For `numeric` runtime parameters, set the maximum numeric value allowed in the runtime parameter.
`credentialType`	(Optional) For `credential` runtime parameters, set the type of credentials the parameter must contain.
`allowEmpty`	(Optional) Set the empty field policy for the runtime parameter. `True`: (Default) Allows an empty runtime parameter. `False`: Enforces providing a value for the runtime parameter before deployment.
`description`	(Optional) Provide a description of the purpose or contents of the runtime parameter.

Example: metadata.yaml

name: runtime-parameter-example

runtimeParameterDefinitions:
- fieldName: my_first_runtime_parameter
  type: string
  description: My first runtime parameter.

- fieldName: runtime_parameter_with_default_value
  type: string
  defaultValue: Default
  description: A string-type runtime parameter with a default value.

- fieldName: runtime_parameter_boolean
  type: boolean
  defaultValue: true
  description: A boolean-type runtime parameter with a default value of true.

- fieldName: runtime_parameter_numeric
  type: numeric
  defaultValue: 0
  minValue: -100
  maxValue: 100
  description: A boolean-type runtime parameter with a default value of 0, a minimum value of -100, and a maximum value of 100.

- fieldName: runtime_parameter_for_credentials
  type: credential
  allowEmpty: false
  description: A runtime parameter containing a dictionary of credentials.

The credential runtime parameter type supports any credentialType value available in the DataRobot REST API. The credential information included depends on the credentialType, as shown in the examples below:

Note

For more information on the supported credential types, see the API reference documentation for credentials.

Credential Type	Example
`basic`	basic: credentialType: basic description: string name: string password: string user: string
`azure`	azure: credentialType: azure description: string name: string azureConnectionString: string
`gcp`	gcp: credentialType: gcp description: string name: string gcpKey: string
`s3`	s3: credentialType: s3 description: string name: string awsAccessKeyId: string awsSecretAccessKey: string awsSessionToken: string
`api_token`	api_token: credentialType: api_token apiToken: string name: string