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