Pipeline parameter configuration
This page describes each field in the Add parameter dialog.
阅读时间2 分钟最后更新于 1 年前
Below are the fields present in the Add parameter dialog:
-
Name: A unique Name for the parameter which is referenceable by actions
-
Display name: A Display Name for the parameter that is displayed when triggering the pipeline, when configuring an automation, and in job details
-
Description: A Description for the parameter that explains what it’s used for so that users triggering the pipeline or configuring an automation understand how to use this parameter.
-
Type: The data type for the parameter. By defaults it selects 'String'. The following types are supported:
- 'Boolean' (example: True)
- 'Float' (example: 1.5)
- 'Integer' (example: 1)
- 'String' (example: Hello world!)
- 'Text' (a variation of String that provides a larger input field)
- 'Script' (a variation of String that provides a code input field)
- 'Url' (example: https://unity.com/)
- 'UUID' (example: 15fb34fa-495d-42f2-bd66-e61f97230ba7)
-
Allow multiple: Disabled by default. When enabled, the parameter is considered a list of the configured type. For example, if the type is set to 'String' and this field is enabled, then this parameter is a list of strings, such as,[“hello”,world”].
-
Required: Disabled by default. When enabled, the parameter is required and must be given a value at the time of triggering the pipeline. When disabled, the parameter is optional and does not need to be included when triggering the pipeline.
When you select ADVANCED PARAMETERS, the following fields appear:
-
Accepted values: This is an advanced parameter that defaults to being empty. You can use this field to restrict the values accepted by the parameter. These values are presented as a selectable dropdown input when running the pipeline or configuring an automation. The values defined here also impact which value can be selected as a Default value. The pipeline will fail to trigger if the parameter contains a value that is not included in the Accepted values field.
-
Default value: This is an advanced parameter that is empty by default. If you define a value in this field, then it's used by default to trigger the pipeline. You or an automation triggering the pipeline can still provide a different value.
警告
This product allows you to input developer defined data (such as custom inputs, metadata, and assets). You must not use the product to input or collect personal data, unless such information is specifically required or requested by Unity.