/
BuildOptionInputDefinition.yml
120 lines (120 loc) · 3.45 KB
/
BuildOptionInputDefinition.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
### YamlMime:TSType
name: BuildOptionInputDefinition
uid: azure-devops-extension-api.BuildOptionInputDefinition
package: azure-devops-extension-api
summary: Represents an input for a build option.
fullName: BuildOptionInputDefinition
remarks: ''
isDeprecated: false
type: interface
properties:
- name: defaultValue
uid: azure-devops-extension-api.BuildOptionInputDefinition.defaultValue
package: azure-devops-extension-api
summary: The default value.
fullName: defaultValue
remarks: ''
isDeprecated: false
syntax:
content: 'defaultValue: string'
return:
description: ''
type: string
- name: groupName
uid: azure-devops-extension-api.BuildOptionInputDefinition.groupName
package: azure-devops-extension-api
summary: The name of the input group that this input belongs to.
fullName: groupName
remarks: ''
isDeprecated: false
syntax:
content: 'groupName: string'
return:
description: ''
type: string
- name: help
uid: azure-devops-extension-api.BuildOptionInputDefinition.help
package: azure-devops-extension-api
summary: ''
fullName: help
remarks: ''
isDeprecated: false
syntax:
content: 'help: {[key: string]: string}'
return:
description: ''
type: '{[key: string]: string}'
- name: label
uid: azure-devops-extension-api.BuildOptionInputDefinition.label
package: azure-devops-extension-api
summary: The label for the input.
fullName: label
remarks: ''
isDeprecated: false
syntax:
content: 'label: string'
return:
description: ''
type: string
- name: name
uid: azure-devops-extension-api.BuildOptionInputDefinition.name
package: azure-devops-extension-api
summary: The name of the input.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: options
uid: azure-devops-extension-api.BuildOptionInputDefinition.options
package: azure-devops-extension-api
summary: ''
fullName: options
remarks: ''
isDeprecated: false
syntax:
content: 'options: {[key: string]: string}'
return:
description: ''
type: '{[key: string]: string}'
- name: required
uid: azure-devops-extension-api.BuildOptionInputDefinition.required
package: azure-devops-extension-api
summary: Indicates whether the input is required to have a value.
fullName: required
remarks: ''
isDeprecated: false
syntax:
content: 'required: boolean'
return:
description: ''
type: boolean
- name: type
uid: azure-devops-extension-api.BuildOptionInputDefinition.type
package: azure-devops-extension-api
summary: Indicates the type of the input value.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: BuildOptionInputType'
return:
description: ''
type: <xref uid="azure-devops-extension-api.BuildOptionInputType" />
- name: visibleRule
uid: azure-devops-extension-api.BuildOptionInputDefinition.visibleRule
package: azure-devops-extension-api
summary: >-
The rule that is applied to determine whether the input is visible in the
UI.
fullName: visibleRule
remarks: ''
isDeprecated: false
syntax:
content: 'visibleRule: string'
return:
description: ''
type: string