-
Notifications
You must be signed in to change notification settings - Fork 240
Expand file tree
/
Copy pathBuildInterfaces.ts
More file actions
4438 lines (4208 loc) · 101 KB
/
BuildInterfaces.ts
File metadata and controls
4438 lines (4208 loc) · 101 KB
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* ---------------------------------------------------------
* Copyright(C) Microsoft Corporation. All rights reserved.
* ---------------------------------------------------------
*
* ---------------------------------------------------------
* Generated file, DO NOT EDIT
* ---------------------------------------------------------
*/
"use strict";
import DistributedTaskCommonInterfaces = require("../interfaces/DistributedTaskCommonInterfaces");
import TFS_SourceControl_Contracts = require("../interfaces/TfvcInterfaces");
import TFS_TestManagement_Contracts = require("../interfaces/TestInterfaces");
import TfsCoreInterfaces = require("../interfaces/CoreInterfaces");
import VSSInterfaces = require("../interfaces/common/VSSInterfaces");
/**
* Represents a queue for running builds.
*/
export interface AgentPoolQueue {
_links?: any;
/**
* The ID of the queue.
*/
id?: number;
/**
* The name of the queue.
*/
name?: string;
/**
* The pool used by this queue.
*/
pool?: TaskAgentPoolReference;
/**
* The full http link to the resource.
*/
url?: string;
}
/**
* Represents a reference to an agent queue.
*/
export interface AgentPoolQueueReference extends ResourceReference {
/**
* The ID of the queue.
*/
id?: number;
}
/**
* Describes how a phase should run against an agent queue.
*/
export interface AgentPoolQueueTarget extends PhaseTarget {
/**
* Agent specification of the target.
*/
agentSpecification?: AgentSpecification;
/**
* Enables scripts and other processes launched while executing phase to access the OAuth token
*/
allowScriptsAuthAccessOption?: boolean;
demands?: Demand[];
/**
* The execution options.
*/
executionOptions?: AgentTargetExecutionOptions;
/**
* The queue.
*/
queue?: AgentPoolQueue;
}
/**
* Specification of the agent defined by the pool provider.
*/
export interface AgentSpecification {
/**
* Agent specification unique identifier.
*/
identifier?: string;
}
export enum AgentStatus {
/**
* Indicates that the build agent cannot be contacted.
*/
Unavailable = 0,
/**
* Indicates that the build agent is currently available.
*/
Available = 1,
/**
* Indicates that the build agent has taken itself offline.
*/
Offline = 2,
}
/**
* Additional options for running phases against an agent queue.
*/
export interface AgentTargetExecutionOptions {
/**
* Indicates the type of execution options.
*/
type?: number;
}
export interface ArtifactResource {
_links?: any;
/**
* Type-specific data about the artifact.
*/
data?: string;
/**
* A link to download the resource.
*/
downloadUrl?: string;
/**
* Type-specific properties of the artifact.
*/
properties?: { [key: string] : string; };
/**
* The type of the resource: File container, version control folder, UNC path, etc.
*/
type?: string;
/**
* The full http link to the resource.
*/
url?: string;
}
/**
* Represents an attachment to a build.
*/
export interface Attachment {
_links?: any;
/**
* The name of the attachment.
*/
name?: string;
}
export enum AuditAction {
Add = 1,
Update = 2,
Delete = 3,
}
/**
* Data representation of a build.
*/
export interface Build {
_links?: any;
/**
* The agent specification for the build.
*/
agentSpecification?: AgentSpecification;
/**
* Append Commit Message To BuildNumber in UI.
*/
appendCommitMessageToRunName?: boolean;
/**
* The build number/name of the build.
*/
buildNumber?: string;
/**
* The build number revision.
*/
buildNumberRevision?: number;
/**
* The build controller. This is only set if the definition type is Xaml.
*/
controller?: BuildController;
/**
* The definition associated with the build.
*/
definition?: DefinitionReference;
/**
* Indicates whether the build has been deleted.
*/
deleted?: boolean;
/**
* The identity of the process or person that deleted the build.
*/
deletedBy?: VSSInterfaces.IdentityRef;
/**
* The date the build was deleted.
*/
deletedDate?: Date;
/**
* The description of how the build was deleted.
*/
deletedReason?: string;
/**
* A list of demands that represents the agent capabilities required by this build.
*/
demands?: Demand[];
/**
* The time that the build was completed.
*/
finishTime?: Date;
/**
* The ID of the build.
*/
id?: number;
/**
* Indicates whether the build should be skipped by retention policies.
*/
keepForever?: boolean;
/**
* The identity representing the process or person that last changed the build.
*/
lastChangedBy?: VSSInterfaces.IdentityRef;
/**
* The date the build was last changed.
*/
lastChangedDate?: Date;
/**
* Information about the build logs.
*/
logs?: BuildLogReference;
/**
* The orchestration plan for the build.
*/
orchestrationPlan?: TaskOrchestrationPlanReference;
/**
* The parameters for the build.
*/
parameters?: string;
/**
* Orchestration plans associated with the build (build, cleanup)
*/
plans?: TaskOrchestrationPlanReference[];
/**
* Azure Pipelines does not support job priority. This field is deprecated.
*/
priority?: QueuePriority;
/**
* The team project.
*/
project?: TfsCoreInterfaces.TeamProjectReference;
properties?: any;
/**
* The quality of the xaml build (good, bad, etc.)
*/
quality?: string;
/**
* The queue. This is only set if the definition type is Build. WARNING: this field is deprecated and does not corresponds to the jobs queues.
*/
queue?: AgentPoolQueue;
/**
* Additional options for queueing the build.
*/
queueOptions?: QueueOptions;
/**
* The current position of the build in the queue.
*/
queuePosition?: number;
/**
* The time that the build was queued.
*/
queueTime?: Date;
/**
* The reason that the build was created.
*/
reason?: BuildReason;
/**
* The repository.
*/
repository?: BuildRepository;
/**
* The identity that queued the build.
*/
requestedBy?: VSSInterfaces.IdentityRef;
/**
* The identity on whose behalf the build was queued.
*/
requestedFor?: VSSInterfaces.IdentityRef;
/**
* The build result.
*/
result?: BuildResult;
/**
* Indicates whether the build is retained by a release.
*/
retainedByRelease?: boolean;
/**
* The source branch.
*/
sourceBranch?: string;
/**
* The source version.
*/
sourceVersion?: string;
/**
* The time that the build was started.
*/
startTime?: Date;
/**
* The status of the build.
*/
status?: BuildStatus;
tags?: string[];
/**
* Parameters to template expression evaluation
*/
templateParameters?: { [key: string] : string; };
/**
* The build that triggered this build via a Build completion trigger.
*/
triggeredByBuild?: Build;
/**
* Sourceprovider-specific information about what triggered the build
*/
triggerInfo?: { [key: string] : string; };
/**
* The URI of the build.
*/
uri?: string;
/**
* The REST URL of the build.
*/
url?: string;
validationResults?: BuildRequestValidationResult[];
}
export interface BuildAgent {
buildDirectory?: string;
controller?: XamlBuildControllerReference;
createdDate?: Date;
description?: string;
enabled?: boolean;
id?: number;
messageQueueUrl?: string;
name?: string;
reservedForBuild?: string;
server?: XamlBuildServerReference;
status?: AgentStatus;
statusMessage?: string;
updatedDate?: Date;
uri?: string;
url?: string;
}
export interface BuildAgentReference {
/**
* Id of the resource
*/
id?: number;
/**
* Name of the linked resource (definition name, controller name, etc.)
*/
name?: string;
/**
* Full http link to the resource
*/
url?: string;
}
/**
* Represents an artifact produced by a build.
*/
export interface BuildArtifact {
/**
* The artifact ID.
*/
id?: number;
/**
* The name of the artifact.
*/
name?: string;
/**
* The actual resource.
*/
resource?: ArtifactResource;
/**
* The artifact source, which will be the ID of the job that produced this artifact. If an artifact is associated with multiple sources, this points to the first source.
*/
source?: string;
}
/**
* Represents the desired scope of authorization for a build.
*/
export enum BuildAuthorizationScope {
/**
* The identity used should have build service account permissions scoped to the project collection. This is useful when resources for a single build are spread across multiple projects.
*/
ProjectCollection = 1,
/**
* The identity used should have build service account permissions scoped to the project in which the build definition resides. This is useful for isolation of build jobs to a particular team project to avoid any unintentional escalation of privilege attacks during a build.
*/
Project = 2,
}
/**
* Represents a build badge.
*/
export interface BuildBadge {
/**
* The ID of the build represented by this badge.
*/
buildId?: number;
/**
* A link to the SVG resource.
*/
imageUrl?: string;
}
export interface BuildCompletedEvent extends BuildUpdatedEvent {
/**
* Changes associated with a build used for build notifications
*/
changes?: Change[];
/**
* Pull request for the build used for build notifications
*/
pullRequest?: PullRequest;
/**
* Test results associated with a build used for build notifications
*/
testResults?: TFS_TestManagement_Contracts.AggregatedResultsAnalysis;
/**
* Timeline records associated with a build used for build notifications
*/
timelineRecords?: TimelineRecord[];
/**
* Work items associated with a build used for build notifications
*/
workItems?: TFS_SourceControl_Contracts.AssociatedWorkItem[];
}
/**
* Represents a build completion trigger.
*/
export interface BuildCompletionTrigger extends BuildTrigger {
branchFilters?: string[];
/**
* A reference to the definition that should trigger builds for this definition.
*/
definition?: DefinitionReference;
requiresSuccessfulBuild?: boolean;
}
export interface BuildController extends XamlBuildControllerReference {
_links?: any;
/**
* The date the controller was created.
*/
createdDate?: Date;
/**
* The description of the controller.
*/
description?: string;
/**
* Indicates whether the controller is enabled.
*/
enabled?: boolean;
/**
* The status of the controller.
*/
status?: ControllerStatus;
/**
* The date the controller was last updated.
*/
updatedDate?: Date;
/**
* The controller's URI.
*/
uri?: string;
}
/**
* Represents a build definition.
*/
export interface BuildDefinition extends BuildDefinitionReference {
/**
* Indicates whether badges are enabled for this definition.
*/
badgeEnabled?: boolean;
/**
* The build number format.
*/
buildNumberFormat?: string;
/**
* A save-time comment for the definition.
*/
comment?: string;
demands?: Demand[];
/**
* The description.
*/
description?: string;
/**
* The drop location for the definition.
*/
dropLocation?: string;
/**
* The job authorization scope for builds queued against this definition.
*/
jobAuthorizationScope?: BuildAuthorizationScope;
/**
* The job cancel timeout (in minutes) for builds cancelled by user for this definition.
*/
jobCancelTimeoutInMinutes?: number;
/**
* The job execution timeout (in minutes) for builds queued against this definition.
*/
jobTimeoutInMinutes?: number;
options?: BuildOption[];
/**
* The build process.
*/
process?: BuildProcess;
/**
* The process parameters for this definition.
*/
processParameters?: DistributedTaskCommonInterfaces.ProcessParameters;
properties?: any;
/**
* The repository.
*/
repository?: BuildRepository;
retentionRules?: RetentionPolicy[];
tags?: string[];
triggers?: BuildTrigger[];
variableGroups?: VariableGroup[];
variables?: { [key: string] : BuildDefinitionVariable; };
}
/**
* For back-compat with extensions that use the old Steps format instead of Process and Phases
*/
export interface BuildDefinition3_2 extends BuildDefinitionReference3_2 {
/**
* Indicates whether badges are enabled for this definition
*/
badgeEnabled?: boolean;
build?: BuildDefinitionStep[];
/**
* The build number format
*/
buildNumberFormat?: string;
/**
* The comment entered when saving the definition
*/
comment?: string;
demands?: Demand[];
/**
* The description
*/
description?: string;
/**
* The drop location for the definition
*/
dropLocation?: string;
/**
* The job authorization scope for builds which are queued against this definition
*/
jobAuthorizationScope?: BuildAuthorizationScope;
/**
* The job cancel timeout in minutes for builds which are cancelled by user for this definition
*/
jobCancelTimeoutInMinutes?: number;
/**
* The job execution timeout in minutes for builds which are queued against this definition
*/
jobTimeoutInMinutes?: number;
latestBuild?: Build;
latestCompletedBuild?: Build;
options?: BuildOption[];
/**
* Process Parameters
*/
processParameters?: DistributedTaskCommonInterfaces.ProcessParameters;
properties?: any;
/**
* The repository
*/
repository?: BuildRepository;
retentionRules?: RetentionPolicy[];
tags?: string[];
triggers?: BuildTrigger[];
variables?: { [key: string] : BuildDefinitionVariable; };
}
/**
* Represents a reference to a build definition.
*/
export interface BuildDefinitionReference extends DefinitionReference {
_links?: any;
/**
* The author of the definition.
*/
authoredBy?: VSSInterfaces.IdentityRef;
/**
* A reference to the definition that this definition is a draft of, if this is a draft definition.
*/
draftOf?: DefinitionReference;
/**
* The list of drafts associated with this definition, if this is not a draft definition.
*/
drafts?: DefinitionReference[];
latestBuild?: Build;
latestCompletedBuild?: Build;
metrics?: BuildMetric[];
/**
* The quality of the definition document (draft, etc.)
*/
quality?: DefinitionQuality;
/**
* The default queue for builds run against this definition.
*/
queue?: AgentPoolQueue;
}
/**
* For back-compat with extensions that use the old Steps format instead of Process and Phases
*/
export interface BuildDefinitionReference3_2 extends DefinitionReference {
_links?: any;
/**
* The author of the definition.
*/
authoredBy?: VSSInterfaces.IdentityRef;
/**
* A reference to the definition that this definition is a draft of, if this is a draft definition.
*/
draftOf?: DefinitionReference;
/**
* The list of drafts associated with this definition, if this is not a draft definition.
*/
drafts?: DefinitionReference[];
metrics?: BuildMetric[];
/**
* The quality of the definition document (draft, etc.)
*/
quality?: DefinitionQuality;
/**
* The default queue for builds run against this definition.
*/
queue?: AgentPoolQueue;
}
/**
* Represents a revision of a build definition.
*/
export interface BuildDefinitionRevision {
/**
* The identity of the person or process that changed the definition.
*/
changedBy?: VSSInterfaces.IdentityRef;
/**
* The date and time that the definition was changed.
*/
changedDate?: Date;
/**
* The change type (add, edit, delete).
*/
changeType?: AuditAction;
/**
* The comment associated with the change.
*/
comment?: string;
/**
* A link to the definition at this revision.
*/
definitionUrl?: string;
/**
* The name of the definition.
*/
name?: string;
/**
* The revision number.
*/
revision?: number;
}
export interface BuildDefinitionSourceProvider {
/**
* Uri of the associated definition
*/
definitionUri?: string;
/**
* fields associated with this build definition
*/
fields?: { [key: string] : string; };
/**
* Id of this source provider
*/
id?: number;
/**
* The lst time this source provider was modified
*/
lastModified?: Date;
/**
* Name of the source provider
*/
name?: string;
/**
* Which trigger types are supported by this definition source provider
*/
supportedTriggerTypes?: DefinitionTriggerType;
}
/**
* Represents a step in a build phase.
*/
export interface BuildDefinitionStep {
/**
* Indicates whether this step should run even if a previous step fails.
*/
alwaysRun?: boolean;
/**
* A condition that determines whether this step should run.
*/
condition?: string;
/**
* Indicates whether the phase should continue even if this step fails.
*/
continueOnError?: boolean;
/**
* The display name for this step.
*/
displayName?: string;
/**
* Indicates whether the step is enabled.
*/
enabled?: boolean;
environment?: { [key: string] : string; };
inputs?: { [key: string] : string; };
/**
* The reference name for this step.
*/
refName?: string;
/**
* Number of retries.
*/
retryCountOnTaskFailure?: number;
/**
* The task associated with this step.
*/
task: TaskDefinitionReference;
/**
* The time, in minutes, that this step is allowed to run.
*/
timeoutInMinutes?: number;
}
/**
* Represents a template from which new build definitions can be created.
*/
export interface BuildDefinitionTemplate {
/**
* Indicates whether the template can be deleted.
*/
canDelete?: boolean;
/**
* The template category.
*/
category?: string;
/**
* An optional hosted agent queue for the template to use by default.
*/
defaultHostedQueue?: string;
/**
* A description of the template.
*/
description?: string;
icons?: { [key: string] : string; };
/**
* The ID of the task whose icon is used when showing this template in the UI.
*/
iconTaskId?: string;
/**
* The ID of the template.
*/
id: string;
/**
* The name of the template.
*/
name: string;
/**
* The actual template.
*/
template?: BuildDefinition;
}
/**
* For back-compat with extensions that use the old Steps format instead of Process and Phases
*/
export interface BuildDefinitionTemplate3_2 {
canDelete?: boolean;
category?: string;
defaultHostedQueue?: string;
description?: string;
icons?: { [key: string] : string; };
iconTaskId?: string;
id: string;
name: string;
template?: BuildDefinition3_2;
}
/**
* Represents a variable used by a build definition.
*/
export interface BuildDefinitionVariable {
/**
* Indicates whether the value can be set at queue time.
*/
allowOverride?: boolean;
/**
* Indicates whether the variable's value is a secret.
*/
isSecret?: boolean;
/**
* The value of the variable.
*/
value?: string;
}
export interface BuildDeletedEvent extends RealtimeBuildEvent {
build: Build;
}
export interface BuildDeployment {
deployment?: BuildSummary;
sourceBuild?: XamlBuildReference;
}
export interface BuildEvent {
data?: string[];
identifier?: string;
}
/**
* Represents a build log.
*/
export interface BuildLog extends BuildLogReference {
/**
* The date and time the log was created.
*/
createdOn?: Date;
/**
* The date and time the log was last changed.
*/
lastChangedOn?: Date;
/**
* The number of lines in the log.
*/
lineCount?: number;
}
/**
* Represents a reference to a build log.
*/
export interface BuildLogReference {
/**
* The ID of the log.
*/
id?: number;
/**
* The type of the log location.
*/
type?: string;
/**
* A full link to the log resource.
*/
url?: string;
}
/**
* Represents metadata about builds in the system.
*/
export interface BuildMetric {
/**
* The date for the scope.
*/
date?: Date;
/**
* The value.
*/
intValue?: number;
/**
* The name of the metric.
*/
name?: string;
/**
* The scope.
*/
scope?: string;
}
/**
* Represents the application of an optional behavior to a build definition.
*/
export interface BuildOption {
/**
* A reference to the build option.
*/
definition: BuildOptionDefinitionReference;
/**
* Indicates whether the behavior is enabled.
*/
enabled?: boolean;
inputs?: { [key: string] : string; };
}
/**
* Represents an optional behavior that can be applied to a build definition.
*/
export interface BuildOptionDefinition extends BuildOptionDefinitionReference {
/**
* The description.
*/
description?: string;
/**
* The list of input groups defined for the build option.
*/
groups?: BuildOptionGroupDefinition[];
/**
* The list of inputs defined for the build option.
*/
inputs?: BuildOptionInputDefinition[];
/**
* The name of the build option.
*/
name?: string;
/**
* A value that indicates the relative order in which the behavior should be applied.
*/
ordinal?: number;
}
/**
* Represents a reference to a build option definition.
*/
export interface BuildOptionDefinitionReference {
/**
* The ID of the referenced build option.
*/
id: string;
}
/**
* Represents a group of inputs for a build option.
*/
export interface BuildOptionGroupDefinition {
/**
* The name of the group to display in the UI.
*/
displayName?: string;
/**
* Indicates whether the group is initially displayed as expanded in the UI.
*/
isExpanded?: boolean;
/**
* The internal name of the group.
*/
name?: string;
}
/**
* Represents an input for a build option.
*/
export interface BuildOptionInputDefinition {
/**
* The default value.
*/
defaultValue?: string;
/**
* The name of the input group that this input belongs to.
*/
groupName?: string;
help?: { [key: string] : string; };
/**
* The label for the input.
*/
label?: string;
/**
* The name of the input.
*/
name?: string;
options?: { [key: string] : string; };
/**
* Indicates whether the input is required to have a value.
*/
required?: boolean;
/**
* Indicates the type of the input value.
*/
type?: BuildOptionInputType;
/**
* The rule that is applied to determine whether the input is visible in the UI.
*/
visibleRule?: string;
}