github.com/argoproj/argo-events@v1.9.1/api/sensor.md (about) 1 <p> 2 Packages: 3 </p> 4 <ul> 5 <li> 6 <a href="#argoproj.io%2fv1alpha1">argoproj.io/v1alpha1</a> 7 </li> 8 </ul> 9 <h2 id="argoproj.io/v1alpha1"> 10 argoproj.io/v1alpha1 11 </h2> 12 <p> 13 <p> 14 Package v1alpha1 is the v1alpha1 version of the API. 15 </p> 16 </p> 17 Resource Types: 18 <ul> 19 </ul> 20 <h3 id="argoproj.io/v1alpha1.AWSLambdaTrigger"> 21 AWSLambdaTrigger 22 </h3> 23 <p> 24 (<em>Appears on:</em> 25 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 26 </p> 27 <p> 28 <p> 29 AWSLambdaTrigger refers to specification of the trigger to invoke an AWS 30 Lambda function 31 </p> 32 </p> 33 <table> 34 <thead> 35 <tr> 36 <th> 37 Field 38 </th> 39 <th> 40 Description 41 </th> 42 </tr> 43 </thead> 44 <tbody> 45 <tr> 46 <td> 47 <code>functionName</code></br> <em> string </em> 48 </td> 49 <td> 50 <p> 51 FunctionName refers to the name of the function to invoke. 52 </p> 53 </td> 54 </tr> 55 <tr> 56 <td> 57 <code>accessKey</code></br> <em> 58 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 59 Kubernetes core/v1.SecretKeySelector </a> </em> 60 </td> 61 <td> 62 <em>(Optional)</em> 63 <p> 64 AccessKey refers K8s secret containing aws access key 65 </p> 66 </td> 67 </tr> 68 <tr> 69 <td> 70 <code>secretKey</code></br> <em> 71 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 72 Kubernetes core/v1.SecretKeySelector </a> </em> 73 </td> 74 <td> 75 <em>(Optional)</em> 76 <p> 77 SecretKey refers K8s secret containing aws secret key 78 </p> 79 </td> 80 </tr> 81 <tr> 82 <td> 83 <code>region</code></br> <em> string </em> 84 </td> 85 <td> 86 <p> 87 Region is AWS region 88 </p> 89 </td> 90 </tr> 91 <tr> 92 <td> 93 <code>payload</code></br> <em> 94 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 95 </a> </em> 96 </td> 97 <td> 98 <p> 99 Payload is the list of key-value extracted from an event payload to 100 construct the request payload. 101 </p> 102 </td> 103 </tr> 104 <tr> 105 <td> 106 <code>parameters</code></br> <em> 107 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 108 </a> </em> 109 </td> 110 <td> 111 <em>(Optional)</em> 112 <p> 113 Parameters is the list of key-value extracted from event’s payload that 114 are applied to the trigger resource. 115 </p> 116 </td> 117 </tr> 118 <tr> 119 <td> 120 <code>invocationType</code></br> <em> string </em> 121 </td> 122 <td> 123 <em>(Optional)</em> 124 <p> 125 Choose from the following options. 126 </p> 127 <ul> 128 <li> 129 <p> 130 RequestResponse (default) - Invoke the function synchronously. Keep the 131 connection open until the function returns a response or times out. The 132 API response includes the function response and additional data. 133 </p> 134 </li> 135 <li> 136 <p> 137 Event - Invoke the function asynchronously. Send events that fail 138 multiple times to the function’s dead-letter queue (if it’s configured). 139 The API response only includes a status code. 140 </p> 141 </li> 142 <li> 143 <p> 144 DryRun - Validate parameter values and verify that the user or role has 145 permission to invoke the function. 146 </p> 147 </li> 148 </ul> 149 </td> 150 </tr> 151 <tr> 152 <td> 153 <code>roleARN</code></br> <em> string </em> 154 </td> 155 <td> 156 <em>(Optional)</em> 157 <p> 158 RoleARN is the Amazon Resource Name (ARN) of the role to assume. 159 </p> 160 </td> 161 </tr> 162 </tbody> 163 </table> 164 <h3 id="argoproj.io/v1alpha1.ArgoWorkflowOperation"> 165 ArgoWorkflowOperation (<code>string</code> alias) 166 </p> 167 </h3> 168 <p> 169 (<em>Appears on:</em> 170 <a href="#argoproj.io/v1alpha1.ArgoWorkflowTrigger">ArgoWorkflowTrigger</a>) 171 </p> 172 <p> 173 <p> 174 ArgoWorkflowOperation refers to the type of the operation performed on 175 the Argo Workflow 176 </p> 177 </p> 178 <h3 id="argoproj.io/v1alpha1.ArgoWorkflowTrigger"> 179 ArgoWorkflowTrigger 180 </h3> 181 <p> 182 (<em>Appears on:</em> 183 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 184 </p> 185 <p> 186 <p> 187 ArgoWorkflowTrigger is the trigger for the Argo Workflow 188 </p> 189 </p> 190 <table> 191 <thead> 192 <tr> 193 <th> 194 Field 195 </th> 196 <th> 197 Description 198 </th> 199 </tr> 200 </thead> 201 <tbody> 202 <tr> 203 <td> 204 <code>source</code></br> <em> 205 <a href="#argoproj.io/v1alpha1.ArtifactLocation"> ArtifactLocation </a> 206 </em> 207 </td> 208 <td> 209 <p> 210 Source of the K8s resource file(s) 211 </p> 212 </td> 213 </tr> 214 <tr> 215 <td> 216 <code>operation</code></br> <em> 217 <a href="#argoproj.io/v1alpha1.ArgoWorkflowOperation"> 218 ArgoWorkflowOperation </a> </em> 219 </td> 220 <td> 221 <em>(Optional)</em> 222 <p> 223 Operation refers to the type of operation performed on the argo workflow 224 resource. Default value is Submit. 225 </p> 226 </td> 227 </tr> 228 <tr> 229 <td> 230 <code>parameters</code></br> <em> 231 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 232 </a> </em> 233 </td> 234 <td> 235 <p> 236 Parameters is the list of parameters to pass to resolved Argo Workflow 237 object 238 </p> 239 </td> 240 </tr> 241 <tr> 242 <td> 243 <code>args</code></br> <em> \[\]string </em> 244 </td> 245 <td> 246 <p> 247 Args is the list of arguments to pass to the argo CLI 248 </p> 249 </td> 250 </tr> 251 </tbody> 252 </table> 253 <h3 id="argoproj.io/v1alpha1.ArtifactLocation"> 254 ArtifactLocation 255 </h3> 256 <p> 257 (<em>Appears on:</em> 258 <a href="#argoproj.io/v1alpha1.ArgoWorkflowTrigger">ArgoWorkflowTrigger</a>, 259 <a href="#argoproj.io/v1alpha1.StandardK8STrigger">StandardK8STrigger</a>) 260 </p> 261 <p> 262 <p> 263 ArtifactLocation describes the source location for an external artifact 264 </p> 265 </p> 266 <table> 267 <thead> 268 <tr> 269 <th> 270 Field 271 </th> 272 <th> 273 Description 274 </th> 275 </tr> 276 </thead> 277 <tbody> 278 <tr> 279 <td> 280 <code>s3</code></br> <em> 281 github.com/argoproj/argo-events/pkg/apis/common.S3Artifact </em> 282 </td> 283 <td> 284 <p> 285 S3 compliant artifact 286 </p> 287 </td> 288 </tr> 289 <tr> 290 <td> 291 <code>inline</code></br> <em> string </em> 292 </td> 293 <td> 294 <p> 295 Inline artifact is embedded in sensor spec as a string 296 </p> 297 </td> 298 </tr> 299 <tr> 300 <td> 301 <code>file</code></br> <em> 302 <a href="#argoproj.io/v1alpha1.FileArtifact"> FileArtifact </a> </em> 303 </td> 304 <td> 305 <p> 306 File artifact is artifact stored in a file 307 </p> 308 </td> 309 </tr> 310 <tr> 311 <td> 312 <code>url</code></br> <em> <a href="#argoproj.io/v1alpha1.URLArtifact"> 313 URLArtifact </a> </em> 314 </td> 315 <td> 316 <p> 317 URL to fetch the artifact from 318 </p> 319 </td> 320 </tr> 321 <tr> 322 <td> 323 <code>configmap</code></br> <em> 324 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#configmapkeyselector-v1-core"> 325 Kubernetes core/v1.ConfigMapKeySelector </a> </em> 326 </td> 327 <td> 328 <p> 329 Configmap that stores the artifact 330 </p> 331 </td> 332 </tr> 333 <tr> 334 <td> 335 <code>git</code></br> <em> <a href="#argoproj.io/v1alpha1.GitArtifact"> 336 GitArtifact </a> </em> 337 </td> 338 <td> 339 <p> 340 Git repository hosting the artifact 341 </p> 342 </td> 343 </tr> 344 <tr> 345 <td> 346 <code>resource</code></br> <em> 347 github.com/argoproj/argo-events/pkg/apis/common.Resource </em> 348 </td> 349 <td> 350 <p> 351 Resource is generic template for K8s resource 352 </p> 353 </td> 354 </tr> 355 </tbody> 356 </table> 357 <h3 id="argoproj.io/v1alpha1.AzureEventHubsTrigger"> 358 AzureEventHubsTrigger 359 </h3> 360 <p> 361 (<em>Appears on:</em> 362 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 363 </p> 364 <p> 365 <p> 366 AzureEventHubsTrigger refers to specification of the Azure Event Hubs 367 Trigger 368 </p> 369 </p> 370 <table> 371 <thead> 372 <tr> 373 <th> 374 Field 375 </th> 376 <th> 377 Description 378 </th> 379 </tr> 380 </thead> 381 <tbody> 382 <tr> 383 <td> 384 <code>fqdn</code></br> <em> string </em> 385 </td> 386 <td> 387 <p> 388 FQDN refers to the namespace dns of Azure Event Hubs to be used 389 i.e. <namespace>.servicebus.windows.net 390 </p> 391 </td> 392 </tr> 393 <tr> 394 <td> 395 <code>hubName</code></br> <em> string </em> 396 </td> 397 <td> 398 <p> 399 HubName refers to the Azure Event Hub to send events to 400 </p> 401 </td> 402 </tr> 403 <tr> 404 <td> 405 <code>sharedAccessKeyName</code></br> <em> 406 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 407 Kubernetes core/v1.SecretKeySelector </a> </em> 408 </td> 409 <td> 410 <p> 411 SharedAccessKeyName refers to the name of the Shared Access Key 412 </p> 413 </td> 414 </tr> 415 <tr> 416 <td> 417 <code>sharedAccessKey</code></br> <em> 418 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 419 Kubernetes core/v1.SecretKeySelector </a> </em> 420 </td> 421 <td> 422 <p> 423 SharedAccessKey refers to a K8s secret containing the primary key for 424 the 425 </p> 426 </td> 427 </tr> 428 <tr> 429 <td> 430 <code>payload</code></br> <em> 431 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 432 </a> </em> 433 </td> 434 <td> 435 <p> 436 Payload is the list of key-value extracted from an event payload to 437 construct the request payload. 438 </p> 439 </td> 440 </tr> 441 <tr> 442 <td> 443 <code>parameters</code></br> <em> 444 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 445 </a> </em> 446 </td> 447 <td> 448 <em>(Optional)</em> 449 <p> 450 Parameters is the list of key-value extracted from event’s payload that 451 are applied to the trigger resource. 452 </p> 453 </td> 454 </tr> 455 </tbody> 456 </table> 457 <h3 id="argoproj.io/v1alpha1.AzureServiceBusTrigger"> 458 AzureServiceBusTrigger 459 </h3> 460 <p> 461 (<em>Appears on:</em> 462 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 463 </p> 464 <p> 465 </p> 466 <table> 467 <thead> 468 <tr> 469 <th> 470 Field 471 </th> 472 <th> 473 Description 474 </th> 475 </tr> 476 </thead> 477 <tbody> 478 <tr> 479 <td> 480 <code>connectionString</code></br> <em> 481 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 482 Kubernetes core/v1.SecretKeySelector </a> </em> 483 </td> 484 <td> 485 <p> 486 ConnectionString is the connection string for the Azure Service Bus 487 </p> 488 </td> 489 </tr> 490 <tr> 491 <td> 492 <code>queueName</code></br> <em> string </em> 493 </td> 494 <td> 495 <p> 496 QueueName is the name of the Azure Service Bus Queue 497 </p> 498 </td> 499 </tr> 500 <tr> 501 <td> 502 <code>topicName</code></br> <em> string </em> 503 </td> 504 <td> 505 <p> 506 TopicName is the name of the Azure Service Bus Topic 507 </p> 508 </td> 509 </tr> 510 <tr> 511 <td> 512 <code>subscriptionName</code></br> <em> string </em> 513 </td> 514 <td> 515 <p> 516 SubscriptionName is the name of the Azure Service Bus Topic Subscription 517 </p> 518 </td> 519 </tr> 520 <tr> 521 <td> 522 <code>tls</code></br> <em> 523 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 524 </td> 525 <td> 526 <em>(Optional)</em> 527 <p> 528 TLS configuration for the service bus client 529 </p> 530 </td> 531 </tr> 532 <tr> 533 <td> 534 <code>payload</code></br> <em> 535 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 536 </a> </em> 537 </td> 538 <td> 539 <p> 540 Payload is the list of key-value extracted from an event payload to 541 construct the request payload. 542 </p> 543 </td> 544 </tr> 545 <tr> 546 <td> 547 <code>parameters</code></br> <em> 548 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 549 </a> </em> 550 </td> 551 <td> 552 <em>(Optional)</em> 553 <p> 554 Parameters is the list of key-value extracted from event’s payload that 555 are applied to the trigger resource. 556 </p> 557 </td> 558 </tr> 559 </tbody> 560 </table> 561 <h3 id="argoproj.io/v1alpha1.Comparator"> 562 Comparator (<code>string</code> alias) 563 </p> 564 </h3> 565 <p> 566 (<em>Appears on:</em> 567 <a href="#argoproj.io/v1alpha1.DataFilter">DataFilter</a>) 568 </p> 569 <p> 570 <p> 571 Comparator refers to the comparator operator for a data filter 572 </p> 573 </p> 574 <h3 id="argoproj.io/v1alpha1.ConditionsResetByTime"> 575 ConditionsResetByTime 576 </h3> 577 <p> 578 (<em>Appears on:</em> 579 <a href="#argoproj.io/v1alpha1.ConditionsResetCriteria">ConditionsResetCriteria</a>) 580 </p> 581 <p> 582 </p> 583 <table> 584 <thead> 585 <tr> 586 <th> 587 Field 588 </th> 589 <th> 590 Description 591 </th> 592 </tr> 593 </thead> 594 <tbody> 595 <tr> 596 <td> 597 <code>cron</code></br> <em> string </em> 598 </td> 599 <td> 600 <p> 601 Cron is a cron-like expression. For reference, see: 602 <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a> 603 </p> 604 </td> 605 </tr> 606 <tr> 607 <td> 608 <code>timezone</code></br> <em> string </em> 609 </td> 610 <td> 611 <em>(Optional)</em> 612 </td> 613 </tr> 614 </tbody> 615 </table> 616 <h3 id="argoproj.io/v1alpha1.ConditionsResetCriteria"> 617 ConditionsResetCriteria 618 </h3> 619 <p> 620 (<em>Appears on:</em> 621 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 622 </p> 623 <p> 624 </p> 625 <table> 626 <thead> 627 <tr> 628 <th> 629 Field 630 </th> 631 <th> 632 Description 633 </th> 634 </tr> 635 </thead> 636 <tbody> 637 <tr> 638 <td> 639 <code>byTime</code></br> <em> 640 <a href="#argoproj.io/v1alpha1.ConditionsResetByTime"> 641 ConditionsResetByTime </a> </em> 642 </td> 643 <td> 644 <p> 645 Schedule is a cron-like expression. For reference, see: 646 <a href="https://en.wikipedia.org/wiki/Cron">https://en.wikipedia.org/wiki/Cron</a> 647 </p> 648 </td> 649 </tr> 650 </tbody> 651 </table> 652 <h3 id="argoproj.io/v1alpha1.CustomTrigger"> 653 CustomTrigger 654 </h3> 655 <p> 656 (<em>Appears on:</em> 657 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 658 </p> 659 <p> 660 <p> 661 CustomTrigger refers to the specification of the custom trigger. 662 </p> 663 </p> 664 <table> 665 <thead> 666 <tr> 667 <th> 668 Field 669 </th> 670 <th> 671 Description 672 </th> 673 </tr> 674 </thead> 675 <tbody> 676 <tr> 677 <td> 678 <code>serverURL</code></br> <em> string </em> 679 </td> 680 <td> 681 <p> 682 ServerURL is the url of the gRPC server that executes custom trigger 683 </p> 684 </td> 685 </tr> 686 <tr> 687 <td> 688 <code>secure</code></br> <em> bool </em> 689 </td> 690 <td> 691 <p> 692 Secure refers to type of the connection between sensor to custom trigger 693 gRPC 694 </p> 695 </td> 696 </tr> 697 <tr> 698 <td> 699 <code>certSecret</code></br> <em> 700 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 701 Kubernetes core/v1.SecretKeySelector </a> </em> 702 </td> 703 <td> 704 <p> 705 CertSecret refers to the secret that contains cert for secure connection 706 between sensor and custom trigger gRPC server. 707 </p> 708 </td> 709 </tr> 710 <tr> 711 <td> 712 <code>serverNameOverride</code></br> <em> string </em> 713 </td> 714 <td> 715 <p> 716 ServerNameOverride for the secure connection between sensor and custom 717 trigger gRPC server. 718 </p> 719 </td> 720 </tr> 721 <tr> 722 <td> 723 <code>spec</code></br> <em> map\[string\]string </em> 724 </td> 725 <td> 726 <p> 727 Spec is the custom trigger resource specification that custom trigger 728 gRPC server knows how to interpret. 729 </p> 730 <br/> <br/> 731 <table> 732 </table> 733 </td> 734 </tr> 735 <tr> 736 <td> 737 <code>parameters</code></br> <em> 738 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 739 </a> </em> 740 </td> 741 <td> 742 <p> 743 Parameters is the list of parameters that is applied to resolved custom 744 trigger trigger object. 745 </p> 746 </td> 747 </tr> 748 <tr> 749 <td> 750 <code>payload</code></br> <em> 751 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 752 </a> </em> 753 </td> 754 <td> 755 <p> 756 Payload is the list of key-value extracted from an event payload to 757 construct the request payload. 758 </p> 759 </td> 760 </tr> 761 </tbody> 762 </table> 763 <h3 id="argoproj.io/v1alpha1.DataFilter"> 764 DataFilter 765 </h3> 766 <p> 767 (<em>Appears on:</em> 768 <a href="#argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter</a>) 769 </p> 770 <p> 771 <p> 772 DataFilter describes constraints and filters for event data Regular 773 Expressions are purposefully not a feature as they are overkill for our 774 uses here See Rob Pike’s Post: 775 <a href="https://commandcenter.blogspot.com/2011/08/regular-expressions-in-lexing-and.html">https://commandcenter.blogspot.com/2011/08/regular-expressions-in-lexing-and.html</a> 776 </p> 777 </p> 778 <table> 779 <thead> 780 <tr> 781 <th> 782 Field 783 </th> 784 <th> 785 Description 786 </th> 787 </tr> 788 </thead> 789 <tbody> 790 <tr> 791 <td> 792 <code>path</code></br> <em> string </em> 793 </td> 794 <td> 795 <p> 796 Path is the JSONPath of the event’s (JSON decoded) data key Path is a 797 series of keys separated by a dot. A key may contain wildcard characters 798 ‘\*’ and ‘?’. To access an array value use the index as the key. The dot 799 and wildcard characters can be escaped with ‘’. See 800 <a href="https://github.com/tidwall/gjson#path-syntax">https://github.com/tidwall/gjson#path-syntax</a> 801 for more information on how to use this. 802 </p> 803 </td> 804 </tr> 805 <tr> 806 <td> 807 <code>type</code></br> <em> <a href="#argoproj.io/v1alpha1.JSONType"> 808 JSONType </a> </em> 809 </td> 810 <td> 811 <p> 812 Type contains the JSON type of the data 813 </p> 814 </td> 815 </tr> 816 <tr> 817 <td> 818 <code>value</code></br> <em> \[\]string </em> 819 </td> 820 <td> 821 <p> 822 Value is the allowed string values for this key Booleans are passed 823 using strconv.ParseBool() Numbers are parsed using as float64 using 824 strconv.ParseFloat() Strings are taken as is Nils this value is ignored 825 </p> 826 </td> 827 </tr> 828 <tr> 829 <td> 830 <code>comparator</code></br> <em> 831 <a href="#argoproj.io/v1alpha1.Comparator"> Comparator </a> </em> 832 </td> 833 <td> 834 <p> 835 Comparator compares the event data with a user given value. Can be 836 “\>=”, “\>”, “=”, “!=”, “\<”, or “\<=”. Is optional, and if left blank 837 treated as equality “=”. 838 </p> 839 </td> 840 </tr> 841 <tr> 842 <td> 843 <code>template</code></br> <em> string </em> 844 </td> 845 <td> 846 <p> 847 Template is a go-template for extracting a string from the event’s data. 848 A Template is evaluated with provided path, type and value. The 849 templating follows the standard go-template syntax as well as sprig’s 850 extra functions. See 851 <a href="https://pkg.go.dev/text/template">https://pkg.go.dev/text/template</a> 852 and 853 <a href="https://masterminds.github.io/sprig/">https://masterminds.github.io/sprig/</a> 854 </p> 855 </td> 856 </tr> 857 </tbody> 858 </table> 859 <h3 id="argoproj.io/v1alpha1.EmailTrigger"> 860 EmailTrigger 861 </h3> 862 <p> 863 (<em>Appears on:</em> 864 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 865 </p> 866 <p> 867 <p> 868 EmailTrigger refers to the specification of the email notification 869 trigger. 870 </p> 871 </p> 872 <table> 873 <thead> 874 <tr> 875 <th> 876 Field 877 </th> 878 <th> 879 Description 880 </th> 881 </tr> 882 </thead> 883 <tbody> 884 <tr> 885 <td> 886 <code>parameters</code></br> <em> 887 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 888 </a> </em> 889 </td> 890 <td> 891 <em>(Optional)</em> 892 <p> 893 Parameters is the list of key-value extracted from event’s payload that 894 are applied to the trigger resource. 895 </p> 896 </td> 897 </tr> 898 <tr> 899 <td> 900 <code>username</code></br> <em> string </em> 901 </td> 902 <td> 903 <em>(Optional)</em> 904 <p> 905 Username refers to the username used to connect to the smtp server. 906 </p> 907 </td> 908 </tr> 909 <tr> 910 <td> 911 <code>smtpPassword</code></br> <em> 912 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 913 Kubernetes core/v1.SecretKeySelector </a> </em> 914 </td> 915 <td> 916 <em>(Optional)</em> 917 <p> 918 SMTPPassword refers to the Kubernetes secret that holds the smtp 919 password used to connect to smtp server. 920 </p> 921 </td> 922 </tr> 923 <tr> 924 <td> 925 <code>host</code></br> <em> string </em> 926 </td> 927 <td> 928 <p> 929 Host refers to the smtp host url to which email is send. 930 </p> 931 </td> 932 </tr> 933 <tr> 934 <td> 935 <code>port</code></br> <em> int32 </em> 936 </td> 937 <td> 938 <em>(Optional)</em> 939 <p> 940 Port refers to the smtp server port to which email is send. Defaults to 941 0. 942 </p> 943 </td> 944 </tr> 945 <tr> 946 <td> 947 <code>to</code></br> <em> \[\]string </em> 948 </td> 949 <td> 950 <em>(Optional)</em> 951 <p> 952 To refers to the email addresses to which the emails are send. 953 </p> 954 </td> 955 </tr> 956 <tr> 957 <td> 958 <code>from</code></br> <em> string </em> 959 </td> 960 <td> 961 <em>(Optional)</em> 962 <p> 963 From refers to the address from which the email is send from. 964 </p> 965 </td> 966 </tr> 967 <tr> 968 <td> 969 <code>subject</code></br> <em> string </em> 970 </td> 971 <td> 972 <em>(Optional)</em> 973 <p> 974 Subject refers to the subject line for the email send. 975 </p> 976 </td> 977 </tr> 978 <tr> 979 <td> 980 <code>body</code></br> <em> string </em> 981 </td> 982 <td> 983 <em>(Optional)</em> 984 <p> 985 Body refers to the body/content of the email send. 986 </p> 987 </td> 988 </tr> 989 </tbody> 990 </table> 991 <h3 id="argoproj.io/v1alpha1.Event"> 992 Event 993 </h3> 994 <p> 995 <p> 996 Event represents the cloudevent received from an event source. 997 </p> 998 </p> 999 <table> 1000 <thead> 1001 <tr> 1002 <th> 1003 Field 1004 </th> 1005 <th> 1006 Description 1007 </th> 1008 </tr> 1009 </thead> 1010 <tbody> 1011 <tr> 1012 <td> 1013 <code>context</code></br> <em> 1014 <a href="#argoproj.io/v1alpha1.EventContext"> EventContext </a> </em> 1015 </td> 1016 <td> 1017 </td> 1018 </tr> 1019 <tr> 1020 <td> 1021 <code>data</code></br> <em> \[\]byte </em> 1022 </td> 1023 <td> 1024 </td> 1025 </tr> 1026 </tbody> 1027 </table> 1028 <h3 id="argoproj.io/v1alpha1.EventContext"> 1029 EventContext 1030 </h3> 1031 <p> 1032 (<em>Appears on:</em> <a href="#argoproj.io/v1alpha1.Event">Event</a>, 1033 <a href="#argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter</a>) 1034 </p> 1035 <p> 1036 <p> 1037 EventContext holds the context of the cloudevent received from an event 1038 source. 1039 </p> 1040 </p> 1041 <table> 1042 <thead> 1043 <tr> 1044 <th> 1045 Field 1046 </th> 1047 <th> 1048 Description 1049 </th> 1050 </tr> 1051 </thead> 1052 <tbody> 1053 <tr> 1054 <td> 1055 <code>id</code></br> <em> string </em> 1056 </td> 1057 <td> 1058 <p> 1059 ID of the event; must be non-empty and unique within the scope of the 1060 producer. 1061 </p> 1062 </td> 1063 </tr> 1064 <tr> 1065 <td> 1066 <code>source</code></br> <em> string </em> 1067 </td> 1068 <td> 1069 <p> 1070 Source - A URI describing the event producer. 1071 </p> 1072 </td> 1073 </tr> 1074 <tr> 1075 <td> 1076 <code>specversion</code></br> <em> string </em> 1077 </td> 1078 <td> 1079 <p> 1080 SpecVersion - The version of the CloudEvents specification used by the 1081 event. 1082 </p> 1083 </td> 1084 </tr> 1085 <tr> 1086 <td> 1087 <code>type</code></br> <em> string </em> 1088 </td> 1089 <td> 1090 <p> 1091 Type - The type of the occurrence which has happened. 1092 </p> 1093 </td> 1094 </tr> 1095 <tr> 1096 <td> 1097 <code>datacontenttype</code></br> <em> string </em> 1098 </td> 1099 <td> 1100 <p> 1101 DataContentType - A MIME (RFC2046) string describing the media type of 1102 <code>data</code>. 1103 </p> 1104 </td> 1105 </tr> 1106 <tr> 1107 <td> 1108 <code>subject</code></br> <em> string </em> 1109 </td> 1110 <td> 1111 <p> 1112 Subject - The subject of the event in the context of the event producer 1113 </p> 1114 </td> 1115 </tr> 1116 <tr> 1117 <td> 1118 <code>time</code></br> <em> 1119 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#time-v1-meta"> 1120 Kubernetes meta/v1.Time </a> </em> 1121 </td> 1122 <td> 1123 <p> 1124 Time - A Timestamp when the event happened. 1125 </p> 1126 </td> 1127 </tr> 1128 </tbody> 1129 </table> 1130 <h3 id="argoproj.io/v1alpha1.EventDependency"> 1131 EventDependency 1132 </h3> 1133 <p> 1134 (<em>Appears on:</em> 1135 <a href="#argoproj.io/v1alpha1.SensorSpec">SensorSpec</a>) 1136 </p> 1137 <p> 1138 <p> 1139 EventDependency describes a dependency 1140 </p> 1141 </p> 1142 <table> 1143 <thead> 1144 <tr> 1145 <th> 1146 Field 1147 </th> 1148 <th> 1149 Description 1150 </th> 1151 </tr> 1152 </thead> 1153 <tbody> 1154 <tr> 1155 <td> 1156 <code>name</code></br> <em> string </em> 1157 </td> 1158 <td> 1159 <p> 1160 Name is a unique name of this dependency 1161 </p> 1162 </td> 1163 </tr> 1164 <tr> 1165 <td> 1166 <code>eventSourceName</code></br> <em> string </em> 1167 </td> 1168 <td> 1169 <p> 1170 EventSourceName is the name of EventSource that Sensor depends on 1171 </p> 1172 </td> 1173 </tr> 1174 <tr> 1175 <td> 1176 <code>eventName</code></br> <em> string </em> 1177 </td> 1178 <td> 1179 <p> 1180 EventName is the name of the event 1181 </p> 1182 </td> 1183 </tr> 1184 <tr> 1185 <td> 1186 <code>filters</code></br> <em> 1187 <a href="#argoproj.io/v1alpha1.EventDependencyFilter"> 1188 EventDependencyFilter </a> </em> 1189 </td> 1190 <td> 1191 <p> 1192 Filters and rules governing toleration of success and constraints on the 1193 context and data of an event 1194 </p> 1195 </td> 1196 </tr> 1197 <tr> 1198 <td> 1199 <code>transform</code></br> <em> 1200 <a href="#argoproj.io/v1alpha1.EventDependencyTransformer"> 1201 EventDependencyTransformer </a> </em> 1202 </td> 1203 <td> 1204 <p> 1205 Transform transforms the event data 1206 </p> 1207 </td> 1208 </tr> 1209 <tr> 1210 <td> 1211 <code>filtersLogicalOperator</code></br> <em> 1212 <a href="#argoproj.io/v1alpha1.LogicalOperator"> LogicalOperator </a> 1213 </em> 1214 </td> 1215 <td> 1216 <p> 1217 FiltersLogicalOperator defines how different filters are evaluated 1218 together. Available values: and (&&), or (\|\|) Is optional and if left 1219 blank treated as and (&&). 1220 </p> 1221 </td> 1222 </tr> 1223 </tbody> 1224 </table> 1225 <h3 id="argoproj.io/v1alpha1.EventDependencyFilter"> 1226 EventDependencyFilter 1227 </h3> 1228 <p> 1229 (<em>Appears on:</em> 1230 <a href="#argoproj.io/v1alpha1.EventDependency">EventDependency</a>) 1231 </p> 1232 <p> 1233 <p> 1234 EventDependencyFilter defines filters and constraints for a event. 1235 </p> 1236 </p> 1237 <table> 1238 <thead> 1239 <tr> 1240 <th> 1241 Field 1242 </th> 1243 <th> 1244 Description 1245 </th> 1246 </tr> 1247 </thead> 1248 <tbody> 1249 <tr> 1250 <td> 1251 <code>time</code></br> <em> <a href="#argoproj.io/v1alpha1.TimeFilter"> 1252 TimeFilter </a> </em> 1253 </td> 1254 <td> 1255 <p> 1256 Time filter on the event with escalation 1257 </p> 1258 </td> 1259 </tr> 1260 <tr> 1261 <td> 1262 <code>context</code></br> <em> 1263 <a href="#argoproj.io/v1alpha1.EventContext"> EventContext </a> </em> 1264 </td> 1265 <td> 1266 <p> 1267 Context filter constraints 1268 </p> 1269 </td> 1270 </tr> 1271 <tr> 1272 <td> 1273 <code>data</code></br> <em> <a href="#argoproj.io/v1alpha1.DataFilter"> 1274 \[\]DataFilter </a> </em> 1275 </td> 1276 <td> 1277 <p> 1278 Data filter constraints with escalation 1279 </p> 1280 </td> 1281 </tr> 1282 <tr> 1283 <td> 1284 <code>exprs</code></br> <em> <a href="#argoproj.io/v1alpha1.ExprFilter"> 1285 \[\]ExprFilter </a> </em> 1286 </td> 1287 <td> 1288 <p> 1289 Exprs contains the list of expressions evaluated against the event 1290 payload. 1291 </p> 1292 </td> 1293 </tr> 1294 <tr> 1295 <td> 1296 <code>dataLogicalOperator</code></br> <em> 1297 <a href="#argoproj.io/v1alpha1.LogicalOperator"> LogicalOperator </a> 1298 </em> 1299 </td> 1300 <td> 1301 <p> 1302 DataLogicalOperator defines how multiple Data filters (if defined) are 1303 evaluated together. Available values: and (&&), or (\|\|) Is optional 1304 and if left blank treated as and (&&). 1305 </p> 1306 </td> 1307 </tr> 1308 <tr> 1309 <td> 1310 <code>exprLogicalOperator</code></br> <em> 1311 <a href="#argoproj.io/v1alpha1.LogicalOperator"> LogicalOperator </a> 1312 </em> 1313 </td> 1314 <td> 1315 <p> 1316 ExprLogicalOperator defines how multiple Exprs filters (if defined) are 1317 evaluated together. Available values: and (&&), or (\|\|) Is optional 1318 and if left blank treated as and (&&). 1319 </p> 1320 </td> 1321 </tr> 1322 <tr> 1323 <td> 1324 <code>script</code></br> <em> string </em> 1325 </td> 1326 <td> 1327 <p> 1328 Script refers to a Lua script evaluated to determine the validity of an 1329 event. 1330 </p> 1331 </td> 1332 </tr> 1333 </tbody> 1334 </table> 1335 <h3 id="argoproj.io/v1alpha1.EventDependencyTransformer"> 1336 EventDependencyTransformer 1337 </h3> 1338 <p> 1339 (<em>Appears on:</em> 1340 <a href="#argoproj.io/v1alpha1.EventDependency">EventDependency</a>) 1341 </p> 1342 <p> 1343 <p> 1344 EventDependencyTransformer transforms the event 1345 </p> 1346 </p> 1347 <table> 1348 <thead> 1349 <tr> 1350 <th> 1351 Field 1352 </th> 1353 <th> 1354 Description 1355 </th> 1356 </tr> 1357 </thead> 1358 <tbody> 1359 <tr> 1360 <td> 1361 <code>jq</code></br> <em> string </em> 1362 </td> 1363 <td> 1364 <em>(Optional)</em> 1365 <p> 1366 JQ holds the jq command applied for transformation 1367 </p> 1368 </td> 1369 </tr> 1370 <tr> 1371 <td> 1372 <code>script</code></br> <em> string </em> 1373 </td> 1374 <td> 1375 <em>(Optional)</em> 1376 <p> 1377 Script refers to a Lua script used to transform the event 1378 </p> 1379 </td> 1380 </tr> 1381 </tbody> 1382 </table> 1383 <h3 id="argoproj.io/v1alpha1.ExprFilter"> 1384 ExprFilter 1385 </h3> 1386 <p> 1387 (<em>Appears on:</em> 1388 <a href="#argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter</a>) 1389 </p> 1390 <p> 1391 </p> 1392 <table> 1393 <thead> 1394 <tr> 1395 <th> 1396 Field 1397 </th> 1398 <th> 1399 Description 1400 </th> 1401 </tr> 1402 </thead> 1403 <tbody> 1404 <tr> 1405 <td> 1406 <code>expr</code></br> <em> string </em> 1407 </td> 1408 <td> 1409 <p> 1410 Expr refers to the expression that determines the outcome of the filter. 1411 </p> 1412 </td> 1413 </tr> 1414 <tr> 1415 <td> 1416 <code>fields</code></br> <em> 1417 <a href="#argoproj.io/v1alpha1.PayloadField"> \[\]PayloadField </a> 1418 </em> 1419 </td> 1420 <td> 1421 <p> 1422 Fields refers to set of keys that refer to the paths within event 1423 payload. 1424 </p> 1425 </td> 1426 </tr> 1427 </tbody> 1428 </table> 1429 <h3 id="argoproj.io/v1alpha1.FileArtifact"> 1430 FileArtifact 1431 </h3> 1432 <p> 1433 (<em>Appears on:</em> 1434 <a href="#argoproj.io/v1alpha1.ArtifactLocation">ArtifactLocation</a>) 1435 </p> 1436 <p> 1437 <p> 1438 FileArtifact contains information about an artifact in a filesystem 1439 </p> 1440 </p> 1441 <table> 1442 <thead> 1443 <tr> 1444 <th> 1445 Field 1446 </th> 1447 <th> 1448 Description 1449 </th> 1450 </tr> 1451 </thead> 1452 <tbody> 1453 <tr> 1454 <td> 1455 <code>path</code></br> <em> string </em> 1456 </td> 1457 <td> 1458 </td> 1459 </tr> 1460 </tbody> 1461 </table> 1462 <h3 id="argoproj.io/v1alpha1.GitArtifact"> 1463 GitArtifact 1464 </h3> 1465 <p> 1466 (<em>Appears on:</em> 1467 <a href="#argoproj.io/v1alpha1.ArtifactLocation">ArtifactLocation</a>) 1468 </p> 1469 <p> 1470 <p> 1471 GitArtifact contains information about an artifact stored in git 1472 </p> 1473 </p> 1474 <table> 1475 <thead> 1476 <tr> 1477 <th> 1478 Field 1479 </th> 1480 <th> 1481 Description 1482 </th> 1483 </tr> 1484 </thead> 1485 <tbody> 1486 <tr> 1487 <td> 1488 <code>url</code></br> <em> string </em> 1489 </td> 1490 <td> 1491 <p> 1492 Git URL 1493 </p> 1494 </td> 1495 </tr> 1496 <tr> 1497 <td> 1498 <code>cloneDirectory</code></br> <em> string </em> 1499 </td> 1500 <td> 1501 <p> 1502 Directory to clone the repository. We clone complete directory because 1503 GitArtifact is not limited to any specific Git service providers. Hence 1504 we don’t use any specific git provider client. 1505 </p> 1506 </td> 1507 </tr> 1508 <tr> 1509 <td> 1510 <code>creds</code></br> <em> <a href="#argoproj.io/v1alpha1.GitCreds"> 1511 GitCreds </a> </em> 1512 </td> 1513 <td> 1514 <em>(Optional)</em> 1515 <p> 1516 Creds contain reference to git username and password 1517 </p> 1518 </td> 1519 </tr> 1520 <tr> 1521 <td> 1522 <code>sshKeySecret</code></br> <em> 1523 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1524 Kubernetes core/v1.SecretKeySelector </a> </em> 1525 </td> 1526 <td> 1527 <p> 1528 SSHKeySecret refers to the secret that contains SSH key 1529 </p> 1530 </td> 1531 </tr> 1532 <tr> 1533 <td> 1534 <code>filePath</code></br> <em> string </em> 1535 </td> 1536 <td> 1537 <p> 1538 Path to file that contains trigger resource definition 1539 </p> 1540 </td> 1541 </tr> 1542 <tr> 1543 <td> 1544 <code>branch</code></br> <em> string </em> 1545 </td> 1546 <td> 1547 <em>(Optional)</em> 1548 <p> 1549 Branch to use to pull trigger resource 1550 </p> 1551 </td> 1552 </tr> 1553 <tr> 1554 <td> 1555 <code>tag</code></br> <em> string </em> 1556 </td> 1557 <td> 1558 <em>(Optional)</em> 1559 <p> 1560 Tag to use to pull trigger resource 1561 </p> 1562 </td> 1563 </tr> 1564 <tr> 1565 <td> 1566 <code>ref</code></br> <em> string </em> 1567 </td> 1568 <td> 1569 <em>(Optional)</em> 1570 <p> 1571 Ref to use to pull trigger resource. Will result in a shallow clone and 1572 fetch. 1573 </p> 1574 </td> 1575 </tr> 1576 <tr> 1577 <td> 1578 <code>remote</code></br> <em> 1579 <a href="#argoproj.io/v1alpha1.GitRemoteConfig"> GitRemoteConfig </a> 1580 </em> 1581 </td> 1582 <td> 1583 <em>(Optional)</em> 1584 <p> 1585 Remote to manage set of tracked repositories. Defaults to “origin”. 1586 Refer 1587 <a href="https://git-scm.com/docs/git-remote">https://git-scm.com/docs/git-remote</a> 1588 </p> 1589 </td> 1590 </tr> 1591 <tr> 1592 <td> 1593 <code>insecureIgnoreHostKey</code></br> <em> bool </em> 1594 </td> 1595 <td> 1596 <em>(Optional)</em> 1597 <p> 1598 Whether to ignore host key 1599 </p> 1600 </td> 1601 </tr> 1602 </tbody> 1603 </table> 1604 <h3 id="argoproj.io/v1alpha1.GitCreds"> 1605 GitCreds 1606 </h3> 1607 <p> 1608 (<em>Appears on:</em> 1609 <a href="#argoproj.io/v1alpha1.GitArtifact">GitArtifact</a>) 1610 </p> 1611 <p> 1612 <p> 1613 GitCreds contain reference to git username and password 1614 </p> 1615 </p> 1616 <table> 1617 <thead> 1618 <tr> 1619 <th> 1620 Field 1621 </th> 1622 <th> 1623 Description 1624 </th> 1625 </tr> 1626 </thead> 1627 <tbody> 1628 <tr> 1629 <td> 1630 <code>username</code></br> <em> 1631 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1632 Kubernetes core/v1.SecretKeySelector </a> </em> 1633 </td> 1634 <td> 1635 </td> 1636 </tr> 1637 <tr> 1638 <td> 1639 <code>password</code></br> <em> 1640 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1641 Kubernetes core/v1.SecretKeySelector </a> </em> 1642 </td> 1643 <td> 1644 </td> 1645 </tr> 1646 </tbody> 1647 </table> 1648 <h3 id="argoproj.io/v1alpha1.GitRemoteConfig"> 1649 GitRemoteConfig 1650 </h3> 1651 <p> 1652 (<em>Appears on:</em> 1653 <a href="#argoproj.io/v1alpha1.GitArtifact">GitArtifact</a>) 1654 </p> 1655 <p> 1656 <p> 1657 GitRemoteConfig contains the configuration of a Git remote 1658 </p> 1659 </p> 1660 <table> 1661 <thead> 1662 <tr> 1663 <th> 1664 Field 1665 </th> 1666 <th> 1667 Description 1668 </th> 1669 </tr> 1670 </thead> 1671 <tbody> 1672 <tr> 1673 <td> 1674 <code>name</code></br> <em> string </em> 1675 </td> 1676 <td> 1677 <p> 1678 Name of the remote to fetch from. 1679 </p> 1680 </td> 1681 </tr> 1682 <tr> 1683 <td> 1684 <code>urls</code></br> <em> \[\]string </em> 1685 </td> 1686 <td> 1687 <p> 1688 URLs the URLs of a remote repository. It must be non-empty. Fetch will 1689 always use the first URL, while push will use all of them. 1690 </p> 1691 </td> 1692 </tr> 1693 </tbody> 1694 </table> 1695 <h3 id="argoproj.io/v1alpha1.HTTPTrigger"> 1696 HTTPTrigger 1697 </h3> 1698 <p> 1699 (<em>Appears on:</em> 1700 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 1701 </p> 1702 <p> 1703 <p> 1704 HTTPTrigger is the trigger for the HTTP request 1705 </p> 1706 </p> 1707 <table> 1708 <thead> 1709 <tr> 1710 <th> 1711 Field 1712 </th> 1713 <th> 1714 Description 1715 </th> 1716 </tr> 1717 </thead> 1718 <tbody> 1719 <tr> 1720 <td> 1721 <code>url</code></br> <em> string </em> 1722 </td> 1723 <td> 1724 <p> 1725 URL refers to the URL to send HTTP request to. 1726 </p> 1727 </td> 1728 </tr> 1729 <tr> 1730 <td> 1731 <code>payload</code></br> <em> 1732 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 1733 </a> </em> 1734 </td> 1735 <td> 1736 </td> 1737 </tr> 1738 <tr> 1739 <td> 1740 <code>tls</code></br> <em> 1741 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 1742 </td> 1743 <td> 1744 <em>(Optional)</em> 1745 <p> 1746 TLS configuration for the HTTP client. 1747 </p> 1748 </td> 1749 </tr> 1750 <tr> 1751 <td> 1752 <code>method</code></br> <em> string </em> 1753 </td> 1754 <td> 1755 <em>(Optional)</em> 1756 <p> 1757 Method refers to the type of the HTTP request. Refer 1758 <a href="https://golang.org/src/net/http/method.go">https://golang.org/src/net/http/method.go</a> 1759 for more info. Default value is POST. 1760 </p> 1761 </td> 1762 </tr> 1763 <tr> 1764 <td> 1765 <code>parameters</code></br> <em> 1766 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 1767 </a> </em> 1768 </td> 1769 <td> 1770 <p> 1771 Parameters is the list of key-value extracted from event’s payload that 1772 are applied to the HTTP trigger resource. 1773 </p> 1774 </td> 1775 </tr> 1776 <tr> 1777 <td> 1778 <code>timeout</code></br> <em> int64 </em> 1779 </td> 1780 <td> 1781 <em>(Optional)</em> 1782 <p> 1783 Timeout refers to the HTTP request timeout in seconds. Default value is 1784 60 seconds. 1785 </p> 1786 </td> 1787 </tr> 1788 <tr> 1789 <td> 1790 <code>basicAuth</code></br> <em> 1791 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth </em> 1792 </td> 1793 <td> 1794 <em>(Optional)</em> 1795 <p> 1796 BasicAuth configuration for the http request. 1797 </p> 1798 </td> 1799 </tr> 1800 <tr> 1801 <td> 1802 <code>headers</code></br> <em> map\[string\]string </em> 1803 </td> 1804 <td> 1805 <em>(Optional)</em> 1806 <p> 1807 Headers for the HTTP request. 1808 </p> 1809 </td> 1810 </tr> 1811 <tr> 1812 <td> 1813 <code>secureHeaders</code></br> <em> 1814 \[\]\*github.com/argoproj/argo-events/pkg/apis/common.SecureHeader </em> 1815 </td> 1816 <td> 1817 <em>(Optional)</em> 1818 <p> 1819 Secure Headers stored in Kubernetes Secrets for the HTTP requests. 1820 </p> 1821 </td> 1822 </tr> 1823 </tbody> 1824 </table> 1825 <h3 id="argoproj.io/v1alpha1.JSONType"> 1826 JSONType (<code>string</code> alias) 1827 </p> 1828 </h3> 1829 <p> 1830 (<em>Appears on:</em> 1831 <a href="#argoproj.io/v1alpha1.DataFilter">DataFilter</a>) 1832 </p> 1833 <p> 1834 <p> 1835 JSONType contains the supported JSON types for data filtering 1836 </p> 1837 </p> 1838 <h3 id="argoproj.io/v1alpha1.K8SResourcePolicy"> 1839 K8SResourcePolicy 1840 </h3> 1841 <p> 1842 (<em>Appears on:</em> 1843 <a href="#argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy</a>) 1844 </p> 1845 <p> 1846 <p> 1847 K8SResourcePolicy refers to the policy used to check the state of K8s 1848 based triggers using labels 1849 </p> 1850 </p> 1851 <table> 1852 <thead> 1853 <tr> 1854 <th> 1855 Field 1856 </th> 1857 <th> 1858 Description 1859 </th> 1860 </tr> 1861 </thead> 1862 <tbody> 1863 <tr> 1864 <td> 1865 <code>labels</code></br> <em> map\[string\]string </em> 1866 </td> 1867 <td> 1868 <p> 1869 Labels required to identify whether a resource is in success state 1870 </p> 1871 </td> 1872 </tr> 1873 <tr> 1874 <td> 1875 <code>backoff</code></br> <em> 1876 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 1877 </td> 1878 <td> 1879 <p> 1880 Backoff before checking resource state 1881 </p> 1882 </td> 1883 </tr> 1884 <tr> 1885 <td> 1886 <code>errorOnBackoffTimeout</code></br> <em> bool </em> 1887 </td> 1888 <td> 1889 <p> 1890 ErrorOnBackoffTimeout determines whether sensor should transition to 1891 error state if the trigger policy is unable to determine the state of 1892 the resource 1893 </p> 1894 </td> 1895 </tr> 1896 </tbody> 1897 </table> 1898 <h3 id="argoproj.io/v1alpha1.KafkaTrigger"> 1899 KafkaTrigger 1900 </h3> 1901 <p> 1902 (<em>Appears on:</em> 1903 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 1904 </p> 1905 <p> 1906 <p> 1907 KafkaTrigger refers to the specification of the Kafka trigger. 1908 </p> 1909 </p> 1910 <table> 1911 <thead> 1912 <tr> 1913 <th> 1914 Field 1915 </th> 1916 <th> 1917 Description 1918 </th> 1919 </tr> 1920 </thead> 1921 <tbody> 1922 <tr> 1923 <td> 1924 <code>url</code></br> <em> string </em> 1925 </td> 1926 <td> 1927 <p> 1928 URL of the Kafka broker, multiple URLs separated by comma. 1929 </p> 1930 </td> 1931 </tr> 1932 <tr> 1933 <td> 1934 <code>topic</code></br> <em> string </em> 1935 </td> 1936 <td> 1937 <p> 1938 Name of the topic. More info at 1939 <a href="https://kafka.apache.org/documentation/#intro_topics">https://kafka.apache.org/documentation/#intro_topics</a> 1940 </p> 1941 </td> 1942 </tr> 1943 <tr> 1944 <td> 1945 <code>partition</code></br> <em> int32 </em> 1946 </td> 1947 <td> 1948 <em>(Optional)</em> 1949 <p> 1950 DEPRECATED 1951 </p> 1952 </td> 1953 </tr> 1954 <tr> 1955 <td> 1956 <code>parameters</code></br> <em> 1957 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 1958 </a> </em> 1959 </td> 1960 <td> 1961 <p> 1962 Parameters is the list of parameters that is applied to resolved Kafka 1963 trigger object. 1964 </p> 1965 </td> 1966 </tr> 1967 <tr> 1968 <td> 1969 <code>requiredAcks</code></br> <em> int32 </em> 1970 </td> 1971 <td> 1972 <p> 1973 RequiredAcks used in producer to tell the broker how many replica 1974 acknowledgements Defaults to 1 (Only wait for the leader to ack). 1975 </p> 1976 </td> 1977 </tr> 1978 <tr> 1979 <td> 1980 <code>compress</code></br> <em> bool </em> 1981 </td> 1982 <td> 1983 <em>(Optional)</em> 1984 <p> 1985 Compress determines whether to compress message or not. Defaults to 1986 false. If set to true, compresses message using snappy compression. 1987 </p> 1988 </td> 1989 </tr> 1990 <tr> 1991 <td> 1992 <code>flushFrequency</code></br> <em> int32 </em> 1993 </td> 1994 <td> 1995 <em>(Optional)</em> 1996 <p> 1997 FlushFrequency refers to the frequency in milliseconds to flush batches. 1998 Defaults to 500 milliseconds. 1999 </p> 2000 </td> 2001 </tr> 2002 <tr> 2003 <td> 2004 <code>tls</code></br> <em> 2005 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 2006 </td> 2007 <td> 2008 <em>(Optional)</em> 2009 <p> 2010 TLS configuration for the Kafka producer. 2011 </p> 2012 </td> 2013 </tr> 2014 <tr> 2015 <td> 2016 <code>payload</code></br> <em> 2017 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2018 </a> </em> 2019 </td> 2020 <td> 2021 <p> 2022 Payload is the list of key-value extracted from an event payload to 2023 construct the request payload. 2024 </p> 2025 </td> 2026 </tr> 2027 <tr> 2028 <td> 2029 <code>partitioningKey</code></br> <em> string </em> 2030 </td> 2031 <td> 2032 <p> 2033 The partitioning key for the messages put on the Kafka topic. 2034 </p> 2035 </td> 2036 </tr> 2037 <tr> 2038 <td> 2039 <code>version</code></br> <em> string </em> 2040 </td> 2041 <td> 2042 <em>(Optional)</em> 2043 <p> 2044 Specify what kafka version is being connected to enables certain 2045 features in sarama, defaults to 1.0.0 2046 </p> 2047 </td> 2048 </tr> 2049 <tr> 2050 <td> 2051 <code>sasl</code></br> <em> 2052 github.com/argoproj/argo-events/pkg/apis/common.SASLConfig </em> 2053 </td> 2054 <td> 2055 <em>(Optional)</em> 2056 <p> 2057 SASL configuration for the kafka client 2058 </p> 2059 </td> 2060 </tr> 2061 <tr> 2062 <td> 2063 <code>schemaRegistry</code></br> <em> 2064 github.com/argoproj/argo-events/pkg/apis/common.SchemaRegistryConfig 2065 </em> 2066 </td> 2067 <td> 2068 <em>(Optional)</em> 2069 <p> 2070 Schema Registry configuration to producer message with avro format 2071 </p> 2072 </td> 2073 </tr> 2074 </tbody> 2075 </table> 2076 <h3 id="argoproj.io/v1alpha1.KubernetesResourceOperation"> 2077 KubernetesResourceOperation (<code>string</code> alias) 2078 </p> 2079 </h3> 2080 <p> 2081 (<em>Appears on:</em> 2082 <a href="#argoproj.io/v1alpha1.StandardK8STrigger">StandardK8STrigger</a>) 2083 </p> 2084 <p> 2085 <p> 2086 KubernetesResourceOperation refers to the type of operation performed on 2087 the K8s resource 2088 </p> 2089 </p> 2090 <h3 id="argoproj.io/v1alpha1.LogTrigger"> 2091 LogTrigger 2092 </h3> 2093 <p> 2094 (<em>Appears on:</em> 2095 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 2096 </p> 2097 <p> 2098 </p> 2099 <table> 2100 <thead> 2101 <tr> 2102 <th> 2103 Field 2104 </th> 2105 <th> 2106 Description 2107 </th> 2108 </tr> 2109 </thead> 2110 <tbody> 2111 <tr> 2112 <td> 2113 <code>intervalSeconds</code></br> <em> uint64 </em> 2114 </td> 2115 <td> 2116 <em>(Optional)</em> 2117 <p> 2118 Only print messages every interval. Useful to prevent logging too much 2119 data for busy events. 2120 </p> 2121 </td> 2122 </tr> 2123 </tbody> 2124 </table> 2125 <h3 id="argoproj.io/v1alpha1.LogicalOperator"> 2126 LogicalOperator (<code>string</code> alias) 2127 </p> 2128 </h3> 2129 <p> 2130 (<em>Appears on:</em> 2131 <a href="#argoproj.io/v1alpha1.EventDependency">EventDependency</a>, 2132 <a href="#argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter</a>) 2133 </p> 2134 <p> 2135 </p> 2136 <h3 id="argoproj.io/v1alpha1.NATSTrigger"> 2137 NATSTrigger 2138 </h3> 2139 <p> 2140 (<em>Appears on:</em> 2141 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 2142 </p> 2143 <p> 2144 <p> 2145 NATSTrigger refers to the specification of the NATS trigger. 2146 </p> 2147 </p> 2148 <table> 2149 <thead> 2150 <tr> 2151 <th> 2152 Field 2153 </th> 2154 <th> 2155 Description 2156 </th> 2157 </tr> 2158 </thead> 2159 <tbody> 2160 <tr> 2161 <td> 2162 <code>url</code></br> <em> string </em> 2163 </td> 2164 <td> 2165 <p> 2166 URL of the NATS cluster. 2167 </p> 2168 </td> 2169 </tr> 2170 <tr> 2171 <td> 2172 <code>subject</code></br> <em> string </em> 2173 </td> 2174 <td> 2175 <p> 2176 Name of the subject to put message on. 2177 </p> 2178 </td> 2179 </tr> 2180 <tr> 2181 <td> 2182 <code>payload</code></br> <em> 2183 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2184 </a> </em> 2185 </td> 2186 <td> 2187 </td> 2188 </tr> 2189 <tr> 2190 <td> 2191 <code>parameters</code></br> <em> 2192 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2193 </a> </em> 2194 </td> 2195 <td> 2196 </td> 2197 </tr> 2198 <tr> 2199 <td> 2200 <code>tls</code></br> <em> 2201 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 2202 </td> 2203 <td> 2204 <em>(Optional)</em> 2205 <p> 2206 TLS configuration for the NATS producer. 2207 </p> 2208 </td> 2209 </tr> 2210 </tbody> 2211 </table> 2212 <h3 id="argoproj.io/v1alpha1.OpenWhiskTrigger"> 2213 OpenWhiskTrigger 2214 </h3> 2215 <p> 2216 (<em>Appears on:</em> 2217 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 2218 </p> 2219 <p> 2220 <p> 2221 OpenWhiskTrigger refers to the specification of the OpenWhisk trigger. 2222 </p> 2223 </p> 2224 <table> 2225 <thead> 2226 <tr> 2227 <th> 2228 Field 2229 </th> 2230 <th> 2231 Description 2232 </th> 2233 </tr> 2234 </thead> 2235 <tbody> 2236 <tr> 2237 <td> 2238 <code>host</code></br> <em> string </em> 2239 </td> 2240 <td> 2241 <p> 2242 Host URL of the OpenWhisk. 2243 </p> 2244 </td> 2245 </tr> 2246 <tr> 2247 <td> 2248 <code>version</code></br> <em> string </em> 2249 </td> 2250 <td> 2251 <em>(Optional)</em> 2252 <p> 2253 Version for the API. Defaults to v1. 2254 </p> 2255 </td> 2256 </tr> 2257 <tr> 2258 <td> 2259 <code>namespace</code></br> <em> string </em> 2260 </td> 2261 <td> 2262 <p> 2263 Namespace for the action. Defaults to “\_”. 2264 </p> 2265 </td> 2266 </tr> 2267 <tr> 2268 <td> 2269 <code>authToken</code></br> <em> 2270 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 2271 Kubernetes core/v1.SecretKeySelector </a> </em> 2272 </td> 2273 <td> 2274 <em>(Optional)</em> 2275 <p> 2276 AuthToken for authentication. 2277 </p> 2278 </td> 2279 </tr> 2280 <tr> 2281 <td> 2282 <code>actionName</code></br> <em> string </em> 2283 </td> 2284 <td> 2285 <p> 2286 Name of the action/function. 2287 </p> 2288 </td> 2289 </tr> 2290 <tr> 2291 <td> 2292 <code>payload</code></br> <em> 2293 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2294 </a> </em> 2295 </td> 2296 <td> 2297 <p> 2298 Payload is the list of key-value extracted from an event payload to 2299 construct the request payload. 2300 </p> 2301 </td> 2302 </tr> 2303 <tr> 2304 <td> 2305 <code>parameters</code></br> <em> 2306 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2307 </a> </em> 2308 </td> 2309 <td> 2310 <em>(Optional)</em> 2311 <p> 2312 Parameters is the list of key-value extracted from event’s payload that 2313 are applied to the trigger resource. 2314 </p> 2315 </td> 2316 </tr> 2317 </tbody> 2318 </table> 2319 <h3 id="argoproj.io/v1alpha1.PayloadField"> 2320 PayloadField 2321 </h3> 2322 <p> 2323 (<em>Appears on:</em> 2324 <a href="#argoproj.io/v1alpha1.ExprFilter">ExprFilter</a>) 2325 </p> 2326 <p> 2327 <p> 2328 PayloadField binds a value at path within the event payload against a 2329 name. 2330 </p> 2331 </p> 2332 <table> 2333 <thead> 2334 <tr> 2335 <th> 2336 Field 2337 </th> 2338 <th> 2339 Description 2340 </th> 2341 </tr> 2342 </thead> 2343 <tbody> 2344 <tr> 2345 <td> 2346 <code>path</code></br> <em> string </em> 2347 </td> 2348 <td> 2349 <p> 2350 Path is the JSONPath of the event’s (JSON decoded) data key Path is a 2351 series of keys separated by a dot. A key may contain wildcard characters 2352 ‘\*’ and ‘?’. To access an array value use the index as the key. The dot 2353 and wildcard characters can be escaped with ‘’. See 2354 <a href="https://github.com/tidwall/gjson#path-syntax">https://github.com/tidwall/gjson#path-syntax</a> 2355 for more information on how to use this. 2356 </p> 2357 </td> 2358 </tr> 2359 <tr> 2360 <td> 2361 <code>name</code></br> <em> string </em> 2362 </td> 2363 <td> 2364 <p> 2365 Name acts as key that holds the value at the path. 2366 </p> 2367 </td> 2368 </tr> 2369 </tbody> 2370 </table> 2371 <h3 id="argoproj.io/v1alpha1.PulsarTrigger"> 2372 PulsarTrigger 2373 </h3> 2374 <p> 2375 (<em>Appears on:</em> 2376 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 2377 </p> 2378 <p> 2379 <p> 2380 PulsarTrigger refers to the specification of the Pulsar trigger. 2381 </p> 2382 </p> 2383 <table> 2384 <thead> 2385 <tr> 2386 <th> 2387 Field 2388 </th> 2389 <th> 2390 Description 2391 </th> 2392 </tr> 2393 </thead> 2394 <tbody> 2395 <tr> 2396 <td> 2397 <code>url</code></br> <em> string </em> 2398 </td> 2399 <td> 2400 <p> 2401 Configure the service URL for the Pulsar service. 2402 </p> 2403 </td> 2404 </tr> 2405 <tr> 2406 <td> 2407 <code>topic</code></br> <em> string </em> 2408 </td> 2409 <td> 2410 <p> 2411 Name of the topic. See 2412 <a href="https://pulsar.apache.org/docs/en/concepts-messaging/">https://pulsar.apache.org/docs/en/concepts-messaging/</a> 2413 </p> 2414 </td> 2415 </tr> 2416 <tr> 2417 <td> 2418 <code>parameters</code></br> <em> 2419 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2420 </a> </em> 2421 </td> 2422 <td> 2423 <p> 2424 Parameters is the list of parameters that is applied to resolved Kafka 2425 trigger object. 2426 </p> 2427 </td> 2428 </tr> 2429 <tr> 2430 <td> 2431 <code>payload</code></br> <em> 2432 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 2433 </a> </em> 2434 </td> 2435 <td> 2436 <p> 2437 Payload is the list of key-value extracted from an event payload to 2438 construct the request payload. 2439 </p> 2440 </td> 2441 </tr> 2442 <tr> 2443 <td> 2444 <code>tlsTrustCertsSecret</code></br> <em> 2445 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 2446 Kubernetes core/v1.SecretKeySelector </a> </em> 2447 </td> 2448 <td> 2449 <em>(Optional)</em> 2450 <p> 2451 Trusted TLS certificate secret. 2452 </p> 2453 </td> 2454 </tr> 2455 <tr> 2456 <td> 2457 <code>tlsAllowInsecureConnection</code></br> <em> bool </em> 2458 </td> 2459 <td> 2460 <em>(Optional)</em> 2461 <p> 2462 Whether the Pulsar client accept untrusted TLS certificate from broker. 2463 </p> 2464 </td> 2465 </tr> 2466 <tr> 2467 <td> 2468 <code>tlsValidateHostname</code></br> <em> bool </em> 2469 </td> 2470 <td> 2471 <em>(Optional)</em> 2472 <p> 2473 Whether the Pulsar client verify the validity of the host name from 2474 broker. 2475 </p> 2476 </td> 2477 </tr> 2478 <tr> 2479 <td> 2480 <code>tls</code></br> <em> 2481 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig </em> 2482 </td> 2483 <td> 2484 <em>(Optional)</em> 2485 <p> 2486 TLS configuration for the pulsar client. 2487 </p> 2488 </td> 2489 </tr> 2490 <tr> 2491 <td> 2492 <code>authTokenSecret</code></br> <em> 2493 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 2494 Kubernetes core/v1.SecretKeySelector </a> </em> 2495 </td> 2496 <td> 2497 <em>(Optional)</em> 2498 <p> 2499 Authentication token for the pulsar client. Either token or athenz can 2500 be set to use auth. 2501 </p> 2502 </td> 2503 </tr> 2504 <tr> 2505 <td> 2506 <code>connectionBackoff</code></br> <em> 2507 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 2508 </td> 2509 <td> 2510 <em>(Optional)</em> 2511 <p> 2512 Backoff holds parameters applied to connection. 2513 </p> 2514 </td> 2515 </tr> 2516 <tr> 2517 <td> 2518 <code>authAthenzParams</code></br> <em> map\[string\]string </em> 2519 </td> 2520 <td> 2521 <em>(Optional)</em> 2522 <p> 2523 Authentication athenz parameters for the pulsar client. Refer 2524 <a href="https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go">https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go</a> 2525 Either token or athenz can be set to use auth. 2526 </p> 2527 </td> 2528 </tr> 2529 <tr> 2530 <td> 2531 <code>authAthenzSecret</code></br> <em> 2532 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 2533 Kubernetes core/v1.SecretKeySelector </a> </em> 2534 </td> 2535 <td> 2536 <em>(Optional)</em> 2537 <p> 2538 Authentication athenz privateKey secret for the pulsar client. 2539 AuthAthenzSecret must be set if AuthAthenzParams is used. 2540 </p> 2541 </td> 2542 </tr> 2543 </tbody> 2544 </table> 2545 <h3 id="argoproj.io/v1alpha1.RateLimit"> 2546 RateLimit 2547 </h3> 2548 <p> 2549 (<em>Appears on:</em> 2550 <a href="#argoproj.io/v1alpha1.Trigger">Trigger</a>) 2551 </p> 2552 <p> 2553 </p> 2554 <table> 2555 <thead> 2556 <tr> 2557 <th> 2558 Field 2559 </th> 2560 <th> 2561 Description 2562 </th> 2563 </tr> 2564 </thead> 2565 <tbody> 2566 <tr> 2567 <td> 2568 <code>unit</code></br> <em> 2569 <a href="#argoproj.io/v1alpha1.RateLimiteUnit"> RateLimiteUnit </a> 2570 </em> 2571 </td> 2572 <td> 2573 <p> 2574 Defaults to Second 2575 </p> 2576 </td> 2577 </tr> 2578 <tr> 2579 <td> 2580 <code>requestsPerUnit</code></br> <em> int32 </em> 2581 </td> 2582 <td> 2583 </td> 2584 </tr> 2585 </tbody> 2586 </table> 2587 <h3 id="argoproj.io/v1alpha1.RateLimiteUnit"> 2588 RateLimiteUnit (<code>string</code> alias) 2589 </p> 2590 </h3> 2591 <p> 2592 (<em>Appears on:</em> 2593 <a href="#argoproj.io/v1alpha1.RateLimit">RateLimit</a>) 2594 </p> 2595 <p> 2596 </p> 2597 <h3 id="argoproj.io/v1alpha1.Sensor"> 2598 Sensor 2599 </h3> 2600 <p> 2601 <p> 2602 Sensor is the definition of a sensor resource 2603 </p> 2604 </p> 2605 <table> 2606 <thead> 2607 <tr> 2608 <th> 2609 Field 2610 </th> 2611 <th> 2612 Description 2613 </th> 2614 </tr> 2615 </thead> 2616 <tbody> 2617 <tr> 2618 <td> 2619 <code>metadata</code></br> <em> 2620 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 2621 Kubernetes meta/v1.ObjectMeta </a> </em> 2622 </td> 2623 <td> 2624 Refer to the Kubernetes API documentation for the fields of the 2625 <code>metadata</code> field. 2626 </td> 2627 </tr> 2628 <tr> 2629 <td> 2630 <code>spec</code></br> <em> <a href="#argoproj.io/v1alpha1.SensorSpec"> 2631 SensorSpec </a> </em> 2632 </td> 2633 <td> 2634 <br/> <br/> 2635 <table> 2636 <tr> 2637 <td> 2638 <code>dependencies</code></br> <em> 2639 <a href="#argoproj.io/v1alpha1.EventDependency"> \[\]EventDependency 2640 </a> </em> 2641 </td> 2642 <td> 2643 <p> 2644 Dependencies is a list of the events that this sensor is dependent on. 2645 </p> 2646 </td> 2647 </tr> 2648 <tr> 2649 <td> 2650 <code>triggers</code></br> <em> <a href="#argoproj.io/v1alpha1.Trigger"> 2651 \[\]Trigger </a> </em> 2652 </td> 2653 <td> 2654 <p> 2655 Triggers is a list of the things that this sensor evokes. These are the 2656 outputs from this sensor. 2657 </p> 2658 </td> 2659 </tr> 2660 <tr> 2661 <td> 2662 <code>template</code></br> <em> 2663 <a href="#argoproj.io/v1alpha1.Template"> Template </a> </em> 2664 </td> 2665 <td> 2666 <em>(Optional)</em> 2667 <p> 2668 Template is the pod specification for the sensor 2669 </p> 2670 </td> 2671 </tr> 2672 <tr> 2673 <td> 2674 <code>errorOnFailedRound</code></br> <em> bool </em> 2675 </td> 2676 <td> 2677 <p> 2678 ErrorOnFailedRound if set to true, marks sensor state as 2679 <code>error</code> if the previous trigger round fails. Once sensor 2680 state is set to <code>error</code>, no further triggers will be 2681 processed. 2682 </p> 2683 </td> 2684 </tr> 2685 <tr> 2686 <td> 2687 <code>eventBusName</code></br> <em> string </em> 2688 </td> 2689 <td> 2690 <p> 2691 EventBusName references to a EventBus name. By default the value is 2692 “default” 2693 </p> 2694 </td> 2695 </tr> 2696 <tr> 2697 <td> 2698 <code>replicas</code></br> <em> int32 </em> 2699 </td> 2700 <td> 2701 <p> 2702 Replicas is the sensor deployment replicas 2703 </p> 2704 </td> 2705 </tr> 2706 <tr> 2707 <td> 2708 <code>revisionHistoryLimit</code></br> <em> int32 </em> 2709 </td> 2710 <td> 2711 <em>(Optional)</em> 2712 <p> 2713 RevisionHistoryLimit specifies how many old deployment revisions to 2714 retain 2715 </p> 2716 </td> 2717 </tr> 2718 <tr> 2719 <td> 2720 <code>loggingFields</code></br> <em> map\[string\]string </em> 2721 </td> 2722 <td> 2723 <em>(Optional)</em> 2724 <p> 2725 LoggingFields add additional key-value pairs when logging happens 2726 </p> 2727 </td> 2728 </tr> 2729 </table> 2730 </td> 2731 </tr> 2732 <tr> 2733 <td> 2734 <code>status</code></br> <em> 2735 <a href="#argoproj.io/v1alpha1.SensorStatus"> SensorStatus </a> </em> 2736 </td> 2737 <td> 2738 <em>(Optional)</em> 2739 </td> 2740 </tr> 2741 </tbody> 2742 </table> 2743 <h3 id="argoproj.io/v1alpha1.SensorSpec"> 2744 SensorSpec 2745 </h3> 2746 <p> 2747 (<em>Appears on:</em> <a href="#argoproj.io/v1alpha1.Sensor">Sensor</a>) 2748 </p> 2749 <p> 2750 <p> 2751 SensorSpec represents desired sensor state 2752 </p> 2753 </p> 2754 <table> 2755 <thead> 2756 <tr> 2757 <th> 2758 Field 2759 </th> 2760 <th> 2761 Description 2762 </th> 2763 </tr> 2764 </thead> 2765 <tbody> 2766 <tr> 2767 <td> 2768 <code>dependencies</code></br> <em> 2769 <a href="#argoproj.io/v1alpha1.EventDependency"> \[\]EventDependency 2770 </a> </em> 2771 </td> 2772 <td> 2773 <p> 2774 Dependencies is a list of the events that this sensor is dependent on. 2775 </p> 2776 </td> 2777 </tr> 2778 <tr> 2779 <td> 2780 <code>triggers</code></br> <em> <a href="#argoproj.io/v1alpha1.Trigger"> 2781 \[\]Trigger </a> </em> 2782 </td> 2783 <td> 2784 <p> 2785 Triggers is a list of the things that this sensor evokes. These are the 2786 outputs from this sensor. 2787 </p> 2788 </td> 2789 </tr> 2790 <tr> 2791 <td> 2792 <code>template</code></br> <em> 2793 <a href="#argoproj.io/v1alpha1.Template"> Template </a> </em> 2794 </td> 2795 <td> 2796 <em>(Optional)</em> 2797 <p> 2798 Template is the pod specification for the sensor 2799 </p> 2800 </td> 2801 </tr> 2802 <tr> 2803 <td> 2804 <code>errorOnFailedRound</code></br> <em> bool </em> 2805 </td> 2806 <td> 2807 <p> 2808 ErrorOnFailedRound if set to true, marks sensor state as 2809 <code>error</code> if the previous trigger round fails. Once sensor 2810 state is set to <code>error</code>, no further triggers will be 2811 processed. 2812 </p> 2813 </td> 2814 </tr> 2815 <tr> 2816 <td> 2817 <code>eventBusName</code></br> <em> string </em> 2818 </td> 2819 <td> 2820 <p> 2821 EventBusName references to a EventBus name. By default the value is 2822 “default” 2823 </p> 2824 </td> 2825 </tr> 2826 <tr> 2827 <td> 2828 <code>replicas</code></br> <em> int32 </em> 2829 </td> 2830 <td> 2831 <p> 2832 Replicas is the sensor deployment replicas 2833 </p> 2834 </td> 2835 </tr> 2836 <tr> 2837 <td> 2838 <code>revisionHistoryLimit</code></br> <em> int32 </em> 2839 </td> 2840 <td> 2841 <em>(Optional)</em> 2842 <p> 2843 RevisionHistoryLimit specifies how many old deployment revisions to 2844 retain 2845 </p> 2846 </td> 2847 </tr> 2848 <tr> 2849 <td> 2850 <code>loggingFields</code></br> <em> map\[string\]string </em> 2851 </td> 2852 <td> 2853 <em>(Optional)</em> 2854 <p> 2855 LoggingFields add additional key-value pairs when logging happens 2856 </p> 2857 </td> 2858 </tr> 2859 </tbody> 2860 </table> 2861 <h3 id="argoproj.io/v1alpha1.SensorStatus"> 2862 SensorStatus 2863 </h3> 2864 <p> 2865 (<em>Appears on:</em> <a href="#argoproj.io/v1alpha1.Sensor">Sensor</a>) 2866 </p> 2867 <p> 2868 <p> 2869 SensorStatus contains information about the status of a sensor. 2870 </p> 2871 </p> 2872 <table> 2873 <thead> 2874 <tr> 2875 <th> 2876 Field 2877 </th> 2878 <th> 2879 Description 2880 </th> 2881 </tr> 2882 </thead> 2883 <tbody> 2884 <tr> 2885 <td> 2886 <code>Status</code></br> <em> 2887 github.com/argoproj/argo-events/pkg/apis/common.Status </em> 2888 </td> 2889 <td> 2890 <p> 2891 (Members of <code>Status</code> are embedded into this type.) 2892 </p> 2893 </td> 2894 </tr> 2895 </tbody> 2896 </table> 2897 <h3 id="argoproj.io/v1alpha1.SlackSender"> 2898 SlackSender 2899 </h3> 2900 <p> 2901 (<em>Appears on:</em> 2902 <a href="#argoproj.io/v1alpha1.SlackTrigger">SlackTrigger</a>) 2903 </p> 2904 <p> 2905 </p> 2906 <table> 2907 <thead> 2908 <tr> 2909 <th> 2910 Field 2911 </th> 2912 <th> 2913 Description 2914 </th> 2915 </tr> 2916 </thead> 2917 <tbody> 2918 <tr> 2919 <td> 2920 <code>username</code></br> <em> string </em> 2921 </td> 2922 <td> 2923 <em>(Optional)</em> 2924 <p> 2925 Username is the Slack application’s username 2926 </p> 2927 </td> 2928 </tr> 2929 <tr> 2930 <td> 2931 <code>icon</code></br> <em> string </em> 2932 </td> 2933 <td> 2934 <em>(Optional)</em> 2935 <p> 2936 Icon is the Slack application’s icon, e.g. :robot_face: or 2937 <a href="https://example.com/image.png">https://example.com/image.png</a> 2938 </p> 2939 </td> 2940 </tr> 2941 </tbody> 2942 </table> 2943 <h3 id="argoproj.io/v1alpha1.SlackThread"> 2944 SlackThread 2945 </h3> 2946 <p> 2947 (<em>Appears on:</em> 2948 <a href="#argoproj.io/v1alpha1.SlackTrigger">SlackTrigger</a>) 2949 </p> 2950 <p> 2951 </p> 2952 <table> 2953 <thead> 2954 <tr> 2955 <th> 2956 Field 2957 </th> 2958 <th> 2959 Description 2960 </th> 2961 </tr> 2962 </thead> 2963 <tbody> 2964 <tr> 2965 <td> 2966 <code>messageAggregationKey</code></br> <em> string </em> 2967 </td> 2968 <td> 2969 <em>(Optional)</em> 2970 <p> 2971 MessageAggregationKey allows to aggregate the messages to a thread by 2972 some key. 2973 </p> 2974 </td> 2975 </tr> 2976 <tr> 2977 <td> 2978 <code>broadcastMessageToChannel</code></br> <em> bool </em> 2979 </td> 2980 <td> 2981 <em>(Optional)</em> 2982 <p> 2983 BroadcastMessageToChannel allows to also broadcast the message from the 2984 thread to the channel 2985 </p> 2986 </td> 2987 </tr> 2988 </tbody> 2989 </table> 2990 <h3 id="argoproj.io/v1alpha1.SlackTrigger"> 2991 SlackTrigger 2992 </h3> 2993 <p> 2994 (<em>Appears on:</em> 2995 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 2996 </p> 2997 <p> 2998 <p> 2999 SlackTrigger refers to the specification of the slack notification 3000 trigger. 3001 </p> 3002 </p> 3003 <table> 3004 <thead> 3005 <tr> 3006 <th> 3007 Field 3008 </th> 3009 <th> 3010 Description 3011 </th> 3012 </tr> 3013 </thead> 3014 <tbody> 3015 <tr> 3016 <td> 3017 <code>parameters</code></br> <em> 3018 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 3019 </a> </em> 3020 </td> 3021 <td> 3022 <em>(Optional)</em> 3023 <p> 3024 Parameters is the list of key-value extracted from event’s payload that 3025 are applied to the trigger resource. 3026 </p> 3027 </td> 3028 </tr> 3029 <tr> 3030 <td> 3031 <code>slackToken</code></br> <em> 3032 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3033 Kubernetes core/v1.SecretKeySelector </a> </em> 3034 </td> 3035 <td> 3036 <p> 3037 SlackToken refers to the Kubernetes secret that holds the slack token 3038 required to send messages. 3039 </p> 3040 </td> 3041 </tr> 3042 <tr> 3043 <td> 3044 <code>channel</code></br> <em> string </em> 3045 </td> 3046 <td> 3047 <em>(Optional)</em> 3048 <p> 3049 Channel refers to which Slack channel to send Slack message. 3050 </p> 3051 </td> 3052 </tr> 3053 <tr> 3054 <td> 3055 <code>message</code></br> <em> string </em> 3056 </td> 3057 <td> 3058 <em>(Optional)</em> 3059 <p> 3060 Message refers to the message to send to the Slack channel. 3061 </p> 3062 </td> 3063 </tr> 3064 <tr> 3065 <td> 3066 <code>attachments</code></br> <em> string </em> 3067 </td> 3068 <td> 3069 <em>(Optional)</em> 3070 <p> 3071 Attachments is a JSON format string that represents an array of Slack 3072 attachments according to the attachments API: 3073 <a href="https://api.slack.com/reference/messaging/attachments">https://api.slack.com/reference/messaging/attachments</a> 3074 . 3075 </p> 3076 </td> 3077 </tr> 3078 <tr> 3079 <td> 3080 <code>blocks</code></br> <em> string </em> 3081 </td> 3082 <td> 3083 <em>(Optional)</em> 3084 <p> 3085 Blocks is a JSON format string that represents an array of Slack blocks 3086 according to the blocks API: 3087 <a href="https://api.slack.com/reference/block-kit/blocks">https://api.slack.com/reference/block-kit/blocks</a> 3088 . 3089 </p> 3090 </td> 3091 </tr> 3092 <tr> 3093 <td> 3094 <code>thread</code></br> <em> 3095 <a href="#argoproj.io/v1alpha1.SlackThread"> SlackThread </a> </em> 3096 </td> 3097 <td> 3098 <em>(Optional)</em> 3099 <p> 3100 Thread refers to additional options for sending messages to a Slack 3101 thread. 3102 </p> 3103 </td> 3104 </tr> 3105 <tr> 3106 <td> 3107 <code>sender</code></br> <em> 3108 <a href="#argoproj.io/v1alpha1.SlackSender"> SlackSender </a> </em> 3109 </td> 3110 <td> 3111 <em>(Optional)</em> 3112 <p> 3113 Sender refers to additional configuration of the Slack application that 3114 sends the message. 3115 </p> 3116 </td> 3117 </tr> 3118 </tbody> 3119 </table> 3120 <h3 id="argoproj.io/v1alpha1.StandardK8STrigger"> 3121 StandardK8STrigger 3122 </h3> 3123 <p> 3124 (<em>Appears on:</em> 3125 <a href="#argoproj.io/v1alpha1.TriggerTemplate">TriggerTemplate</a>) 3126 </p> 3127 <p> 3128 <p> 3129 StandardK8STrigger is the standard Kubernetes resource trigger 3130 </p> 3131 </p> 3132 <table> 3133 <thead> 3134 <tr> 3135 <th> 3136 Field 3137 </th> 3138 <th> 3139 Description 3140 </th> 3141 </tr> 3142 </thead> 3143 <tbody> 3144 <tr> 3145 <td> 3146 <code>source</code></br> <em> 3147 <a href="#argoproj.io/v1alpha1.ArtifactLocation"> ArtifactLocation </a> 3148 </em> 3149 </td> 3150 <td> 3151 <p> 3152 Source of the K8s resource file(s) 3153 </p> 3154 </td> 3155 </tr> 3156 <tr> 3157 <td> 3158 <code>operation</code></br> <em> 3159 <a href="#argoproj.io/v1alpha1.KubernetesResourceOperation"> 3160 KubernetesResourceOperation </a> </em> 3161 </td> 3162 <td> 3163 <em>(Optional)</em> 3164 <p> 3165 Operation refers to the type of operation performed on the k8s resource. 3166 Default value is Create. 3167 </p> 3168 </td> 3169 </tr> 3170 <tr> 3171 <td> 3172 <code>parameters</code></br> <em> 3173 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 3174 </a> </em> 3175 </td> 3176 <td> 3177 <p> 3178 Parameters is the list of parameters that is applied to resolved K8s 3179 trigger object. 3180 </p> 3181 </td> 3182 </tr> 3183 <tr> 3184 <td> 3185 <code>patchStrategy</code></br> <em> 3186 k8s.io/apimachinery/pkg/types.PatchType </em> 3187 </td> 3188 <td> 3189 <em>(Optional)</em> 3190 <p> 3191 PatchStrategy controls the K8s object patching strategy when the trigger 3192 operation is specified as patch. possible values: 3193 “application/json-patch+json” “application/merge-patch+json” 3194 “application/strategic-merge-patch+json” “application/apply-patch+yaml”. 3195 Defaults to “application/merge-patch+json” 3196 </p> 3197 </td> 3198 </tr> 3199 <tr> 3200 <td> 3201 <code>liveObject</code></br> <em> bool </em> 3202 </td> 3203 <td> 3204 <em>(Optional)</em> 3205 <p> 3206 LiveObject specifies whether the resource should be directly fetched 3207 from K8s instead of being marshaled from the resource artifact. If set 3208 to true, the resource artifact must contain the information required to 3209 uniquely identify the resource in the cluster, that is, you must specify 3210 “apiVersion”, “kind” as well as “name” and “namespace” meta data. Only 3211 valid for operation type <code>update</code> 3212 </p> 3213 </td> 3214 </tr> 3215 </tbody> 3216 </table> 3217 <h3 id="argoproj.io/v1alpha1.StatusPolicy"> 3218 StatusPolicy 3219 </h3> 3220 <p> 3221 (<em>Appears on:</em> 3222 <a href="#argoproj.io/v1alpha1.TriggerPolicy">TriggerPolicy</a>) 3223 </p> 3224 <p> 3225 <p> 3226 StatusPolicy refers to the policy used to check the state of the trigger 3227 using response status 3228 </p> 3229 </p> 3230 <table> 3231 <thead> 3232 <tr> 3233 <th> 3234 Field 3235 </th> 3236 <th> 3237 Description 3238 </th> 3239 </tr> 3240 </thead> 3241 <tbody> 3242 <tr> 3243 <td> 3244 <code>allow</code></br> <em> \[\]int32 </em> 3245 </td> 3246 <td> 3247 </td> 3248 </tr> 3249 </tbody> 3250 </table> 3251 <h3 id="argoproj.io/v1alpha1.Template"> 3252 Template 3253 </h3> 3254 <p> 3255 (<em>Appears on:</em> 3256 <a href="#argoproj.io/v1alpha1.SensorSpec">SensorSpec</a>) 3257 </p> 3258 <p> 3259 <p> 3260 Template holds the information of a sensor deployment template 3261 </p> 3262 </p> 3263 <table> 3264 <thead> 3265 <tr> 3266 <th> 3267 Field 3268 </th> 3269 <th> 3270 Description 3271 </th> 3272 </tr> 3273 </thead> 3274 <tbody> 3275 <tr> 3276 <td> 3277 <code>metadata</code></br> <em> 3278 github.com/argoproj/argo-events/pkg/apis/common.Metadata </em> 3279 </td> 3280 <td> 3281 <p> 3282 Metadata sets the pods’s metadata, i.e. annotations and labels 3283 </p> 3284 </td> 3285 </tr> 3286 <tr> 3287 <td> 3288 <code>serviceAccountName</code></br> <em> string </em> 3289 </td> 3290 <td> 3291 <em>(Optional)</em> 3292 <p> 3293 ServiceAccountName is the name of the ServiceAccount to use to run 3294 sensor pod. More info: 3295 <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/">https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/</a> 3296 </p> 3297 </td> 3298 </tr> 3299 <tr> 3300 <td> 3301 <code>container</code></br> <em> 3302 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core"> 3303 Kubernetes core/v1.Container </a> </em> 3304 </td> 3305 <td> 3306 <em>(Optional)</em> 3307 <p> 3308 Container is the main container image to run in the sensor pod 3309 </p> 3310 </td> 3311 </tr> 3312 <tr> 3313 <td> 3314 <code>volumes</code></br> <em> 3315 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#volume-v1-core"> 3316 \[\]Kubernetes core/v1.Volume </a> </em> 3317 </td> 3318 <td> 3319 <em>(Optional)</em> 3320 <p> 3321 Volumes is a list of volumes that can be mounted by containers in a 3322 workflow. 3323 </p> 3324 </td> 3325 </tr> 3326 <tr> 3327 <td> 3328 <code>securityContext</code></br> <em> 3329 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core"> 3330 Kubernetes core/v1.PodSecurityContext </a> </em> 3331 </td> 3332 <td> 3333 <em>(Optional)</em> 3334 <p> 3335 SecurityContext holds pod-level security attributes and common container 3336 settings. Optional: Defaults to empty. See type description for default 3337 values of each field. 3338 </p> 3339 </td> 3340 </tr> 3341 <tr> 3342 <td> 3343 <code>nodeSelector</code></br> <em> map\[string\]string </em> 3344 </td> 3345 <td> 3346 <em>(Optional)</em> 3347 <p> 3348 NodeSelector is a selector which must be true for the pod to fit on a 3349 node. Selector which must match a node’s labels for the pod to be 3350 scheduled on that node. More info: 3351 <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a> 3352 </p> 3353 </td> 3354 </tr> 3355 <tr> 3356 <td> 3357 <code>tolerations</code></br> <em> 3358 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core"> 3359 \[\]Kubernetes core/v1.Toleration </a> </em> 3360 </td> 3361 <td> 3362 <em>(Optional)</em> 3363 <p> 3364 If specified, the pod’s tolerations. 3365 </p> 3366 </td> 3367 </tr> 3368 <tr> 3369 <td> 3370 <code>imagePullSecrets</code></br> <em> 3371 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core"> 3372 \[\]Kubernetes core/v1.LocalObjectReference </a> </em> 3373 </td> 3374 <td> 3375 <em>(Optional)</em> 3376 <p> 3377 ImagePullSecrets is an optional list of references to secrets in the 3378 same namespace to use for pulling any of the images used by this 3379 PodSpec. If specified, these secrets will be passed to individual puller 3380 implementations for them to use. For example, in the case of docker, 3381 only DockerConfig type secrets are honored. More info: 3382 <a href="https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod">https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod</a> 3383 </p> 3384 </td> 3385 </tr> 3386 <tr> 3387 <td> 3388 <code>priorityClassName</code></br> <em> string </em> 3389 </td> 3390 <td> 3391 <em>(Optional)</em> 3392 <p> 3393 If specified, indicates the EventSource pod’s priority. 3394 “system-node-critical” and “system-cluster-critical” are two special 3395 keywords which indicate the highest priorities with the former being the 3396 highest priority. Any other name must be defined by creating a 3397 PriorityClass object with that name. If not specified, the pod priority 3398 will be default or zero if there is no default. More info: 3399 <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a> 3400 </p> 3401 </td> 3402 </tr> 3403 <tr> 3404 <td> 3405 <code>priority</code></br> <em> int32 </em> 3406 </td> 3407 <td> 3408 <em>(Optional)</em> 3409 <p> 3410 The priority value. Various system components use this field to find the 3411 priority of the EventSource pod. When Priority Admission Controller is 3412 enabled, it prevents users from setting this field. The admission 3413 controller populates this field from PriorityClassName. The higher the 3414 value, the higher the priority. More info: 3415 <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a> 3416 </p> 3417 </td> 3418 </tr> 3419 <tr> 3420 <td> 3421 <code>affinity</code></br> <em> 3422 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core"> 3423 Kubernetes core/v1.Affinity </a> </em> 3424 </td> 3425 <td> 3426 <em>(Optional)</em> 3427 <p> 3428 If specified, the pod’s scheduling constraints 3429 </p> 3430 </td> 3431 </tr> 3432 </tbody> 3433 </table> 3434 <h3 id="argoproj.io/v1alpha1.TimeFilter"> 3435 TimeFilter 3436 </h3> 3437 <p> 3438 (<em>Appears on:</em> 3439 <a href="#argoproj.io/v1alpha1.EventDependencyFilter">EventDependencyFilter</a>) 3440 </p> 3441 <p> 3442 <p> 3443 TimeFilter describes a window in time. It filters out events that occur 3444 outside the time limits. In other words, only events that occur after 3445 Start and before Stop will pass this filter. 3446 </p> 3447 </p> 3448 <table> 3449 <thead> 3450 <tr> 3451 <th> 3452 Field 3453 </th> 3454 <th> 3455 Description 3456 </th> 3457 </tr> 3458 </thead> 3459 <tbody> 3460 <tr> 3461 <td> 3462 <code>start</code></br> <em> string </em> 3463 </td> 3464 <td> 3465 <p> 3466 Start is the beginning of a time window in UTC. Before this time, events 3467 for this dependency are ignored. Format is hh:mm:ss. 3468 </p> 3469 </td> 3470 </tr> 3471 <tr> 3472 <td> 3473 <code>stop</code></br> <em> string </em> 3474 </td> 3475 <td> 3476 <p> 3477 Stop is the end of a time window in UTC. After or equal to this time, 3478 events for this dependency are ignored and Format is hh:mm:ss. If it is 3479 smaller than Start, it is treated as next day of Start (e.g.: 3480 22:00:00-01:00:00 means 22:00:00-25:00:00). 3481 </p> 3482 </td> 3483 </tr> 3484 </tbody> 3485 </table> 3486 <h3 id="argoproj.io/v1alpha1.Trigger"> 3487 Trigger 3488 </h3> 3489 <p> 3490 (<em>Appears on:</em> 3491 <a href="#argoproj.io/v1alpha1.SensorSpec">SensorSpec</a>) 3492 </p> 3493 <p> 3494 <p> 3495 Trigger is an action taken, output produced, an event created, a message 3496 sent 3497 </p> 3498 </p> 3499 <table> 3500 <thead> 3501 <tr> 3502 <th> 3503 Field 3504 </th> 3505 <th> 3506 Description 3507 </th> 3508 </tr> 3509 </thead> 3510 <tbody> 3511 <tr> 3512 <td> 3513 <code>template</code></br> <em> 3514 <a href="#argoproj.io/v1alpha1.TriggerTemplate"> TriggerTemplate </a> 3515 </em> 3516 </td> 3517 <td> 3518 <p> 3519 Template describes the trigger specification. 3520 </p> 3521 </td> 3522 </tr> 3523 <tr> 3524 <td> 3525 <code>parameters</code></br> <em> 3526 <a href="#argoproj.io/v1alpha1.TriggerParameter"> \[\]TriggerParameter 3527 </a> </em> 3528 </td> 3529 <td> 3530 <p> 3531 Parameters is the list of parameters applied to the trigger template 3532 definition 3533 </p> 3534 </td> 3535 </tr> 3536 <tr> 3537 <td> 3538 <code>policy</code></br> <em> 3539 <a href="#argoproj.io/v1alpha1.TriggerPolicy"> TriggerPolicy </a> </em> 3540 </td> 3541 <td> 3542 <em>(Optional)</em> 3543 <p> 3544 Policy to configure backoff and execution criteria for the trigger 3545 </p> 3546 </td> 3547 </tr> 3548 <tr> 3549 <td> 3550 <code>retryStrategy</code></br> <em> 3551 github.com/argoproj/argo-events/pkg/apis/common.Backoff </em> 3552 </td> 3553 <td> 3554 <em>(Optional)</em> 3555 <p> 3556 Retry strategy, defaults to no retry 3557 </p> 3558 </td> 3559 </tr> 3560 <tr> 3561 <td> 3562 <code>rateLimit</code></br> <em> 3563 <a href="#argoproj.io/v1alpha1.RateLimit"> RateLimit </a> </em> 3564 </td> 3565 <td> 3566 <em>(Optional)</em> 3567 <p> 3568 Rate limit, default unit is Second 3569 </p> 3570 </td> 3571 </tr> 3572 <tr> 3573 <td> 3574 <code>atLeastOnce</code></br> <em> bool </em> 3575 </td> 3576 <td> 3577 <em>(Optional)</em> 3578 <p> 3579 AtLeastOnce determines the trigger execution semantics. Defaults to 3580 false. Trigger execution will use at-most-once semantics. If set to 3581 true, Trigger execution will switch to at-least-once semantics. 3582 </p> 3583 </td> 3584 </tr> 3585 </tbody> 3586 </table> 3587 <h3 id="argoproj.io/v1alpha1.TriggerParameter"> 3588 TriggerParameter 3589 </h3> 3590 <p> 3591 (<em>Appears on:</em> 3592 <a href="#argoproj.io/v1alpha1.AWSLambdaTrigger">AWSLambdaTrigger</a>, 3593 <a href="#argoproj.io/v1alpha1.ArgoWorkflowTrigger">ArgoWorkflowTrigger</a>, 3594 <a href="#argoproj.io/v1alpha1.AzureEventHubsTrigger">AzureEventHubsTrigger</a>, 3595 <a href="#argoproj.io/v1alpha1.AzureServiceBusTrigger">AzureServiceBusTrigger</a>, 3596 <a href="#argoproj.io/v1alpha1.CustomTrigger">CustomTrigger</a>, 3597 <a href="#argoproj.io/v1alpha1.EmailTrigger">EmailTrigger</a>, 3598 <a href="#argoproj.io/v1alpha1.HTTPTrigger">HTTPTrigger</a>, 3599 <a href="#argoproj.io/v1alpha1.KafkaTrigger">KafkaTrigger</a>, 3600 <a href="#argoproj.io/v1alpha1.NATSTrigger">NATSTrigger</a>, 3601 <a href="#argoproj.io/v1alpha1.OpenWhiskTrigger">OpenWhiskTrigger</a>, 3602 <a href="#argoproj.io/v1alpha1.PulsarTrigger">PulsarTrigger</a>, 3603 <a href="#argoproj.io/v1alpha1.SlackTrigger">SlackTrigger</a>, 3604 <a href="#argoproj.io/v1alpha1.StandardK8STrigger">StandardK8STrigger</a>, 3605 <a href="#argoproj.io/v1alpha1.Trigger">Trigger</a>) 3606 </p> 3607 <p> 3608 <p> 3609 TriggerParameter indicates a passed parameter to a service template 3610 </p> 3611 </p> 3612 <table> 3613 <thead> 3614 <tr> 3615 <th> 3616 Field 3617 </th> 3618 <th> 3619 Description 3620 </th> 3621 </tr> 3622 </thead> 3623 <tbody> 3624 <tr> 3625 <td> 3626 <code>src</code></br> <em> 3627 <a href="#argoproj.io/v1alpha1.TriggerParameterSource"> 3628 TriggerParameterSource </a> </em> 3629 </td> 3630 <td> 3631 <p> 3632 Src contains a source reference to the value of the parameter from a 3633 dependency 3634 </p> 3635 </td> 3636 </tr> 3637 <tr> 3638 <td> 3639 <code>dest</code></br> <em> string </em> 3640 </td> 3641 <td> 3642 <p> 3643 Dest is the JSONPath of a resource key. A path is a series of keys 3644 separated by a dot. The colon character can be escaped with ‘.’ The -1 3645 key can be used to append a value to an existing array. See 3646 <a href="https://github.com/tidwall/sjson#path-syntax">https://github.com/tidwall/sjson#path-syntax</a> 3647 for more information about how this is used. 3648 </p> 3649 </td> 3650 </tr> 3651 <tr> 3652 <td> 3653 <code>operation</code></br> <em> 3654 <a href="#argoproj.io/v1alpha1.TriggerParameterOperation"> 3655 TriggerParameterOperation </a> </em> 3656 </td> 3657 <td> 3658 <p> 3659 Operation is what to do with the existing value at Dest, whether to 3660 ‘prepend’, ‘overwrite’, or ‘append’ it. 3661 </p> 3662 </td> 3663 </tr> 3664 </tbody> 3665 </table> 3666 <h3 id="argoproj.io/v1alpha1.TriggerParameterOperation"> 3667 TriggerParameterOperation (<code>string</code> alias) 3668 </p> 3669 </h3> 3670 <p> 3671 (<em>Appears on:</em> 3672 <a href="#argoproj.io/v1alpha1.TriggerParameter">TriggerParameter</a>) 3673 </p> 3674 <p> 3675 <p> 3676 TriggerParameterOperation represents how to set a trigger destination 3677 resource key 3678 </p> 3679 </p> 3680 <h3 id="argoproj.io/v1alpha1.TriggerParameterSource"> 3681 TriggerParameterSource 3682 </h3> 3683 <p> 3684 (<em>Appears on:</em> 3685 <a href="#argoproj.io/v1alpha1.TriggerParameter">TriggerParameter</a>) 3686 </p> 3687 <p> 3688 <p> 3689 TriggerParameterSource defines the source for a parameter from a event 3690 event 3691 </p> 3692 </p> 3693 <table> 3694 <thead> 3695 <tr> 3696 <th> 3697 Field 3698 </th> 3699 <th> 3700 Description 3701 </th> 3702 </tr> 3703 </thead> 3704 <tbody> 3705 <tr> 3706 <td> 3707 <code>dependencyName</code></br> <em> string </em> 3708 </td> 3709 <td> 3710 <p> 3711 DependencyName refers to the name of the dependency. The event which is 3712 stored for this dependency is used as payload for the parameterization. 3713 Make sure to refer to one of the dependencies you have defined under 3714 Dependencies list. 3715 </p> 3716 </td> 3717 </tr> 3718 <tr> 3719 <td> 3720 <code>contextKey</code></br> <em> string </em> 3721 </td> 3722 <td> 3723 <p> 3724 ContextKey is the JSONPath of the event’s (JSON decoded) context key 3725 ContextKey is a series of keys separated by a dot. A key may contain 3726 wildcard characters ‘\*’ and ‘?’. To access an array value use the index 3727 as the key. The dot and wildcard characters can be escaped with 3728 ‘’. See 3729 <a href="https://github.com/tidwall/gjson#path-syntax">https://github.com/tidwall/gjson#path-syntax</a> 3730 for more information on how to use this. 3731 </p> 3732 </td> 3733 </tr> 3734 <tr> 3735 <td> 3736 <code>contextTemplate</code></br> <em> string </em> 3737 </td> 3738 <td> 3739 <p> 3740 ContextTemplate is a go-template for extracting a string from the 3741 event’s context. If a ContextTemplate is provided with a ContextKey, the 3742 template will be evaluated first and fallback to the ContextKey. The 3743 templating follows the standard go-template syntax as well as sprig’s 3744 extra functions. See 3745 <a href="https://pkg.go.dev/text/template">https://pkg.go.dev/text/template</a> 3746 and 3747 <a href="https://masterminds.github.io/sprig/">https://masterminds.github.io/sprig/</a> 3748 </p> 3749 </td> 3750 </tr> 3751 <tr> 3752 <td> 3753 <code>dataKey</code></br> <em> string </em> 3754 </td> 3755 <td> 3756 <p> 3757 DataKey is the JSONPath of the event’s (JSON decoded) data key DataKey 3758 is a series of keys separated by a dot. A key may contain wildcard 3759 characters ‘\*’ and ‘?’. To access an array value use the index as the 3760 key. The dot and wildcard characters can be escaped with ‘’. See 3761 <a href="https://github.com/tidwall/gjson#path-syntax">https://github.com/tidwall/gjson#path-syntax</a> 3762 for more information on how to use this. 3763 </p> 3764 </td> 3765 </tr> 3766 <tr> 3767 <td> 3768 <code>dataTemplate</code></br> <em> string </em> 3769 </td> 3770 <td> 3771 <p> 3772 DataTemplate is a go-template for extracting a string from the event’s 3773 data. If a DataTemplate is provided with a DataKey, the template will be 3774 evaluated first and fallback to the DataKey. The templating follows the 3775 standard go-template syntax as well as sprig’s extra functions. See 3776 <a href="https://pkg.go.dev/text/template">https://pkg.go.dev/text/template</a> 3777 and 3778 <a href="https://masterminds.github.io/sprig/">https://masterminds.github.io/sprig/</a> 3779 </p> 3780 </td> 3781 </tr> 3782 <tr> 3783 <td> 3784 <code>value</code></br> <em> string </em> 3785 </td> 3786 <td> 3787 <p> 3788 Value is the default literal value to use for this parameter source This 3789 is only used if the DataKey is invalid. If the DataKey is invalid and 3790 this is not defined, this param source will produce an error. 3791 </p> 3792 </td> 3793 </tr> 3794 <tr> 3795 <td> 3796 <code>useRawData</code></br> <em> bool </em> 3797 </td> 3798 <td> 3799 <em>(Optional)</em> 3800 <p> 3801 UseRawData indicates if the value in an event at data key should be used 3802 without converting to string. When true, a number, boolean, json or 3803 string parameter may be extracted. When the field is unspecified, or 3804 explicitly false, the behavior is to turn the extracted field into a 3805 string. (e.g. when set to true, the parameter 123 will resolve to the 3806 numerical type, but when false, or not provided, the string “123” will 3807 be resolved) 3808 </p> 3809 </td> 3810 </tr> 3811 </tbody> 3812 </table> 3813 <h3 id="argoproj.io/v1alpha1.TriggerPolicy"> 3814 TriggerPolicy 3815 </h3> 3816 <p> 3817 (<em>Appears on:</em> 3818 <a href="#argoproj.io/v1alpha1.Trigger">Trigger</a>) 3819 </p> 3820 <p> 3821 <p> 3822 TriggerPolicy dictates the policy for the trigger retries 3823 </p> 3824 </p> 3825 <table> 3826 <thead> 3827 <tr> 3828 <th> 3829 Field 3830 </th> 3831 <th> 3832 Description 3833 </th> 3834 </tr> 3835 </thead> 3836 <tbody> 3837 <tr> 3838 <td> 3839 <code>k8s</code></br> <em> 3840 <a href="#argoproj.io/v1alpha1.K8SResourcePolicy"> K8SResourcePolicy 3841 </a> </em> 3842 </td> 3843 <td> 3844 <p> 3845 K8SResourcePolicy refers to the policy used to check the state of K8s 3846 based triggers using using labels 3847 </p> 3848 </td> 3849 </tr> 3850 <tr> 3851 <td> 3852 <code>status</code></br> <em> 3853 <a href="#argoproj.io/v1alpha1.StatusPolicy"> StatusPolicy </a> </em> 3854 </td> 3855 <td> 3856 <p> 3857 Status refers to the policy used to check the state of the trigger using 3858 response status 3859 </p> 3860 </td> 3861 </tr> 3862 </tbody> 3863 </table> 3864 <h3 id="argoproj.io/v1alpha1.TriggerTemplate"> 3865 TriggerTemplate 3866 </h3> 3867 <p> 3868 (<em>Appears on:</em> 3869 <a href="#argoproj.io/v1alpha1.Trigger">Trigger</a>) 3870 </p> 3871 <p> 3872 <p> 3873 TriggerTemplate is the template that describes trigger specification. 3874 </p> 3875 </p> 3876 <table> 3877 <thead> 3878 <tr> 3879 <th> 3880 Field 3881 </th> 3882 <th> 3883 Description 3884 </th> 3885 </tr> 3886 </thead> 3887 <tbody> 3888 <tr> 3889 <td> 3890 <code>name</code></br> <em> string </em> 3891 </td> 3892 <td> 3893 <p> 3894 Name is a unique name of the action to take. 3895 </p> 3896 </td> 3897 </tr> 3898 <tr> 3899 <td> 3900 <code>conditions</code></br> <em> string </em> 3901 </td> 3902 <td> 3903 <em>(Optional)</em> 3904 <p> 3905 Conditions is the conditions to execute the trigger. For example: 3906 “(dep01 \|\| dep02) && dep04” 3907 </p> 3908 </td> 3909 </tr> 3910 <tr> 3911 <td> 3912 <code>k8s</code></br> <em> 3913 <a href="#argoproj.io/v1alpha1.StandardK8STrigger"> StandardK8STrigger 3914 </a> </em> 3915 </td> 3916 <td> 3917 <em>(Optional)</em> 3918 <p> 3919 StandardK8STrigger refers to the trigger designed to create or update a 3920 generic Kubernetes resource. 3921 </p> 3922 </td> 3923 </tr> 3924 <tr> 3925 <td> 3926 <code>argoWorkflow</code></br> <em> 3927 <a href="#argoproj.io/v1alpha1.ArgoWorkflowTrigger"> ArgoWorkflowTrigger 3928 </a> </em> 3929 </td> 3930 <td> 3931 <em>(Optional)</em> 3932 <p> 3933 ArgoWorkflow refers to the trigger that can perform various operations 3934 on an Argo workflow. 3935 </p> 3936 </td> 3937 </tr> 3938 <tr> 3939 <td> 3940 <code>http</code></br> <em> <a href="#argoproj.io/v1alpha1.HTTPTrigger"> 3941 HTTPTrigger </a> </em> 3942 </td> 3943 <td> 3944 <em>(Optional)</em> 3945 <p> 3946 HTTP refers to the trigger designed to dispatch a HTTP request with 3947 on-the-fly constructable payload. 3948 </p> 3949 </td> 3950 </tr> 3951 <tr> 3952 <td> 3953 <code>awsLambda</code></br> <em> 3954 <a href="#argoproj.io/v1alpha1.AWSLambdaTrigger"> AWSLambdaTrigger </a> 3955 </em> 3956 </td> 3957 <td> 3958 <em>(Optional)</em> 3959 <p> 3960 AWSLambda refers to the trigger designed to invoke AWS Lambda function 3961 with with on-the-fly constructable payload. 3962 </p> 3963 </td> 3964 </tr> 3965 <tr> 3966 <td> 3967 <code>custom</code></br> <em> 3968 <a href="#argoproj.io/v1alpha1.CustomTrigger"> CustomTrigger </a> </em> 3969 </td> 3970 <td> 3971 <em>(Optional)</em> 3972 <p> 3973 CustomTrigger refers to the trigger designed to connect to a gRPC 3974 trigger server and execute a custom trigger. 3975 </p> 3976 </td> 3977 </tr> 3978 <tr> 3979 <td> 3980 <code>kafka</code></br> <em> 3981 <a href="#argoproj.io/v1alpha1.KafkaTrigger"> KafkaTrigger </a> </em> 3982 </td> 3983 <td> 3984 <p> 3985 Kafka refers to the trigger designed to place messages on Kafka topic. 3986 </p> 3987 </td> 3988 </tr> 3989 <tr> 3990 <td> 3991 <code>nats</code></br> <em> <a href="#argoproj.io/v1alpha1.NATSTrigger"> 3992 NATSTrigger </a> </em> 3993 </td> 3994 <td> 3995 <p> 3996 NATS refers to the trigger designed to place message on NATS subject. 3997 </p> 3998 </td> 3999 </tr> 4000 <tr> 4001 <td> 4002 <code>slack</code></br> <em> 4003 <a href="#argoproj.io/v1alpha1.SlackTrigger"> SlackTrigger </a> </em> 4004 </td> 4005 <td> 4006 <em>(Optional)</em> 4007 <p> 4008 Slack refers to the trigger designed to send slack notification message. 4009 </p> 4010 </td> 4011 </tr> 4012 <tr> 4013 <td> 4014 <code>openWhisk</code></br> <em> 4015 <a href="#argoproj.io/v1alpha1.OpenWhiskTrigger"> OpenWhiskTrigger </a> 4016 </em> 4017 </td> 4018 <td> 4019 <em>(Optional)</em> 4020 <p> 4021 OpenWhisk refers to the trigger designed to invoke OpenWhisk action. 4022 </p> 4023 </td> 4024 </tr> 4025 <tr> 4026 <td> 4027 <code>log</code></br> <em> <a href="#argoproj.io/v1alpha1.LogTrigger"> 4028 LogTrigger </a> </em> 4029 </td> 4030 <td> 4031 <em>(Optional)</em> 4032 <p> 4033 Log refers to the trigger designed to invoke log the event. 4034 </p> 4035 </td> 4036 </tr> 4037 <tr> 4038 <td> 4039 <code>azureEventHubs</code></br> <em> 4040 <a href="#argoproj.io/v1alpha1.AzureEventHubsTrigger"> 4041 AzureEventHubsTrigger </a> </em> 4042 </td> 4043 <td> 4044 <em>(Optional)</em> 4045 <p> 4046 AzureEventHubs refers to the trigger send an event to an Azure Event 4047 Hub. 4048 </p> 4049 </td> 4050 </tr> 4051 <tr> 4052 <td> 4053 <code>pulsar</code></br> <em> 4054 <a href="#argoproj.io/v1alpha1.PulsarTrigger"> PulsarTrigger </a> </em> 4055 </td> 4056 <td> 4057 <em>(Optional)</em> 4058 <p> 4059 Pulsar refers to the trigger designed to place messages on Pulsar topic. 4060 </p> 4061 </td> 4062 </tr> 4063 <tr> 4064 <td> 4065 <code>conditionsReset</code></br> <em> 4066 <a href="#argoproj.io/v1alpha1.ConditionsResetCriteria"> 4067 \[\]ConditionsResetCriteria </a> </em> 4068 </td> 4069 <td> 4070 <em>(Optional)</em> 4071 <p> 4072 Criteria to reset the conditons 4073 </p> 4074 </td> 4075 </tr> 4076 <tr> 4077 <td> 4078 <code>azureServiceBus</code></br> <em> 4079 <a href="#argoproj.io/v1alpha1.AzureServiceBusTrigger"> 4080 AzureServiceBusTrigger </a> </em> 4081 </td> 4082 <td> 4083 <em>(Optional)</em> 4084 <p> 4085 AzureServiceBus refers to the trigger designed to place messages on 4086 Azure Service Bus 4087 </p> 4088 </td> 4089 </tr> 4090 <tr> 4091 <td> 4092 <code>email</code></br> <em> 4093 <a href="#argoproj.io/v1alpha1.EmailTrigger"> EmailTrigger </a> </em> 4094 </td> 4095 <td> 4096 <em>(Optional)</em> 4097 <p> 4098 Email refers to the trigger designed to send an email notification 4099 </p> 4100 </td> 4101 </tr> 4102 </tbody> 4103 </table> 4104 <h3 id="argoproj.io/v1alpha1.URLArtifact"> 4105 URLArtifact 4106 </h3> 4107 <p> 4108 (<em>Appears on:</em> 4109 <a href="#argoproj.io/v1alpha1.ArtifactLocation">ArtifactLocation</a>) 4110 </p> 4111 <p> 4112 <p> 4113 URLArtifact contains information about an artifact at an http endpoint. 4114 </p> 4115 </p> 4116 <table> 4117 <thead> 4118 <tr> 4119 <th> 4120 Field 4121 </th> 4122 <th> 4123 Description 4124 </th> 4125 </tr> 4126 </thead> 4127 <tbody> 4128 <tr> 4129 <td> 4130 <code>path</code></br> <em> string </em> 4131 </td> 4132 <td> 4133 <p> 4134 Path is the complete URL 4135 </p> 4136 </td> 4137 </tr> 4138 <tr> 4139 <td> 4140 <code>verifyCert</code></br> <em> bool </em> 4141 </td> 4142 <td> 4143 <p> 4144 VerifyCert decides whether the connection is secure or not 4145 </p> 4146 </td> 4147 </tr> 4148 </tbody> 4149 </table> 4150 <hr/> 4151 <p> 4152 <em> Generated with <code>gen-crd-api-reference-docs</code>. </em> 4153 </p>