github.com/argoproj/argo-events@v1.9.1/api/event-source.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.AMQPConsumeConfig">AMQPConsumeConfig 14 </h3> 15 <p> 16 (<em>Appears on:</em> 17 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 18 </p> 19 <p> 20 <p>AMQPConsumeConfig holds the configuration to immediately starts delivering queued messages</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>consumerTag</code></br> 33 <em> 34 string 35 </em> 36 </td> 37 <td> 38 <em>(Optional)</em> 39 <p>ConsumerTag is the identity of the consumer included in every delivery</p> 40 </td> 41 </tr> 42 <tr> 43 <td> 44 <code>autoAck</code></br> 45 <em> 46 bool 47 </em> 48 </td> 49 <td> 50 <em>(Optional)</em> 51 <p>AutoAck when true, the server will acknowledge deliveries to this consumer prior to writing 52 the delivery to the network</p> 53 </td> 54 </tr> 55 <tr> 56 <td> 57 <code>exclusive</code></br> 58 <em> 59 bool 60 </em> 61 </td> 62 <td> 63 <em>(Optional)</em> 64 <p>Exclusive when true, the server will ensure that this is the sole consumer from this queue</p> 65 </td> 66 </tr> 67 <tr> 68 <td> 69 <code>noLocal</code></br> 70 <em> 71 bool 72 </em> 73 </td> 74 <td> 75 <em>(Optional)</em> 76 <p>NoLocal flag is not supported by RabbitMQ</p> 77 </td> 78 </tr> 79 <tr> 80 <td> 81 <code>noWait</code></br> 82 <em> 83 bool 84 </em> 85 </td> 86 <td> 87 <em>(Optional)</em> 88 <p>NowWait when true, do not wait for the server to confirm the request and immediately begin deliveries</p> 89 </td> 90 </tr> 91 </tbody> 92 </table> 93 <h3 id="argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource 94 </h3> 95 <p> 96 (<em>Appears on:</em> 97 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 98 </p> 99 <p> 100 <p>AMQPEventSource refers to an event-source for AMQP stream events</p> 101 </p> 102 <table> 103 <thead> 104 <tr> 105 <th>Field</th> 106 <th>Description</th> 107 </tr> 108 </thead> 109 <tbody> 110 <tr> 111 <td> 112 <code>url</code></br> 113 <em> 114 string 115 </em> 116 </td> 117 <td> 118 <p>URL for rabbitmq service</p> 119 </td> 120 </tr> 121 <tr> 122 <td> 123 <code>exchangeName</code></br> 124 <em> 125 string 126 </em> 127 </td> 128 <td> 129 <p>ExchangeName is the exchange name 130 For more information, visit <a href="https://www.rabbitmq.com/tutorials/amqp-concepts.html">https://www.rabbitmq.com/tutorials/amqp-concepts.html</a></p> 131 </td> 132 </tr> 133 <tr> 134 <td> 135 <code>exchangeType</code></br> 136 <em> 137 string 138 </em> 139 </td> 140 <td> 141 <p>ExchangeType is rabbitmq exchange type</p> 142 </td> 143 </tr> 144 <tr> 145 <td> 146 <code>routingKey</code></br> 147 <em> 148 string 149 </em> 150 </td> 151 <td> 152 <p>Routing key for bindings</p> 153 </td> 154 </tr> 155 <tr> 156 <td> 157 <code>connectionBackoff</code></br> 158 <em> 159 github.com/argoproj/argo-events/pkg/apis/common.Backoff 160 </em> 161 </td> 162 <td> 163 <em>(Optional)</em> 164 <p>Backoff holds parameters applied to connection.</p> 165 </td> 166 </tr> 167 <tr> 168 <td> 169 <code>jsonBody</code></br> 170 <em> 171 bool 172 </em> 173 </td> 174 <td> 175 <em>(Optional)</em> 176 <p>JSONBody specifies that all event body payload coming from this 177 source will be JSON</p> 178 </td> 179 </tr> 180 <tr> 181 <td> 182 <code>tls</code></br> 183 <em> 184 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 185 </em> 186 </td> 187 <td> 188 <em>(Optional)</em> 189 <p>TLS configuration for the amqp client.</p> 190 </td> 191 </tr> 192 <tr> 193 <td> 194 <code>metadata</code></br> 195 <em> 196 map[string]string 197 </em> 198 </td> 199 <td> 200 <em>(Optional)</em> 201 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 202 </td> 203 </tr> 204 <tr> 205 <td> 206 <code>exchangeDeclare</code></br> 207 <em> 208 <a href="#argoproj.io/v1alpha1.AMQPExchangeDeclareConfig"> 209 AMQPExchangeDeclareConfig 210 </a> 211 </em> 212 </td> 213 <td> 214 <em>(Optional)</em> 215 <p>ExchangeDeclare holds the configuration for the exchange on the server 216 For more information, visit <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare</a></p> 217 </td> 218 </tr> 219 <tr> 220 <td> 221 <code>queueDeclare</code></br> 222 <em> 223 <a href="#argoproj.io/v1alpha1.AMQPQueueDeclareConfig"> 224 AMQPQueueDeclareConfig 225 </a> 226 </em> 227 </td> 228 <td> 229 <em>(Optional)</em> 230 <p>QueueDeclare holds the configuration of a queue to hold messages and deliver to consumers. 231 Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches 232 the same parameters 233 For more information, visit <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare</a></p> 234 </td> 235 </tr> 236 <tr> 237 <td> 238 <code>queueBind</code></br> 239 <em> 240 <a href="#argoproj.io/v1alpha1.AMQPQueueBindConfig"> 241 AMQPQueueBindConfig 242 </a> 243 </em> 244 </td> 245 <td> 246 <em>(Optional)</em> 247 <p>QueueBind holds the configuration that binds an exchange to a queue so that publishings to the 248 exchange will be routed to the queue when the publishing routing key matches the binding routing key 249 For more information, visit <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind</a></p> 250 </td> 251 </tr> 252 <tr> 253 <td> 254 <code>consume</code></br> 255 <em> 256 <a href="#argoproj.io/v1alpha1.AMQPConsumeConfig"> 257 AMQPConsumeConfig 258 </a> 259 </em> 260 </td> 261 <td> 262 <em>(Optional)</em> 263 <p>Consume holds the configuration to immediately starts delivering queued messages 264 For more information, visit <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume">https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume</a></p> 265 </td> 266 </tr> 267 <tr> 268 <td> 269 <code>auth</code></br> 270 <em> 271 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth 272 </em> 273 </td> 274 <td> 275 <em>(Optional)</em> 276 <p>Auth hosts secret selectors for username and password</p> 277 </td> 278 </tr> 279 <tr> 280 <td> 281 <code>urlSecret</code></br> 282 <em> 283 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 284 Kubernetes core/v1.SecretKeySelector 285 </a> 286 </em> 287 </td> 288 <td> 289 <p>URLSecret is secret reference for rabbitmq service URL</p> 290 </td> 291 </tr> 292 <tr> 293 <td> 294 <code>filter</code></br> 295 <em> 296 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 297 EventSourceFilter 298 </a> 299 </em> 300 </td> 301 <td> 302 <em>(Optional)</em> 303 <p>Filter</p> 304 </td> 305 </tr> 306 </tbody> 307 </table> 308 <h3 id="argoproj.io/v1alpha1.AMQPExchangeDeclareConfig">AMQPExchangeDeclareConfig 309 </h3> 310 <p> 311 (<em>Appears on:</em> 312 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 313 </p> 314 <p> 315 <p>AMQPExchangeDeclareConfig holds the configuration for the exchange on the server</p> 316 </p> 317 <table> 318 <thead> 319 <tr> 320 <th>Field</th> 321 <th>Description</th> 322 </tr> 323 </thead> 324 <tbody> 325 <tr> 326 <td> 327 <code>durable</code></br> 328 <em> 329 bool 330 </em> 331 </td> 332 <td> 333 <em>(Optional)</em> 334 <p>Durable keeps the exchange also after the server restarts</p> 335 </td> 336 </tr> 337 <tr> 338 <td> 339 <code>autoDelete</code></br> 340 <em> 341 bool 342 </em> 343 </td> 344 <td> 345 <em>(Optional)</em> 346 <p>AutoDelete removes the exchange when no bindings are active</p> 347 </td> 348 </tr> 349 <tr> 350 <td> 351 <code>internal</code></br> 352 <em> 353 bool 354 </em> 355 </td> 356 <td> 357 <em>(Optional)</em> 358 <p>Internal when true does not accept publishings</p> 359 </td> 360 </tr> 361 <tr> 362 <td> 363 <code>noWait</code></br> 364 <em> 365 bool 366 </em> 367 </td> 368 <td> 369 <em>(Optional)</em> 370 <p>NowWait when true does not wait for a confirmation from the server</p> 371 </td> 372 </tr> 373 </tbody> 374 </table> 375 <h3 id="argoproj.io/v1alpha1.AMQPQueueBindConfig">AMQPQueueBindConfig 376 </h3> 377 <p> 378 (<em>Appears on:</em> 379 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 380 </p> 381 <p> 382 <p>AMQPQueueBindConfig holds the configuration that binds an exchange to a queue so that publishings to the 383 exchange will be routed to the queue when the publishing routing key matches the binding routing key</p> 384 </p> 385 <table> 386 <thead> 387 <tr> 388 <th>Field</th> 389 <th>Description</th> 390 </tr> 391 </thead> 392 <tbody> 393 <tr> 394 <td> 395 <code>noWait</code></br> 396 <em> 397 bool 398 </em> 399 </td> 400 <td> 401 <em>(Optional)</em> 402 <p>NowWait false and the queue could not be bound, the channel will be closed with an error</p> 403 </td> 404 </tr> 405 </tbody> 406 </table> 407 <h3 id="argoproj.io/v1alpha1.AMQPQueueDeclareConfig">AMQPQueueDeclareConfig 408 </h3> 409 <p> 410 (<em>Appears on:</em> 411 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>) 412 </p> 413 <p> 414 <p>AMQPQueueDeclareConfig holds the configuration of a queue to hold messages and deliver to consumers. 415 Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches 416 the same parameters</p> 417 </p> 418 <table> 419 <thead> 420 <tr> 421 <th>Field</th> 422 <th>Description</th> 423 </tr> 424 </thead> 425 <tbody> 426 <tr> 427 <td> 428 <code>name</code></br> 429 <em> 430 string 431 </em> 432 </td> 433 <td> 434 <em>(Optional)</em> 435 <p>Name of the queue. If empty the server auto-generates a unique name for this queue</p> 436 </td> 437 </tr> 438 <tr> 439 <td> 440 <code>durable</code></br> 441 <em> 442 bool 443 </em> 444 </td> 445 <td> 446 <em>(Optional)</em> 447 <p>Durable keeps the queue also after the server restarts</p> 448 </td> 449 </tr> 450 <tr> 451 <td> 452 <code>autoDelete</code></br> 453 <em> 454 bool 455 </em> 456 </td> 457 <td> 458 <em>(Optional)</em> 459 <p>AutoDelete removes the queue when no consumers are active</p> 460 </td> 461 </tr> 462 <tr> 463 <td> 464 <code>exclusive</code></br> 465 <em> 466 bool 467 </em> 468 </td> 469 <td> 470 <em>(Optional)</em> 471 <p>Exclusive sets the queues to be accessible only by the connection that declares them and will be 472 deleted wgen the connection closes</p> 473 </td> 474 </tr> 475 <tr> 476 <td> 477 <code>noWait</code></br> 478 <em> 479 bool 480 </em> 481 </td> 482 <td> 483 <em>(Optional)</em> 484 <p>NowWait when true, the queue assumes to be declared on the server</p> 485 </td> 486 </tr> 487 <tr> 488 <td> 489 <code>arguments</code></br> 490 <em> 491 string 492 </em> 493 </td> 494 <td> 495 <em>(Optional)</em> 496 <p>Arguments of a queue (also known as “x-arguments”) used for optional features and plugins</p> 497 </td> 498 </tr> 499 </tbody> 500 </table> 501 <h3 id="argoproj.io/v1alpha1.AzureEventsHubEventSource">AzureEventsHubEventSource 502 </h3> 503 <p> 504 (<em>Appears on:</em> 505 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 506 </p> 507 <p> 508 <p>AzureEventsHubEventSource describes the event source for azure events hub 509 More info at <a href="https://docs.microsoft.com/en-us/azure/event-hubs/">https://docs.microsoft.com/en-us/azure/event-hubs/</a></p> 510 </p> 511 <table> 512 <thead> 513 <tr> 514 <th>Field</th> 515 <th>Description</th> 516 </tr> 517 </thead> 518 <tbody> 519 <tr> 520 <td> 521 <code>fqdn</code></br> 522 <em> 523 string 524 </em> 525 </td> 526 <td> 527 <p>FQDN of the EventHubs namespace you created 528 More info at <a href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string">https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string</a></p> 529 </td> 530 </tr> 531 <tr> 532 <td> 533 <code>sharedAccessKeyName</code></br> 534 <em> 535 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 536 Kubernetes core/v1.SecretKeySelector 537 </a> 538 </em> 539 </td> 540 <td> 541 <p>SharedAccessKeyName is the name you chose for your application’s SAS keys</p> 542 </td> 543 </tr> 544 <tr> 545 <td> 546 <code>sharedAccessKey</code></br> 547 <em> 548 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 549 Kubernetes core/v1.SecretKeySelector 550 </a> 551 </em> 552 </td> 553 <td> 554 <p>SharedAccessKey is the generated value of the key</p> 555 </td> 556 </tr> 557 <tr> 558 <td> 559 <code>hubName</code></br> 560 <em> 561 string 562 </em> 563 </td> 564 <td> 565 <p>Event Hub path/name</p> 566 </td> 567 </tr> 568 <tr> 569 <td> 570 <code>metadata</code></br> 571 <em> 572 map[string]string 573 </em> 574 </td> 575 <td> 576 <em>(Optional)</em> 577 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 578 </td> 579 </tr> 580 <tr> 581 <td> 582 <code>filter</code></br> 583 <em> 584 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 585 EventSourceFilter 586 </a> 587 </em> 588 </td> 589 <td> 590 <em>(Optional)</em> 591 <p>Filter</p> 592 </td> 593 </tr> 594 </tbody> 595 </table> 596 <h3 id="argoproj.io/v1alpha1.AzureQueueStorageEventSource">AzureQueueStorageEventSource 597 </h3> 598 <p> 599 (<em>Appears on:</em> 600 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 601 </p> 602 <p> 603 <p>AzureQueueStorageEventSource describes the event source for azure queue storage 604 more info at <a href="https://learn.microsoft.com/en-us/azure/storage/queues/">https://learn.microsoft.com/en-us/azure/storage/queues/</a></p> 605 </p> 606 <table> 607 <thead> 608 <tr> 609 <th>Field</th> 610 <th>Description</th> 611 </tr> 612 </thead> 613 <tbody> 614 <tr> 615 <td> 616 <code>storageAccountName</code></br> 617 <em> 618 string 619 </em> 620 </td> 621 <td> 622 <em>(Optional)</em> 623 <p>StorageAccountName is the name of the storage account where the queue is. This field is necessary to 624 access via Azure AD (managed identity) and it is ignored if ConnectionString is set.</p> 625 </td> 626 </tr> 627 <tr> 628 <td> 629 <code>connectionString</code></br> 630 <em> 631 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 632 Kubernetes core/v1.SecretKeySelector 633 </a> 634 </em> 635 </td> 636 <td> 637 <em>(Optional)</em> 638 <p>ConnectionString is the connection string to access Azure Queue Storage. If this fields is not provided 639 it will try to access via Azure AD with StorageAccountName.</p> 640 </td> 641 </tr> 642 <tr> 643 <td> 644 <code>queueName</code></br> 645 <em> 646 string 647 </em> 648 </td> 649 <td> 650 <p>QueueName is the name of the queue</p> 651 </td> 652 </tr> 653 <tr> 654 <td> 655 <code>jsonBody</code></br> 656 <em> 657 bool 658 </em> 659 </td> 660 <td> 661 <em>(Optional)</em> 662 <p>JSONBody specifies that all event body payload coming from this 663 source will be JSON</p> 664 </td> 665 </tr> 666 <tr> 667 <td> 668 <code>dlq</code></br> 669 <em> 670 bool 671 </em> 672 </td> 673 <td> 674 <em>(Optional)</em> 675 <p>DLQ specifies if a dead-letter queue is configured for messages that can’t be processed successfully. 676 If set to true, messages with invalid payload won’t be acknowledged to allow to forward them farther to the dead-letter queue. 677 The default value is false.</p> 678 </td> 679 </tr> 680 <tr> 681 <td> 682 <code>metadata</code></br> 683 <em> 684 map[string]string 685 </em> 686 </td> 687 <td> 688 <em>(Optional)</em> 689 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 690 </td> 691 </tr> 692 <tr> 693 <td> 694 <code>filter</code></br> 695 <em> 696 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 697 EventSourceFilter 698 </a> 699 </em> 700 </td> 701 <td> 702 <em>(Optional)</em> 703 <p>Filter</p> 704 </td> 705 </tr> 706 <tr> 707 <td> 708 <code>decodeMessage</code></br> 709 <em> 710 bool 711 </em> 712 </td> 713 <td> 714 <em>(Optional)</em> 715 <p>DecodeMessage specifies if all the messages should be base64 decoded. 716 If set to true the decoding is done before the evaluation of JSONBody</p> 717 </td> 718 </tr> 719 <tr> 720 <td> 721 <code>waitTimeInSeconds</code></br> 722 <em> 723 int32 724 </em> 725 </td> 726 <td> 727 <em>(Optional)</em> 728 <p>WaitTimeInSeconds is the duration (in seconds) for which the event source waits between empty results from the queue. 729 The default value is 3 seconds.</p> 730 </td> 731 </tr> 732 </tbody> 733 </table> 734 <h3 id="argoproj.io/v1alpha1.AzureServiceBusEventSource">AzureServiceBusEventSource 735 </h3> 736 <p> 737 (<em>Appears on:</em> 738 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 739 </p> 740 <p> 741 <p>AzureServiceBusEventSource describes the event source for azure service bus 742 More info at <a href="https://docs.microsoft.com/en-us/azure/service-bus-messaging/">https://docs.microsoft.com/en-us/azure/service-bus-messaging/</a></p> 743 </p> 744 <table> 745 <thead> 746 <tr> 747 <th>Field</th> 748 <th>Description</th> 749 </tr> 750 </thead> 751 <tbody> 752 <tr> 753 <td> 754 <code>connectionString</code></br> 755 <em> 756 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 757 Kubernetes core/v1.SecretKeySelector 758 </a> 759 </em> 760 </td> 761 <td> 762 <em>(Optional)</em> 763 <p>ConnectionString is the connection string for the Azure Service Bus. If this fields is not provided 764 it will try to access via Azure AD with DefaultAzureCredential and FullyQualifiedNamespace.</p> 765 </td> 766 </tr> 767 <tr> 768 <td> 769 <code>queueName</code></br> 770 <em> 771 string 772 </em> 773 </td> 774 <td> 775 <p>QueueName is the name of the Azure Service Bus Queue</p> 776 </td> 777 </tr> 778 <tr> 779 <td> 780 <code>topicName</code></br> 781 <em> 782 string 783 </em> 784 </td> 785 <td> 786 <p>TopicName is the name of the Azure Service Bus Topic</p> 787 </td> 788 </tr> 789 <tr> 790 <td> 791 <code>subscriptionName</code></br> 792 <em> 793 string 794 </em> 795 </td> 796 <td> 797 <p>SubscriptionName is the name of the Azure Service Bus Topic Subscription</p> 798 </td> 799 </tr> 800 <tr> 801 <td> 802 <code>tls</code></br> 803 <em> 804 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 805 </em> 806 </td> 807 <td> 808 <em>(Optional)</em> 809 <p>TLS configuration for the service bus client</p> 810 </td> 811 </tr> 812 <tr> 813 <td> 814 <code>jsonBody</code></br> 815 <em> 816 bool 817 </em> 818 </td> 819 <td> 820 <em>(Optional)</em> 821 <p>JSONBody specifies that all event body payload coming from this 822 source will be JSON</p> 823 </td> 824 </tr> 825 <tr> 826 <td> 827 <code>metadata</code></br> 828 <em> 829 map[string]string 830 </em> 831 </td> 832 <td> 833 <em>(Optional)</em> 834 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 835 </td> 836 </tr> 837 <tr> 838 <td> 839 <code>filter</code></br> 840 <em> 841 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 842 EventSourceFilter 843 </a> 844 </em> 845 </td> 846 <td> 847 <em>(Optional)</em> 848 <p>Filter</p> 849 </td> 850 </tr> 851 <tr> 852 <td> 853 <code>fullyQualifiedNamespace</code></br> 854 <em> 855 string 856 </em> 857 </td> 858 <td> 859 <em>(Optional)</em> 860 <p>FullyQualifiedNamespace is the Service Bus namespace name (ex: myservicebus.servicebus.windows.net). This field is necessary to 861 access via Azure AD (managed identity) and it is ignored if ConnectionString is set.</p> 862 </td> 863 </tr> 864 </tbody> 865 </table> 866 <h3 id="argoproj.io/v1alpha1.BitbucketAuth">BitbucketAuth 867 </h3> 868 <p> 869 (<em>Appears on:</em> 870 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>) 871 </p> 872 <p> 873 <p>BitbucketAuth holds the different auth strategies for connecting to Bitbucket</p> 874 </p> 875 <table> 876 <thead> 877 <tr> 878 <th>Field</th> 879 <th>Description</th> 880 </tr> 881 </thead> 882 <tbody> 883 <tr> 884 <td> 885 <code>basic</code></br> 886 <em> 887 <a href="#argoproj.io/v1alpha1.BitbucketBasicAuth"> 888 BitbucketBasicAuth 889 </a> 890 </em> 891 </td> 892 <td> 893 <em>(Optional)</em> 894 <p>Basic is BasicAuth auth strategy.</p> 895 </td> 896 </tr> 897 <tr> 898 <td> 899 <code>oauthToken</code></br> 900 <em> 901 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 902 Kubernetes core/v1.SecretKeySelector 903 </a> 904 </em> 905 </td> 906 <td> 907 <em>(Optional)</em> 908 <p>OAuthToken refers to the K8s secret that holds the OAuth Bearer token.</p> 909 </td> 910 </tr> 911 </tbody> 912 </table> 913 <h3 id="argoproj.io/v1alpha1.BitbucketBasicAuth">BitbucketBasicAuth 914 </h3> 915 <p> 916 (<em>Appears on:</em> 917 <a href="#argoproj.io/v1alpha1.BitbucketAuth">BitbucketAuth</a>) 918 </p> 919 <p> 920 <p>BasicAuth holds the information required to authenticate user via basic auth mechanism</p> 921 </p> 922 <table> 923 <thead> 924 <tr> 925 <th>Field</th> 926 <th>Description</th> 927 </tr> 928 </thead> 929 <tbody> 930 <tr> 931 <td> 932 <code>username</code></br> 933 <em> 934 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 935 Kubernetes core/v1.SecretKeySelector 936 </a> 937 </em> 938 </td> 939 <td> 940 <p>Username refers to the K8s secret that holds the username.</p> 941 </td> 942 </tr> 943 <tr> 944 <td> 945 <code>password</code></br> 946 <em> 947 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 948 Kubernetes core/v1.SecretKeySelector 949 </a> 950 </em> 951 </td> 952 <td> 953 <p>Password refers to the K8s secret that holds the password.</p> 954 </td> 955 </tr> 956 </tbody> 957 </table> 958 <h3 id="argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource 959 </h3> 960 <p> 961 (<em>Appears on:</em> 962 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 963 </p> 964 <p> 965 <p>BitbucketEventSource describes the event source for Bitbucket</p> 966 </p> 967 <table> 968 <thead> 969 <tr> 970 <th>Field</th> 971 <th>Description</th> 972 </tr> 973 </thead> 974 <tbody> 975 <tr> 976 <td> 977 <code>deleteHookOnFinish</code></br> 978 <em> 979 bool 980 </em> 981 </td> 982 <td> 983 <em>(Optional)</em> 984 <p>DeleteHookOnFinish determines whether to delete the defined Bitbucket hook once the event source is stopped.</p> 985 </td> 986 </tr> 987 <tr> 988 <td> 989 <code>metadata</code></br> 990 <em> 991 map[string]string 992 </em> 993 </td> 994 <td> 995 <em>(Optional)</em> 996 <p>Metadata holds the user defined metadata which will be passed along the event payload.</p> 997 </td> 998 </tr> 999 <tr> 1000 <td> 1001 <code>webhook</code></br> 1002 <em> 1003 <a href="#argoproj.io/v1alpha1.WebhookContext"> 1004 WebhookContext 1005 </a> 1006 </em> 1007 </td> 1008 <td> 1009 <p>Webhook refers to the configuration required to run an http server</p> 1010 </td> 1011 </tr> 1012 <tr> 1013 <td> 1014 <code>auth</code></br> 1015 <em> 1016 <a href="#argoproj.io/v1alpha1.BitbucketAuth"> 1017 BitbucketAuth 1018 </a> 1019 </em> 1020 </td> 1021 <td> 1022 <p>Auth information required to connect to Bitbucket.</p> 1023 </td> 1024 </tr> 1025 <tr> 1026 <td> 1027 <code>events</code></br> 1028 <em> 1029 []string 1030 </em> 1031 </td> 1032 <td> 1033 <p>Events this webhook is subscribed to.</p> 1034 </td> 1035 </tr> 1036 <tr> 1037 <td> 1038 <code>owner</code></br> 1039 <em> 1040 string 1041 </em> 1042 </td> 1043 <td> 1044 <em>(Optional)</em> 1045 <p>DeprecatedOwner is the owner of the repository. 1046 Deprecated: use Repositories instead. Will be unsupported in v1.9</p> 1047 </td> 1048 </tr> 1049 <tr> 1050 <td> 1051 <code>projectKey</code></br> 1052 <em> 1053 string 1054 </em> 1055 </td> 1056 <td> 1057 <em>(Optional)</em> 1058 <p>DeprecatedProjectKey is the key of the project to which the repository relates 1059 Deprecated: use Repositories instead. Will be unsupported in v1.9</p> 1060 </td> 1061 </tr> 1062 <tr> 1063 <td> 1064 <code>repositorySlug</code></br> 1065 <em> 1066 string 1067 </em> 1068 </td> 1069 <td> 1070 <em>(Optional)</em> 1071 <p>DeprecatedRepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL 1072 Deprecated: use Repositories instead. Will be unsupported in v1.9</p> 1073 </td> 1074 </tr> 1075 <tr> 1076 <td> 1077 <code>repositories</code></br> 1078 <em> 1079 <a href="#argoproj.io/v1alpha1.BitbucketRepository"> 1080 []BitbucketRepository 1081 </a> 1082 </em> 1083 </td> 1084 <td> 1085 <em>(Optional)</em> 1086 <p>Repositories holds a list of repositories for which integration needs to set up</p> 1087 </td> 1088 </tr> 1089 <tr> 1090 <td> 1091 <code>filter</code></br> 1092 <em> 1093 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 1094 EventSourceFilter 1095 </a> 1096 </em> 1097 </td> 1098 <td> 1099 <em>(Optional)</em> 1100 <p>Filter</p> 1101 </td> 1102 </tr> 1103 </tbody> 1104 </table> 1105 <h3 id="argoproj.io/v1alpha1.BitbucketRepository">BitbucketRepository 1106 </h3> 1107 <p> 1108 (<em>Appears on:</em> 1109 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>) 1110 </p> 1111 <p> 1112 </p> 1113 <table> 1114 <thead> 1115 <tr> 1116 <th>Field</th> 1117 <th>Description</th> 1118 </tr> 1119 </thead> 1120 <tbody> 1121 <tr> 1122 <td> 1123 <code>owner</code></br> 1124 <em> 1125 string 1126 </em> 1127 </td> 1128 <td> 1129 <p>Owner is the owner of the repository</p> 1130 </td> 1131 </tr> 1132 <tr> 1133 <td> 1134 <code>repositorySlug</code></br> 1135 <em> 1136 string 1137 </em> 1138 </td> 1139 <td> 1140 <p>RepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL</p> 1141 </td> 1142 </tr> 1143 </tbody> 1144 </table> 1145 <h3 id="argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource 1146 </h3> 1147 <p> 1148 (<em>Appears on:</em> 1149 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1150 </p> 1151 <p> 1152 <p>BitbucketServerEventSource refers to event-source related to Bitbucket Server events</p> 1153 </p> 1154 <table> 1155 <thead> 1156 <tr> 1157 <th>Field</th> 1158 <th>Description</th> 1159 </tr> 1160 </thead> 1161 <tbody> 1162 <tr> 1163 <td> 1164 <code>webhook</code></br> 1165 <em> 1166 <a href="#argoproj.io/v1alpha1.WebhookContext"> 1167 WebhookContext 1168 </a> 1169 </em> 1170 </td> 1171 <td> 1172 <p>Webhook holds configuration to run a http server</p> 1173 </td> 1174 </tr> 1175 <tr> 1176 <td> 1177 <code>projectKey</code></br> 1178 <em> 1179 string 1180 </em> 1181 </td> 1182 <td> 1183 <em>(Optional)</em> 1184 <p>DeprecatedProjectKey is the key of project for which integration needs to set up 1185 Deprecated: use Repositories instead. Will be unsupported in v1.8</p> 1186 </td> 1187 </tr> 1188 <tr> 1189 <td> 1190 <code>repositorySlug</code></br> 1191 <em> 1192 string 1193 </em> 1194 </td> 1195 <td> 1196 <em>(Optional)</em> 1197 <p>DeprecatedRepositorySlug is the slug of the repository for which integration needs to set up 1198 Deprecated: use Repositories instead. Will be unsupported in v1.8</p> 1199 </td> 1200 </tr> 1201 <tr> 1202 <td> 1203 <code>repositories</code></br> 1204 <em> 1205 <a href="#argoproj.io/v1alpha1.BitbucketServerRepository"> 1206 []BitbucketServerRepository 1207 </a> 1208 </em> 1209 </td> 1210 <td> 1211 <em>(Optional)</em> 1212 <p>Repositories holds a list of repositories for which integration needs to set up</p> 1213 </td> 1214 </tr> 1215 <tr> 1216 <td> 1217 <code>events</code></br> 1218 <em> 1219 []string 1220 </em> 1221 </td> 1222 <td> 1223 <p>Events are bitbucket event to listen to. 1224 Refer <a href="https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html">https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html</a></p> 1225 </td> 1226 </tr> 1227 <tr> 1228 <td> 1229 <code>accessToken</code></br> 1230 <em> 1231 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1232 Kubernetes core/v1.SecretKeySelector 1233 </a> 1234 </em> 1235 </td> 1236 <td> 1237 <p>AccessToken is reference to K8s secret which holds the bitbucket api access information</p> 1238 </td> 1239 </tr> 1240 <tr> 1241 <td> 1242 <code>webhookSecret</code></br> 1243 <em> 1244 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1245 Kubernetes core/v1.SecretKeySelector 1246 </a> 1247 </em> 1248 </td> 1249 <td> 1250 <p>WebhookSecret is reference to K8s secret which holds the bitbucket webhook secret (for HMAC validation)</p> 1251 </td> 1252 </tr> 1253 <tr> 1254 <td> 1255 <code>bitbucketserverBaseURL</code></br> 1256 <em> 1257 string 1258 </em> 1259 </td> 1260 <td> 1261 <p>BitbucketServerBaseURL is the base URL for API requests to a custom endpoint</p> 1262 </td> 1263 </tr> 1264 <tr> 1265 <td> 1266 <code>deleteHookOnFinish</code></br> 1267 <em> 1268 bool 1269 </em> 1270 </td> 1271 <td> 1272 <em>(Optional)</em> 1273 <p>DeleteHookOnFinish determines whether to delete the Bitbucket Server hook for the project once the event source is stopped.</p> 1274 </td> 1275 </tr> 1276 <tr> 1277 <td> 1278 <code>metadata</code></br> 1279 <em> 1280 map[string]string 1281 </em> 1282 </td> 1283 <td> 1284 <em>(Optional)</em> 1285 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 1286 </td> 1287 </tr> 1288 <tr> 1289 <td> 1290 <code>filter</code></br> 1291 <em> 1292 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 1293 EventSourceFilter 1294 </a> 1295 </em> 1296 </td> 1297 <td> 1298 <em>(Optional)</em> 1299 <p>Filter</p> 1300 </td> 1301 </tr> 1302 <tr> 1303 <td> 1304 <code>tls</code></br> 1305 <em> 1306 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 1307 </em> 1308 </td> 1309 <td> 1310 <em>(Optional)</em> 1311 <p>TLS configuration for the bitbucketserver client.</p> 1312 </td> 1313 </tr> 1314 </tbody> 1315 </table> 1316 <h3 id="argoproj.io/v1alpha1.BitbucketServerRepository">BitbucketServerRepository 1317 </h3> 1318 <p> 1319 (<em>Appears on:</em> 1320 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>) 1321 </p> 1322 <p> 1323 </p> 1324 <table> 1325 <thead> 1326 <tr> 1327 <th>Field</th> 1328 <th>Description</th> 1329 </tr> 1330 </thead> 1331 <tbody> 1332 <tr> 1333 <td> 1334 <code>projectKey</code></br> 1335 <em> 1336 string 1337 </em> 1338 </td> 1339 <td> 1340 <p>ProjectKey is the key of project for which integration needs to set up</p> 1341 </td> 1342 </tr> 1343 <tr> 1344 <td> 1345 <code>repositorySlug</code></br> 1346 <em> 1347 string 1348 </em> 1349 </td> 1350 <td> 1351 <p>RepositorySlug is the slug of the repository for which integration needs to set up</p> 1352 </td> 1353 </tr> 1354 </tbody> 1355 </table> 1356 <h3 id="argoproj.io/v1alpha1.CalendarEventSource">CalendarEventSource 1357 </h3> 1358 <p> 1359 (<em>Appears on:</em> 1360 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1361 </p> 1362 <p> 1363 <p>CalendarEventSource describes a time based dependency. One of the fields (schedule, interval, or recurrence) must be passed. 1364 Schedule takes precedence over interval; interval takes precedence over recurrence</p> 1365 </p> 1366 <table> 1367 <thead> 1368 <tr> 1369 <th>Field</th> 1370 <th>Description</th> 1371 </tr> 1372 </thead> 1373 <tbody> 1374 <tr> 1375 <td> 1376 <code>schedule</code></br> 1377 <em> 1378 string 1379 </em> 1380 </td> 1381 <td> 1382 <em>(Optional)</em> 1383 <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> 1384 </td> 1385 </tr> 1386 <tr> 1387 <td> 1388 <code>interval</code></br> 1389 <em> 1390 string 1391 </em> 1392 </td> 1393 <td> 1394 <em>(Optional)</em> 1395 <p>Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h…</p> 1396 </td> 1397 </tr> 1398 <tr> 1399 <td> 1400 <code>exclusionDates</code></br> 1401 <em> 1402 []string 1403 </em> 1404 </td> 1405 <td> 1406 <p>ExclusionDates defines the list of DATE-TIME exceptions for recurring events.</p> 1407 </td> 1408 </tr> 1409 <tr> 1410 <td> 1411 <code>timezone</code></br> 1412 <em> 1413 string 1414 </em> 1415 </td> 1416 <td> 1417 <em>(Optional)</em> 1418 <p>Timezone in which to run the schedule</p> 1419 </td> 1420 </tr> 1421 <tr> 1422 <td> 1423 <code>metadata</code></br> 1424 <em> 1425 map[string]string 1426 </em> 1427 </td> 1428 <td> 1429 <em>(Optional)</em> 1430 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 1431 </td> 1432 </tr> 1433 <tr> 1434 <td> 1435 <code>persistence</code></br> 1436 <em> 1437 <a href="#argoproj.io/v1alpha1.EventPersistence"> 1438 EventPersistence 1439 </a> 1440 </em> 1441 </td> 1442 <td> 1443 <p>Persistence hold the configuration for event persistence</p> 1444 </td> 1445 </tr> 1446 <tr> 1447 <td> 1448 <code>filter</code></br> 1449 <em> 1450 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 1451 EventSourceFilter 1452 </a> 1453 </em> 1454 </td> 1455 <td> 1456 <em>(Optional)</em> 1457 <p>Filter</p> 1458 </td> 1459 </tr> 1460 </tbody> 1461 </table> 1462 <h3 id="argoproj.io/v1alpha1.CatchupConfiguration">CatchupConfiguration 1463 </h3> 1464 <p> 1465 (<em>Appears on:</em> 1466 <a href="#argoproj.io/v1alpha1.EventPersistence">EventPersistence</a>) 1467 </p> 1468 <p> 1469 </p> 1470 <table> 1471 <thead> 1472 <tr> 1473 <th>Field</th> 1474 <th>Description</th> 1475 </tr> 1476 </thead> 1477 <tbody> 1478 <tr> 1479 <td> 1480 <code>enabled</code></br> 1481 <em> 1482 bool 1483 </em> 1484 </td> 1485 <td> 1486 <p>Enabled enables to triggered the missed schedule when eventsource restarts</p> 1487 </td> 1488 </tr> 1489 <tr> 1490 <td> 1491 <code>maxDuration</code></br> 1492 <em> 1493 string 1494 </em> 1495 </td> 1496 <td> 1497 <p>MaxDuration holds max catchup duration</p> 1498 </td> 1499 </tr> 1500 </tbody> 1501 </table> 1502 <h3 id="argoproj.io/v1alpha1.ConfigMapPersistence">ConfigMapPersistence 1503 </h3> 1504 <p> 1505 (<em>Appears on:</em> 1506 <a href="#argoproj.io/v1alpha1.EventPersistence">EventPersistence</a>) 1507 </p> 1508 <p> 1509 </p> 1510 <table> 1511 <thead> 1512 <tr> 1513 <th>Field</th> 1514 <th>Description</th> 1515 </tr> 1516 </thead> 1517 <tbody> 1518 <tr> 1519 <td> 1520 <code>name</code></br> 1521 <em> 1522 string 1523 </em> 1524 </td> 1525 <td> 1526 <p>Name of the configmap</p> 1527 </td> 1528 </tr> 1529 <tr> 1530 <td> 1531 <code>createIfNotExist</code></br> 1532 <em> 1533 bool 1534 </em> 1535 </td> 1536 <td> 1537 <p>CreateIfNotExist will create configmap if it doesn’t exists</p> 1538 </td> 1539 </tr> 1540 </tbody> 1541 </table> 1542 <h3 id="argoproj.io/v1alpha1.EmitterEventSource">EmitterEventSource 1543 </h3> 1544 <p> 1545 (<em>Appears on:</em> 1546 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 1547 </p> 1548 <p> 1549 <p>EmitterEventSource describes the event source for emitter 1550 More info at <a href="https://emitter.io/develop/getting-started/">https://emitter.io/develop/getting-started/</a></p> 1551 </p> 1552 <table> 1553 <thead> 1554 <tr> 1555 <th>Field</th> 1556 <th>Description</th> 1557 </tr> 1558 </thead> 1559 <tbody> 1560 <tr> 1561 <td> 1562 <code>broker</code></br> 1563 <em> 1564 string 1565 </em> 1566 </td> 1567 <td> 1568 <p>Broker URI to connect to.</p> 1569 </td> 1570 </tr> 1571 <tr> 1572 <td> 1573 <code>channelKey</code></br> 1574 <em> 1575 string 1576 </em> 1577 </td> 1578 <td> 1579 <p>ChannelKey refers to the channel key</p> 1580 </td> 1581 </tr> 1582 <tr> 1583 <td> 1584 <code>channelName</code></br> 1585 <em> 1586 string 1587 </em> 1588 </td> 1589 <td> 1590 <p>ChannelName refers to the channel name</p> 1591 </td> 1592 </tr> 1593 <tr> 1594 <td> 1595 <code>username</code></br> 1596 <em> 1597 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1598 Kubernetes core/v1.SecretKeySelector 1599 </a> 1600 </em> 1601 </td> 1602 <td> 1603 <em>(Optional)</em> 1604 <p>Username to use to connect to broker</p> 1605 </td> 1606 </tr> 1607 <tr> 1608 <td> 1609 <code>password</code></br> 1610 <em> 1611 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 1612 Kubernetes core/v1.SecretKeySelector 1613 </a> 1614 </em> 1615 </td> 1616 <td> 1617 <em>(Optional)</em> 1618 <p>Password to use to connect to broker</p> 1619 </td> 1620 </tr> 1621 <tr> 1622 <td> 1623 <code>connectionBackoff</code></br> 1624 <em> 1625 github.com/argoproj/argo-events/pkg/apis/common.Backoff 1626 </em> 1627 </td> 1628 <td> 1629 <em>(Optional)</em> 1630 <p>Backoff holds parameters applied to connection.</p> 1631 </td> 1632 </tr> 1633 <tr> 1634 <td> 1635 <code>jsonBody</code></br> 1636 <em> 1637 bool 1638 </em> 1639 </td> 1640 <td> 1641 <em>(Optional)</em> 1642 <p>JSONBody specifies that all event body payload coming from this 1643 source will be JSON</p> 1644 </td> 1645 </tr> 1646 <tr> 1647 <td> 1648 <code>tls</code></br> 1649 <em> 1650 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 1651 </em> 1652 </td> 1653 <td> 1654 <em>(Optional)</em> 1655 <p>TLS configuration for the emitter client.</p> 1656 </td> 1657 </tr> 1658 <tr> 1659 <td> 1660 <code>metadata</code></br> 1661 <em> 1662 map[string]string 1663 </em> 1664 </td> 1665 <td> 1666 <em>(Optional)</em> 1667 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 1668 </td> 1669 </tr> 1670 <tr> 1671 <td> 1672 <code>filter</code></br> 1673 <em> 1674 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 1675 EventSourceFilter 1676 </a> 1677 </em> 1678 </td> 1679 <td> 1680 <em>(Optional)</em> 1681 <p>Filter</p> 1682 </td> 1683 </tr> 1684 </tbody> 1685 </table> 1686 <h3 id="argoproj.io/v1alpha1.EventPersistence">EventPersistence 1687 </h3> 1688 <p> 1689 (<em>Appears on:</em> 1690 <a href="#argoproj.io/v1alpha1.CalendarEventSource">CalendarEventSource</a>) 1691 </p> 1692 <p> 1693 </p> 1694 <table> 1695 <thead> 1696 <tr> 1697 <th>Field</th> 1698 <th>Description</th> 1699 </tr> 1700 </thead> 1701 <tbody> 1702 <tr> 1703 <td> 1704 <code>catchup</code></br> 1705 <em> 1706 <a href="#argoproj.io/v1alpha1.CatchupConfiguration"> 1707 CatchupConfiguration 1708 </a> 1709 </em> 1710 </td> 1711 <td> 1712 <p>Catchup enables to triggered the missed schedule when eventsource restarts</p> 1713 </td> 1714 </tr> 1715 <tr> 1716 <td> 1717 <code>configMap</code></br> 1718 <em> 1719 <a href="#argoproj.io/v1alpha1.ConfigMapPersistence"> 1720 ConfigMapPersistence 1721 </a> 1722 </em> 1723 </td> 1724 <td> 1725 <p>ConfigMap holds configmap details for persistence</p> 1726 </td> 1727 </tr> 1728 </tbody> 1729 </table> 1730 <h3 id="argoproj.io/v1alpha1.EventSource">EventSource 1731 </h3> 1732 <p> 1733 <p>EventSource is the definition of a eventsource resource</p> 1734 </p> 1735 <table> 1736 <thead> 1737 <tr> 1738 <th>Field</th> 1739 <th>Description</th> 1740 </tr> 1741 </thead> 1742 <tbody> 1743 <tr> 1744 <td> 1745 <code>metadata</code></br> 1746 <em> 1747 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta"> 1748 Kubernetes meta/v1.ObjectMeta 1749 </a> 1750 </em> 1751 </td> 1752 <td> 1753 Refer to the Kubernetes API documentation for the fields of the 1754 <code>metadata</code> field. 1755 </td> 1756 </tr> 1757 <tr> 1758 <td> 1759 <code>spec</code></br> 1760 <em> 1761 <a href="#argoproj.io/v1alpha1.EventSourceSpec"> 1762 EventSourceSpec 1763 </a> 1764 </em> 1765 </td> 1766 <td> 1767 <br/> 1768 <br/> 1769 <table> 1770 <tr> 1771 <td> 1772 <code>eventBusName</code></br> 1773 <em> 1774 string 1775 </em> 1776 </td> 1777 <td> 1778 <p>EventBusName references to a EventBus name. By default the value is “default”</p> 1779 </td> 1780 </tr> 1781 <tr> 1782 <td> 1783 <code>template</code></br> 1784 <em> 1785 <a href="#argoproj.io/v1alpha1.Template"> 1786 Template 1787 </a> 1788 </em> 1789 </td> 1790 <td> 1791 <em>(Optional)</em> 1792 <p>Template is the pod specification for the event source</p> 1793 </td> 1794 </tr> 1795 <tr> 1796 <td> 1797 <code>service</code></br> 1798 <em> 1799 <a href="#argoproj.io/v1alpha1.Service"> 1800 Service 1801 </a> 1802 </em> 1803 </td> 1804 <td> 1805 <em>(Optional)</em> 1806 <p>Service is the specifications of the service to expose the event source</p> 1807 </td> 1808 </tr> 1809 <tr> 1810 <td> 1811 <code>minio</code></br> 1812 <em> 1813 map[string]github.com/argoproj/argo-events/pkg/apis/common.S3Artifact 1814 </em> 1815 </td> 1816 <td> 1817 <p>Minio event sources</p> 1818 </td> 1819 </tr> 1820 <tr> 1821 <td> 1822 <code>calendar</code></br> 1823 <em> 1824 <a href="#argoproj.io/v1alpha1.CalendarEventSource"> 1825 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.CalendarEventSource 1826 </a> 1827 </em> 1828 </td> 1829 <td> 1830 <p>Calendar event sources</p> 1831 </td> 1832 </tr> 1833 <tr> 1834 <td> 1835 <code>file</code></br> 1836 <em> 1837 <a href="#argoproj.io/v1alpha1.FileEventSource"> 1838 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.FileEventSource 1839 </a> 1840 </em> 1841 </td> 1842 <td> 1843 <p>File event sources</p> 1844 </td> 1845 </tr> 1846 <tr> 1847 <td> 1848 <code>resource</code></br> 1849 <em> 1850 <a href="#argoproj.io/v1alpha1.ResourceEventSource"> 1851 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.ResourceEventSource 1852 </a> 1853 </em> 1854 </td> 1855 <td> 1856 <p>Resource event sources</p> 1857 </td> 1858 </tr> 1859 <tr> 1860 <td> 1861 <code>webhook</code></br> 1862 <em> 1863 <a href="#argoproj.io/v1alpha1.WebhookEventSource"> 1864 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.WebhookEventSource 1865 </a> 1866 </em> 1867 </td> 1868 <td> 1869 <p>Webhook event sources</p> 1870 </td> 1871 </tr> 1872 <tr> 1873 <td> 1874 <code>amqp</code></br> 1875 <em> 1876 <a href="#argoproj.io/v1alpha1.AMQPEventSource"> 1877 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AMQPEventSource 1878 </a> 1879 </em> 1880 </td> 1881 <td> 1882 <p>AMQP event sources</p> 1883 </td> 1884 </tr> 1885 <tr> 1886 <td> 1887 <code>kafka</code></br> 1888 <em> 1889 <a href="#argoproj.io/v1alpha1.KafkaEventSource"> 1890 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.KafkaEventSource 1891 </a> 1892 </em> 1893 </td> 1894 <td> 1895 <p>Kafka event sources</p> 1896 </td> 1897 </tr> 1898 <tr> 1899 <td> 1900 <code>mqtt</code></br> 1901 <em> 1902 <a href="#argoproj.io/v1alpha1.MQTTEventSource"> 1903 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.MQTTEventSource 1904 </a> 1905 </em> 1906 </td> 1907 <td> 1908 <p>MQTT event sources</p> 1909 </td> 1910 </tr> 1911 <tr> 1912 <td> 1913 <code>nats</code></br> 1914 <em> 1915 <a href="#argoproj.io/v1alpha1.NATSEventsSource"> 1916 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NATSEventsSource 1917 </a> 1918 </em> 1919 </td> 1920 <td> 1921 <p>NATS event sources</p> 1922 </td> 1923 </tr> 1924 <tr> 1925 <td> 1926 <code>sns</code></br> 1927 <em> 1928 <a href="#argoproj.io/v1alpha1.SNSEventSource"> 1929 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SNSEventSource 1930 </a> 1931 </em> 1932 </td> 1933 <td> 1934 <p>SNS event sources</p> 1935 </td> 1936 </tr> 1937 <tr> 1938 <td> 1939 <code>sqs</code></br> 1940 <em> 1941 <a href="#argoproj.io/v1alpha1.SQSEventSource"> 1942 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SQSEventSource 1943 </a> 1944 </em> 1945 </td> 1946 <td> 1947 <p>SQS event sources</p> 1948 </td> 1949 </tr> 1950 <tr> 1951 <td> 1952 <code>pubSub</code></br> 1953 <em> 1954 <a href="#argoproj.io/v1alpha1.PubSubEventSource"> 1955 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PubSubEventSource 1956 </a> 1957 </em> 1958 </td> 1959 <td> 1960 <p>PubSub event sources</p> 1961 </td> 1962 </tr> 1963 <tr> 1964 <td> 1965 <code>github</code></br> 1966 <em> 1967 <a href="#argoproj.io/v1alpha1.GithubEventSource"> 1968 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GithubEventSource 1969 </a> 1970 </em> 1971 </td> 1972 <td> 1973 <p>Github event sources</p> 1974 </td> 1975 </tr> 1976 <tr> 1977 <td> 1978 <code>gitlab</code></br> 1979 <em> 1980 <a href="#argoproj.io/v1alpha1.GitlabEventSource"> 1981 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GitlabEventSource 1982 </a> 1983 </em> 1984 </td> 1985 <td> 1986 <p>Gitlab event sources</p> 1987 </td> 1988 </tr> 1989 <tr> 1990 <td> 1991 <code>hdfs</code></br> 1992 <em> 1993 <a href="#argoproj.io/v1alpha1.HDFSEventSource"> 1994 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.HDFSEventSource 1995 </a> 1996 </em> 1997 </td> 1998 <td> 1999 <p>HDFS event sources</p> 2000 </td> 2001 </tr> 2002 <tr> 2003 <td> 2004 <code>slack</code></br> 2005 <em> 2006 <a href="#argoproj.io/v1alpha1.SlackEventSource"> 2007 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SlackEventSource 2008 </a> 2009 </em> 2010 </td> 2011 <td> 2012 <p>Slack event sources</p> 2013 </td> 2014 </tr> 2015 <tr> 2016 <td> 2017 <code>storageGrid</code></br> 2018 <em> 2019 <a href="#argoproj.io/v1alpha1.StorageGridEventSource"> 2020 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StorageGridEventSource 2021 </a> 2022 </em> 2023 </td> 2024 <td> 2025 <p>StorageGrid event sources</p> 2026 </td> 2027 </tr> 2028 <tr> 2029 <td> 2030 <code>azureEventsHub</code></br> 2031 <em> 2032 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource"> 2033 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureEventsHubEventSource 2034 </a> 2035 </em> 2036 </td> 2037 <td> 2038 <p>AzureEventsHub event sources</p> 2039 </td> 2040 </tr> 2041 <tr> 2042 <td> 2043 <code>stripe</code></br> 2044 <em> 2045 <a href="#argoproj.io/v1alpha1.StripeEventSource"> 2046 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StripeEventSource 2047 </a> 2048 </em> 2049 </td> 2050 <td> 2051 <p>Stripe event sources</p> 2052 </td> 2053 </tr> 2054 <tr> 2055 <td> 2056 <code>emitter</code></br> 2057 <em> 2058 <a href="#argoproj.io/v1alpha1.EmitterEventSource"> 2059 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.EmitterEventSource 2060 </a> 2061 </em> 2062 </td> 2063 <td> 2064 <p>Emitter event source</p> 2065 </td> 2066 </tr> 2067 <tr> 2068 <td> 2069 <code>redis</code></br> 2070 <em> 2071 <a href="#argoproj.io/v1alpha1.RedisEventSource"> 2072 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisEventSource 2073 </a> 2074 </em> 2075 </td> 2076 <td> 2077 <p>Redis event source</p> 2078 </td> 2079 </tr> 2080 <tr> 2081 <td> 2082 <code>nsq</code></br> 2083 <em> 2084 <a href="#argoproj.io/v1alpha1.NSQEventSource"> 2085 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NSQEventSource 2086 </a> 2087 </em> 2088 </td> 2089 <td> 2090 <p>NSQ event source</p> 2091 </td> 2092 </tr> 2093 <tr> 2094 <td> 2095 <code>pulsar</code></br> 2096 <em> 2097 <a href="#argoproj.io/v1alpha1.PulsarEventSource"> 2098 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PulsarEventSource 2099 </a> 2100 </em> 2101 </td> 2102 <td> 2103 <p>Pulsar event source</p> 2104 </td> 2105 </tr> 2106 <tr> 2107 <td> 2108 <code>generic</code></br> 2109 <em> 2110 <a href="#argoproj.io/v1alpha1.GenericEventSource"> 2111 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GenericEventSource 2112 </a> 2113 </em> 2114 </td> 2115 <td> 2116 <p>Generic event source</p> 2117 </td> 2118 </tr> 2119 <tr> 2120 <td> 2121 <code>replicas</code></br> 2122 <em> 2123 int32 2124 </em> 2125 </td> 2126 <td> 2127 <p>Replicas is the event source deployment replicas</p> 2128 </td> 2129 </tr> 2130 <tr> 2131 <td> 2132 <code>bitbucketserver</code></br> 2133 <em> 2134 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource"> 2135 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketServerEventSource 2136 </a> 2137 </em> 2138 </td> 2139 <td> 2140 <p>Bitbucket Server event sources</p> 2141 </td> 2142 </tr> 2143 <tr> 2144 <td> 2145 <code>bitbucket</code></br> 2146 <em> 2147 <a href="#argoproj.io/v1alpha1.BitbucketEventSource"> 2148 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketEventSource 2149 </a> 2150 </em> 2151 </td> 2152 <td> 2153 <p>Bitbucket event sources</p> 2154 </td> 2155 </tr> 2156 <tr> 2157 <td> 2158 <code>redisStream</code></br> 2159 <em> 2160 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource"> 2161 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisStreamEventSource 2162 </a> 2163 </em> 2164 </td> 2165 <td> 2166 <p>Redis stream source</p> 2167 </td> 2168 </tr> 2169 <tr> 2170 <td> 2171 <code>azureServiceBus</code></br> 2172 <em> 2173 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource"> 2174 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureServiceBusEventSource 2175 </a> 2176 </em> 2177 </td> 2178 <td> 2179 <p>Azure Service Bus event source</p> 2180 </td> 2181 </tr> 2182 <tr> 2183 <td> 2184 <code>azureQueueStorage</code></br> 2185 <em> 2186 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource"> 2187 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureQueueStorageEventSource 2188 </a> 2189 </em> 2190 </td> 2191 <td> 2192 <p>AzureQueueStorage event source</p> 2193 </td> 2194 </tr> 2195 <tr> 2196 <td> 2197 <code>sftp</code></br> 2198 <em> 2199 <a href="#argoproj.io/v1alpha1.SFTPEventSource"> 2200 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SFTPEventSource 2201 </a> 2202 </em> 2203 </td> 2204 <td> 2205 <p>SFTP event sources</p> 2206 </td> 2207 </tr> 2208 <tr> 2209 <td> 2210 <code>gerrit</code></br> 2211 <em> 2212 <a href="#argoproj.io/v1alpha1.GerritEventSource"> 2213 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GerritEventSource 2214 </a> 2215 </em> 2216 </td> 2217 <td> 2218 <p>Gerrit event source</p> 2219 </td> 2220 </tr> 2221 </table> 2222 </td> 2223 </tr> 2224 <tr> 2225 <td> 2226 <code>status</code></br> 2227 <em> 2228 <a href="#argoproj.io/v1alpha1.EventSourceStatus"> 2229 EventSourceStatus 2230 </a> 2231 </em> 2232 </td> 2233 <td> 2234 <em>(Optional)</em> 2235 </td> 2236 </tr> 2237 </tbody> 2238 </table> 2239 <h3 id="argoproj.io/v1alpha1.EventSourceFilter">EventSourceFilter 2240 </h3> 2241 <p> 2242 (<em>Appears on:</em> 2243 <a href="#argoproj.io/v1alpha1.AMQPEventSource">AMQPEventSource</a>, 2244 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource">AzureEventsHubEventSource</a>, 2245 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource">AzureQueueStorageEventSource</a>, 2246 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource">AzureServiceBusEventSource</a>, 2247 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>, 2248 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>, 2249 <a href="#argoproj.io/v1alpha1.CalendarEventSource">CalendarEventSource</a>, 2250 <a href="#argoproj.io/v1alpha1.EmitterEventSource">EmitterEventSource</a>, 2251 <a href="#argoproj.io/v1alpha1.FileEventSource">FileEventSource</a>, 2252 <a href="#argoproj.io/v1alpha1.GenericEventSource">GenericEventSource</a>, 2253 <a href="#argoproj.io/v1alpha1.GerritEventSource">GerritEventSource</a>, 2254 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>, 2255 <a href="#argoproj.io/v1alpha1.GitlabEventSource">GitlabEventSource</a>, 2256 <a href="#argoproj.io/v1alpha1.HDFSEventSource">HDFSEventSource</a>, 2257 <a href="#argoproj.io/v1alpha1.KafkaEventSource">KafkaEventSource</a>, 2258 <a href="#argoproj.io/v1alpha1.MQTTEventSource">MQTTEventSource</a>, 2259 <a href="#argoproj.io/v1alpha1.NATSEventsSource">NATSEventsSource</a>, 2260 <a href="#argoproj.io/v1alpha1.NSQEventSource">NSQEventSource</a>, 2261 <a href="#argoproj.io/v1alpha1.PubSubEventSource">PubSubEventSource</a>, 2262 <a href="#argoproj.io/v1alpha1.PulsarEventSource">PulsarEventSource</a>, 2263 <a href="#argoproj.io/v1alpha1.RedisEventSource">RedisEventSource</a>, 2264 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource">RedisStreamEventSource</a>, 2265 <a href="#argoproj.io/v1alpha1.SFTPEventSource">SFTPEventSource</a>, 2266 <a href="#argoproj.io/v1alpha1.SNSEventSource">SNSEventSource</a>, 2267 <a href="#argoproj.io/v1alpha1.SQSEventSource">SQSEventSource</a>, 2268 <a href="#argoproj.io/v1alpha1.SlackEventSource">SlackEventSource</a>, 2269 <a href="#argoproj.io/v1alpha1.WebhookEventSource">WebhookEventSource</a>) 2270 </p> 2271 <p> 2272 </p> 2273 <table> 2274 <thead> 2275 <tr> 2276 <th>Field</th> 2277 <th>Description</th> 2278 </tr> 2279 </thead> 2280 <tbody> 2281 <tr> 2282 <td> 2283 <code>expression</code></br> 2284 <em> 2285 string 2286 </em> 2287 </td> 2288 <td> 2289 </td> 2290 </tr> 2291 </tbody> 2292 </table> 2293 <h3 id="argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec 2294 </h3> 2295 <p> 2296 (<em>Appears on:</em> 2297 <a href="#argoproj.io/v1alpha1.EventSource">EventSource</a>) 2298 </p> 2299 <p> 2300 <p>EventSourceSpec refers to specification of event-source resource</p> 2301 </p> 2302 <table> 2303 <thead> 2304 <tr> 2305 <th>Field</th> 2306 <th>Description</th> 2307 </tr> 2308 </thead> 2309 <tbody> 2310 <tr> 2311 <td> 2312 <code>eventBusName</code></br> 2313 <em> 2314 string 2315 </em> 2316 </td> 2317 <td> 2318 <p>EventBusName references to a EventBus name. By default the value is “default”</p> 2319 </td> 2320 </tr> 2321 <tr> 2322 <td> 2323 <code>template</code></br> 2324 <em> 2325 <a href="#argoproj.io/v1alpha1.Template"> 2326 Template 2327 </a> 2328 </em> 2329 </td> 2330 <td> 2331 <em>(Optional)</em> 2332 <p>Template is the pod specification for the event source</p> 2333 </td> 2334 </tr> 2335 <tr> 2336 <td> 2337 <code>service</code></br> 2338 <em> 2339 <a href="#argoproj.io/v1alpha1.Service"> 2340 Service 2341 </a> 2342 </em> 2343 </td> 2344 <td> 2345 <em>(Optional)</em> 2346 <p>Service is the specifications of the service to expose the event source</p> 2347 </td> 2348 </tr> 2349 <tr> 2350 <td> 2351 <code>minio</code></br> 2352 <em> 2353 map[string]github.com/argoproj/argo-events/pkg/apis/common.S3Artifact 2354 </em> 2355 </td> 2356 <td> 2357 <p>Minio event sources</p> 2358 </td> 2359 </tr> 2360 <tr> 2361 <td> 2362 <code>calendar</code></br> 2363 <em> 2364 <a href="#argoproj.io/v1alpha1.CalendarEventSource"> 2365 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.CalendarEventSource 2366 </a> 2367 </em> 2368 </td> 2369 <td> 2370 <p>Calendar event sources</p> 2371 </td> 2372 </tr> 2373 <tr> 2374 <td> 2375 <code>file</code></br> 2376 <em> 2377 <a href="#argoproj.io/v1alpha1.FileEventSource"> 2378 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.FileEventSource 2379 </a> 2380 </em> 2381 </td> 2382 <td> 2383 <p>File event sources</p> 2384 </td> 2385 </tr> 2386 <tr> 2387 <td> 2388 <code>resource</code></br> 2389 <em> 2390 <a href="#argoproj.io/v1alpha1.ResourceEventSource"> 2391 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.ResourceEventSource 2392 </a> 2393 </em> 2394 </td> 2395 <td> 2396 <p>Resource event sources</p> 2397 </td> 2398 </tr> 2399 <tr> 2400 <td> 2401 <code>webhook</code></br> 2402 <em> 2403 <a href="#argoproj.io/v1alpha1.WebhookEventSource"> 2404 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.WebhookEventSource 2405 </a> 2406 </em> 2407 </td> 2408 <td> 2409 <p>Webhook event sources</p> 2410 </td> 2411 </tr> 2412 <tr> 2413 <td> 2414 <code>amqp</code></br> 2415 <em> 2416 <a href="#argoproj.io/v1alpha1.AMQPEventSource"> 2417 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AMQPEventSource 2418 </a> 2419 </em> 2420 </td> 2421 <td> 2422 <p>AMQP event sources</p> 2423 </td> 2424 </tr> 2425 <tr> 2426 <td> 2427 <code>kafka</code></br> 2428 <em> 2429 <a href="#argoproj.io/v1alpha1.KafkaEventSource"> 2430 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.KafkaEventSource 2431 </a> 2432 </em> 2433 </td> 2434 <td> 2435 <p>Kafka event sources</p> 2436 </td> 2437 </tr> 2438 <tr> 2439 <td> 2440 <code>mqtt</code></br> 2441 <em> 2442 <a href="#argoproj.io/v1alpha1.MQTTEventSource"> 2443 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.MQTTEventSource 2444 </a> 2445 </em> 2446 </td> 2447 <td> 2448 <p>MQTT event sources</p> 2449 </td> 2450 </tr> 2451 <tr> 2452 <td> 2453 <code>nats</code></br> 2454 <em> 2455 <a href="#argoproj.io/v1alpha1.NATSEventsSource"> 2456 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NATSEventsSource 2457 </a> 2458 </em> 2459 </td> 2460 <td> 2461 <p>NATS event sources</p> 2462 </td> 2463 </tr> 2464 <tr> 2465 <td> 2466 <code>sns</code></br> 2467 <em> 2468 <a href="#argoproj.io/v1alpha1.SNSEventSource"> 2469 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SNSEventSource 2470 </a> 2471 </em> 2472 </td> 2473 <td> 2474 <p>SNS event sources</p> 2475 </td> 2476 </tr> 2477 <tr> 2478 <td> 2479 <code>sqs</code></br> 2480 <em> 2481 <a href="#argoproj.io/v1alpha1.SQSEventSource"> 2482 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SQSEventSource 2483 </a> 2484 </em> 2485 </td> 2486 <td> 2487 <p>SQS event sources</p> 2488 </td> 2489 </tr> 2490 <tr> 2491 <td> 2492 <code>pubSub</code></br> 2493 <em> 2494 <a href="#argoproj.io/v1alpha1.PubSubEventSource"> 2495 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PubSubEventSource 2496 </a> 2497 </em> 2498 </td> 2499 <td> 2500 <p>PubSub event sources</p> 2501 </td> 2502 </tr> 2503 <tr> 2504 <td> 2505 <code>github</code></br> 2506 <em> 2507 <a href="#argoproj.io/v1alpha1.GithubEventSource"> 2508 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GithubEventSource 2509 </a> 2510 </em> 2511 </td> 2512 <td> 2513 <p>Github event sources</p> 2514 </td> 2515 </tr> 2516 <tr> 2517 <td> 2518 <code>gitlab</code></br> 2519 <em> 2520 <a href="#argoproj.io/v1alpha1.GitlabEventSource"> 2521 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GitlabEventSource 2522 </a> 2523 </em> 2524 </td> 2525 <td> 2526 <p>Gitlab event sources</p> 2527 </td> 2528 </tr> 2529 <tr> 2530 <td> 2531 <code>hdfs</code></br> 2532 <em> 2533 <a href="#argoproj.io/v1alpha1.HDFSEventSource"> 2534 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.HDFSEventSource 2535 </a> 2536 </em> 2537 </td> 2538 <td> 2539 <p>HDFS event sources</p> 2540 </td> 2541 </tr> 2542 <tr> 2543 <td> 2544 <code>slack</code></br> 2545 <em> 2546 <a href="#argoproj.io/v1alpha1.SlackEventSource"> 2547 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SlackEventSource 2548 </a> 2549 </em> 2550 </td> 2551 <td> 2552 <p>Slack event sources</p> 2553 </td> 2554 </tr> 2555 <tr> 2556 <td> 2557 <code>storageGrid</code></br> 2558 <em> 2559 <a href="#argoproj.io/v1alpha1.StorageGridEventSource"> 2560 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StorageGridEventSource 2561 </a> 2562 </em> 2563 </td> 2564 <td> 2565 <p>StorageGrid event sources</p> 2566 </td> 2567 </tr> 2568 <tr> 2569 <td> 2570 <code>azureEventsHub</code></br> 2571 <em> 2572 <a href="#argoproj.io/v1alpha1.AzureEventsHubEventSource"> 2573 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureEventsHubEventSource 2574 </a> 2575 </em> 2576 </td> 2577 <td> 2578 <p>AzureEventsHub event sources</p> 2579 </td> 2580 </tr> 2581 <tr> 2582 <td> 2583 <code>stripe</code></br> 2584 <em> 2585 <a href="#argoproj.io/v1alpha1.StripeEventSource"> 2586 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.StripeEventSource 2587 </a> 2588 </em> 2589 </td> 2590 <td> 2591 <p>Stripe event sources</p> 2592 </td> 2593 </tr> 2594 <tr> 2595 <td> 2596 <code>emitter</code></br> 2597 <em> 2598 <a href="#argoproj.io/v1alpha1.EmitterEventSource"> 2599 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.EmitterEventSource 2600 </a> 2601 </em> 2602 </td> 2603 <td> 2604 <p>Emitter event source</p> 2605 </td> 2606 </tr> 2607 <tr> 2608 <td> 2609 <code>redis</code></br> 2610 <em> 2611 <a href="#argoproj.io/v1alpha1.RedisEventSource"> 2612 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisEventSource 2613 </a> 2614 </em> 2615 </td> 2616 <td> 2617 <p>Redis event source</p> 2618 </td> 2619 </tr> 2620 <tr> 2621 <td> 2622 <code>nsq</code></br> 2623 <em> 2624 <a href="#argoproj.io/v1alpha1.NSQEventSource"> 2625 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.NSQEventSource 2626 </a> 2627 </em> 2628 </td> 2629 <td> 2630 <p>NSQ event source</p> 2631 </td> 2632 </tr> 2633 <tr> 2634 <td> 2635 <code>pulsar</code></br> 2636 <em> 2637 <a href="#argoproj.io/v1alpha1.PulsarEventSource"> 2638 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.PulsarEventSource 2639 </a> 2640 </em> 2641 </td> 2642 <td> 2643 <p>Pulsar event source</p> 2644 </td> 2645 </tr> 2646 <tr> 2647 <td> 2648 <code>generic</code></br> 2649 <em> 2650 <a href="#argoproj.io/v1alpha1.GenericEventSource"> 2651 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GenericEventSource 2652 </a> 2653 </em> 2654 </td> 2655 <td> 2656 <p>Generic event source</p> 2657 </td> 2658 </tr> 2659 <tr> 2660 <td> 2661 <code>replicas</code></br> 2662 <em> 2663 int32 2664 </em> 2665 </td> 2666 <td> 2667 <p>Replicas is the event source deployment replicas</p> 2668 </td> 2669 </tr> 2670 <tr> 2671 <td> 2672 <code>bitbucketserver</code></br> 2673 <em> 2674 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource"> 2675 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketServerEventSource 2676 </a> 2677 </em> 2678 </td> 2679 <td> 2680 <p>Bitbucket Server event sources</p> 2681 </td> 2682 </tr> 2683 <tr> 2684 <td> 2685 <code>bitbucket</code></br> 2686 <em> 2687 <a href="#argoproj.io/v1alpha1.BitbucketEventSource"> 2688 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.BitbucketEventSource 2689 </a> 2690 </em> 2691 </td> 2692 <td> 2693 <p>Bitbucket event sources</p> 2694 </td> 2695 </tr> 2696 <tr> 2697 <td> 2698 <code>redisStream</code></br> 2699 <em> 2700 <a href="#argoproj.io/v1alpha1.RedisStreamEventSource"> 2701 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.RedisStreamEventSource 2702 </a> 2703 </em> 2704 </td> 2705 <td> 2706 <p>Redis stream source</p> 2707 </td> 2708 </tr> 2709 <tr> 2710 <td> 2711 <code>azureServiceBus</code></br> 2712 <em> 2713 <a href="#argoproj.io/v1alpha1.AzureServiceBusEventSource"> 2714 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureServiceBusEventSource 2715 </a> 2716 </em> 2717 </td> 2718 <td> 2719 <p>Azure Service Bus event source</p> 2720 </td> 2721 </tr> 2722 <tr> 2723 <td> 2724 <code>azureQueueStorage</code></br> 2725 <em> 2726 <a href="#argoproj.io/v1alpha1.AzureQueueStorageEventSource"> 2727 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.AzureQueueStorageEventSource 2728 </a> 2729 </em> 2730 </td> 2731 <td> 2732 <p>AzureQueueStorage event source</p> 2733 </td> 2734 </tr> 2735 <tr> 2736 <td> 2737 <code>sftp</code></br> 2738 <em> 2739 <a href="#argoproj.io/v1alpha1.SFTPEventSource"> 2740 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.SFTPEventSource 2741 </a> 2742 </em> 2743 </td> 2744 <td> 2745 <p>SFTP event sources</p> 2746 </td> 2747 </tr> 2748 <tr> 2749 <td> 2750 <code>gerrit</code></br> 2751 <em> 2752 <a href="#argoproj.io/v1alpha1.GerritEventSource"> 2753 map[string]github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1.GerritEventSource 2754 </a> 2755 </em> 2756 </td> 2757 <td> 2758 <p>Gerrit event source</p> 2759 </td> 2760 </tr> 2761 </tbody> 2762 </table> 2763 <h3 id="argoproj.io/v1alpha1.EventSourceStatus">EventSourceStatus 2764 </h3> 2765 <p> 2766 (<em>Appears on:</em> 2767 <a href="#argoproj.io/v1alpha1.EventSource">EventSource</a>) 2768 </p> 2769 <p> 2770 <p>EventSourceStatus holds the status of the event-source resource</p> 2771 </p> 2772 <table> 2773 <thead> 2774 <tr> 2775 <th>Field</th> 2776 <th>Description</th> 2777 </tr> 2778 </thead> 2779 <tbody> 2780 <tr> 2781 <td> 2782 <code>Status</code></br> 2783 <em> 2784 github.com/argoproj/argo-events/pkg/apis/common.Status 2785 </em> 2786 </td> 2787 <td> 2788 <p> 2789 (Members of <code>Status</code> are embedded into this type.) 2790 </p> 2791 </td> 2792 </tr> 2793 </tbody> 2794 </table> 2795 <h3 id="argoproj.io/v1alpha1.FileEventSource">FileEventSource 2796 </h3> 2797 <p> 2798 (<em>Appears on:</em> 2799 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 2800 </p> 2801 <p> 2802 <p>FileEventSource describes an event-source for file related events.</p> 2803 </p> 2804 <table> 2805 <thead> 2806 <tr> 2807 <th>Field</th> 2808 <th>Description</th> 2809 </tr> 2810 </thead> 2811 <tbody> 2812 <tr> 2813 <td> 2814 <code>eventType</code></br> 2815 <em> 2816 string 2817 </em> 2818 </td> 2819 <td> 2820 <p>Type of file operations to watch 2821 Refer <a href="https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go">https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go</a> for more information</p> 2822 </td> 2823 </tr> 2824 <tr> 2825 <td> 2826 <code>watchPathConfig</code></br> 2827 <em> 2828 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> 2829 WatchPathConfig 2830 </a> 2831 </em> 2832 </td> 2833 <td> 2834 <p>WatchPathConfig contains configuration about the file path to watch</p> 2835 </td> 2836 </tr> 2837 <tr> 2838 <td> 2839 <code>polling</code></br> 2840 <em> 2841 bool 2842 </em> 2843 </td> 2844 <td> 2845 <p>Use polling instead of inotify</p> 2846 </td> 2847 </tr> 2848 <tr> 2849 <td> 2850 <code>metadata</code></br> 2851 <em> 2852 map[string]string 2853 </em> 2854 </td> 2855 <td> 2856 <em>(Optional)</em> 2857 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 2858 </td> 2859 </tr> 2860 <tr> 2861 <td> 2862 <code>filter</code></br> 2863 <em> 2864 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 2865 EventSourceFilter 2866 </a> 2867 </em> 2868 </td> 2869 <td> 2870 <em>(Optional)</em> 2871 <p>Filter</p> 2872 </td> 2873 </tr> 2874 </tbody> 2875 </table> 2876 <h3 id="argoproj.io/v1alpha1.GenericEventSource">GenericEventSource 2877 </h3> 2878 <p> 2879 (<em>Appears on:</em> 2880 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 2881 </p> 2882 <p> 2883 <p>GenericEventSource refers to a generic event source. It can be used to implement a custom event source.</p> 2884 </p> 2885 <table> 2886 <thead> 2887 <tr> 2888 <th>Field</th> 2889 <th>Description</th> 2890 </tr> 2891 </thead> 2892 <tbody> 2893 <tr> 2894 <td> 2895 <code>url</code></br> 2896 <em> 2897 string 2898 </em> 2899 </td> 2900 <td> 2901 <p>URL of the gRPC server that implements the event source.</p> 2902 </td> 2903 </tr> 2904 <tr> 2905 <td> 2906 <code>config</code></br> 2907 <em> 2908 string 2909 </em> 2910 </td> 2911 <td> 2912 <p>Config is the event source configuration</p> 2913 </td> 2914 </tr> 2915 <tr> 2916 <td> 2917 <code>insecure</code></br> 2918 <em> 2919 bool 2920 </em> 2921 </td> 2922 <td> 2923 <p>Insecure determines the type of connection.</p> 2924 </td> 2925 </tr> 2926 <tr> 2927 <td> 2928 <code>jsonBody</code></br> 2929 <em> 2930 bool 2931 </em> 2932 </td> 2933 <td> 2934 <em>(Optional)</em> 2935 <p>JSONBody specifies that all event body payload coming from this 2936 source will be JSON</p> 2937 </td> 2938 </tr> 2939 <tr> 2940 <td> 2941 <code>metadata</code></br> 2942 <em> 2943 map[string]string 2944 </em> 2945 </td> 2946 <td> 2947 <em>(Optional)</em> 2948 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 2949 </td> 2950 </tr> 2951 <tr> 2952 <td> 2953 <code>authSecret</code></br> 2954 <em> 2955 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 2956 Kubernetes core/v1.SecretKeySelector 2957 </a> 2958 </em> 2959 </td> 2960 <td> 2961 <em>(Optional)</em> 2962 <p>AuthSecret holds a secret selector that contains a bearer token for authentication</p> 2963 </td> 2964 </tr> 2965 <tr> 2966 <td> 2967 <code>filter</code></br> 2968 <em> 2969 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 2970 EventSourceFilter 2971 </a> 2972 </em> 2973 </td> 2974 <td> 2975 <em>(Optional)</em> 2976 <p>Filter</p> 2977 </td> 2978 </tr> 2979 </tbody> 2980 </table> 2981 <h3 id="argoproj.io/v1alpha1.GerritEventSource">GerritEventSource 2982 </h3> 2983 <p> 2984 (<em>Appears on:</em> 2985 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 2986 </p> 2987 <p> 2988 <p>GerritEventSource refers to event-source related to gerrit events</p> 2989 </p> 2990 <table> 2991 <thead> 2992 <tr> 2993 <th>Field</th> 2994 <th>Description</th> 2995 </tr> 2996 </thead> 2997 <tbody> 2998 <tr> 2999 <td> 3000 <code>webhook</code></br> 3001 <em> 3002 <a href="#argoproj.io/v1alpha1.WebhookContext"> 3003 WebhookContext 3004 </a> 3005 </em> 3006 </td> 3007 <td> 3008 <p>Webhook holds configuration to run a http server</p> 3009 </td> 3010 </tr> 3011 <tr> 3012 <td> 3013 <code>hookName</code></br> 3014 <em> 3015 string 3016 </em> 3017 </td> 3018 <td> 3019 <p>HookName is the name of the webhook</p> 3020 </td> 3021 </tr> 3022 <tr> 3023 <td> 3024 <code>events</code></br> 3025 <em> 3026 []string 3027 </em> 3028 </td> 3029 <td> 3030 <p>Events are gerrit event to listen to. 3031 Refer <a href="https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events">https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events</a></p> 3032 </td> 3033 </tr> 3034 <tr> 3035 <td> 3036 <code>auth</code></br> 3037 <em> 3038 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth 3039 </em> 3040 </td> 3041 <td> 3042 <em>(Optional)</em> 3043 <p>Auth hosts secret selectors for username and password</p> 3044 </td> 3045 </tr> 3046 <tr> 3047 <td> 3048 <code>gerritBaseURL</code></br> 3049 <em> 3050 string 3051 </em> 3052 </td> 3053 <td> 3054 <p>GerritBaseURL is the base URL for API requests to a custom endpoint</p> 3055 </td> 3056 </tr> 3057 <tr> 3058 <td> 3059 <code>deleteHookOnFinish</code></br> 3060 <em> 3061 bool 3062 </em> 3063 </td> 3064 <td> 3065 <em>(Optional)</em> 3066 <p>DeleteHookOnFinish determines whether to delete the Gerrit hook for the project once the event source is stopped.</p> 3067 </td> 3068 </tr> 3069 <tr> 3070 <td> 3071 <code>metadata</code></br> 3072 <em> 3073 map[string]string 3074 </em> 3075 </td> 3076 <td> 3077 <em>(Optional)</em> 3078 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 3079 </td> 3080 </tr> 3081 <tr> 3082 <td> 3083 <code>projects</code></br> 3084 <em> 3085 []string 3086 </em> 3087 </td> 3088 <td> 3089 <p>List of project namespace paths like “whynowy/test”.</p> 3090 </td> 3091 </tr> 3092 <tr> 3093 <td> 3094 <code>sslVerify</code></br> 3095 <em> 3096 bool 3097 </em> 3098 </td> 3099 <td> 3100 <em>(Optional)</em> 3101 <p>SslVerify to enable ssl verification</p> 3102 </td> 3103 </tr> 3104 <tr> 3105 <td> 3106 <code>filter</code></br> 3107 <em> 3108 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 3109 EventSourceFilter 3110 </a> 3111 </em> 3112 </td> 3113 <td> 3114 <em>(Optional)</em> 3115 <p>Filter</p> 3116 </td> 3117 </tr> 3118 </tbody> 3119 </table> 3120 <h3 id="argoproj.io/v1alpha1.GithubAppCreds">GithubAppCreds 3121 </h3> 3122 <p> 3123 (<em>Appears on:</em> 3124 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>) 3125 </p> 3126 <p> 3127 </p> 3128 <table> 3129 <thead> 3130 <tr> 3131 <th>Field</th> 3132 <th>Description</th> 3133 </tr> 3134 </thead> 3135 <tbody> 3136 <tr> 3137 <td> 3138 <code>privateKey</code></br> 3139 <em> 3140 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3141 Kubernetes core/v1.SecretKeySelector 3142 </a> 3143 </em> 3144 </td> 3145 <td> 3146 <p>PrivateKey refers to a K8s secret containing the GitHub app private key</p> 3147 </td> 3148 </tr> 3149 <tr> 3150 <td> 3151 <code>appID</code></br> 3152 <em> 3153 int64 3154 </em> 3155 </td> 3156 <td> 3157 <p>AppID refers to the GitHub App ID for the application you created</p> 3158 </td> 3159 </tr> 3160 <tr> 3161 <td> 3162 <code>installationID</code></br> 3163 <em> 3164 int64 3165 </em> 3166 </td> 3167 <td> 3168 <p>InstallationID refers to the Installation ID of the GitHub app you created and installed</p> 3169 </td> 3170 </tr> 3171 </tbody> 3172 </table> 3173 <h3 id="argoproj.io/v1alpha1.GithubEventSource">GithubEventSource 3174 </h3> 3175 <p> 3176 (<em>Appears on:</em> 3177 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3178 </p> 3179 <p> 3180 <p>GithubEventSource refers to event-source for github related events</p> 3181 </p> 3182 <table> 3183 <thead> 3184 <tr> 3185 <th>Field</th> 3186 <th>Description</th> 3187 </tr> 3188 </thead> 3189 <tbody> 3190 <tr> 3191 <td> 3192 <code>id</code></br> 3193 <em> 3194 int64 3195 </em> 3196 </td> 3197 <td> 3198 <em>(Optional)</em> 3199 <p>Id is the webhook’s id 3200 Deprecated: This is not used at all, will be removed in v1.6</p> 3201 </td> 3202 </tr> 3203 <tr> 3204 <td> 3205 <code>webhook</code></br> 3206 <em> 3207 <a href="#argoproj.io/v1alpha1.WebhookContext"> 3208 WebhookContext 3209 </a> 3210 </em> 3211 </td> 3212 <td> 3213 <p>Webhook refers to the configuration required to run a http server</p> 3214 </td> 3215 </tr> 3216 <tr> 3217 <td> 3218 <code>owner</code></br> 3219 <em> 3220 string 3221 </em> 3222 </td> 3223 <td> 3224 <em>(Optional)</em> 3225 <p>DeprecatedOwner refers to GitHub owner name i.e. argoproj 3226 Deprecated: use Repositories instead. Will be unsupported in v 1.6</p> 3227 </td> 3228 </tr> 3229 <tr> 3230 <td> 3231 <code>repository</code></br> 3232 <em> 3233 string 3234 </em> 3235 </td> 3236 <td> 3237 <em>(Optional)</em> 3238 <p>DeprecatedRepository refers to GitHub repo name i.e. argo-events 3239 Deprecated: use Repositories instead. Will be unsupported in v 1.6</p> 3240 </td> 3241 </tr> 3242 <tr> 3243 <td> 3244 <code>events</code></br> 3245 <em> 3246 []string 3247 </em> 3248 </td> 3249 <td> 3250 <p>Events refer to Github events to which the event source will subscribe</p> 3251 </td> 3252 </tr> 3253 <tr> 3254 <td> 3255 <code>apiToken</code></br> 3256 <em> 3257 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3258 Kubernetes core/v1.SecretKeySelector 3259 </a> 3260 </em> 3261 </td> 3262 <td> 3263 <em>(Optional)</em> 3264 <p>APIToken refers to a K8s secret containing github api token</p> 3265 </td> 3266 </tr> 3267 <tr> 3268 <td> 3269 <code>webhookSecret</code></br> 3270 <em> 3271 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3272 Kubernetes core/v1.SecretKeySelector 3273 </a> 3274 </em> 3275 </td> 3276 <td> 3277 <em>(Optional)</em> 3278 <p>WebhookSecret refers to K8s secret containing GitHub webhook secret 3279 <a href="https://developer.github.com/webhooks/securing/">https://developer.github.com/webhooks/securing/</a></p> 3280 </td> 3281 </tr> 3282 <tr> 3283 <td> 3284 <code>insecure</code></br> 3285 <em> 3286 bool 3287 </em> 3288 </td> 3289 <td> 3290 <p>Insecure tls verification</p> 3291 </td> 3292 </tr> 3293 <tr> 3294 <td> 3295 <code>active</code></br> 3296 <em> 3297 bool 3298 </em> 3299 </td> 3300 <td> 3301 <em>(Optional)</em> 3302 <p>Active refers to status of the webhook for event deliveries. 3303 <a href="https://developer.github.com/webhooks/creating/#active">https://developer.github.com/webhooks/creating/#active</a></p> 3304 </td> 3305 </tr> 3306 <tr> 3307 <td> 3308 <code>contentType</code></br> 3309 <em> 3310 string 3311 </em> 3312 </td> 3313 <td> 3314 <p>ContentType of the event delivery</p> 3315 </td> 3316 </tr> 3317 <tr> 3318 <td> 3319 <code>githubBaseURL</code></br> 3320 <em> 3321 string 3322 </em> 3323 </td> 3324 <td> 3325 <em>(Optional)</em> 3326 <p>GitHub base URL (for GitHub Enterprise)</p> 3327 </td> 3328 </tr> 3329 <tr> 3330 <td> 3331 <code>githubUploadURL</code></br> 3332 <em> 3333 string 3334 </em> 3335 </td> 3336 <td> 3337 <em>(Optional)</em> 3338 <p>GitHub upload URL (for GitHub Enterprise)</p> 3339 </td> 3340 </tr> 3341 <tr> 3342 <td> 3343 <code>deleteHookOnFinish</code></br> 3344 <em> 3345 bool 3346 </em> 3347 </td> 3348 <td> 3349 <em>(Optional)</em> 3350 <p>DeleteHookOnFinish determines whether to delete the GitHub hook for the repository once the event source is stopped.</p> 3351 </td> 3352 </tr> 3353 <tr> 3354 <td> 3355 <code>metadata</code></br> 3356 <em> 3357 map[string]string 3358 </em> 3359 </td> 3360 <td> 3361 <em>(Optional)</em> 3362 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 3363 </td> 3364 </tr> 3365 <tr> 3366 <td> 3367 <code>repositories</code></br> 3368 <em> 3369 <a href="#argoproj.io/v1alpha1.OwnedRepositories"> 3370 []OwnedRepositories 3371 </a> 3372 </em> 3373 </td> 3374 <td> 3375 <p>Repositories holds the information of repositories, which uses repo owner as the key, 3376 and list of repo names as the value. Not required if Organizations is set.</p> 3377 </td> 3378 </tr> 3379 <tr> 3380 <td> 3381 <code>organizations</code></br> 3382 <em> 3383 []string 3384 </em> 3385 </td> 3386 <td> 3387 <p>Organizations holds the names of organizations (used for organization level webhooks). Not required if Repositories is set.</p> 3388 </td> 3389 </tr> 3390 <tr> 3391 <td> 3392 <code>githubApp</code></br> 3393 <em> 3394 <a href="#argoproj.io/v1alpha1.GithubAppCreds"> 3395 GithubAppCreds 3396 </a> 3397 </em> 3398 </td> 3399 <td> 3400 <em>(Optional)</em> 3401 <p>GitHubApp holds the GitHub app credentials</p> 3402 </td> 3403 </tr> 3404 <tr> 3405 <td> 3406 <code>filter</code></br> 3407 <em> 3408 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 3409 EventSourceFilter 3410 </a> 3411 </em> 3412 </td> 3413 <td> 3414 <em>(Optional)</em> 3415 <p>Filter</p> 3416 </td> 3417 </tr> 3418 </tbody> 3419 </table> 3420 <h3 id="argoproj.io/v1alpha1.GitlabEventSource">GitlabEventSource 3421 </h3> 3422 <p> 3423 (<em>Appears on:</em> 3424 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3425 </p> 3426 <p> 3427 <p>GitlabEventSource refers to event-source related to Gitlab events</p> 3428 </p> 3429 <table> 3430 <thead> 3431 <tr> 3432 <th>Field</th> 3433 <th>Description</th> 3434 </tr> 3435 </thead> 3436 <tbody> 3437 <tr> 3438 <td> 3439 <code>webhook</code></br> 3440 <em> 3441 <a href="#argoproj.io/v1alpha1.WebhookContext"> 3442 WebhookContext 3443 </a> 3444 </em> 3445 </td> 3446 <td> 3447 <p>Webhook holds configuration to run a http server</p> 3448 </td> 3449 </tr> 3450 <tr> 3451 <td> 3452 <code>projectID</code></br> 3453 <em> 3454 string 3455 </em> 3456 </td> 3457 <td> 3458 <em>(Optional)</em> 3459 <p>DeprecatedProjectID is the id of project for which integration needs to setup 3460 Deprecated: use Projects instead. Will be unsupported in v 1.7</p> 3461 </td> 3462 </tr> 3463 <tr> 3464 <td> 3465 <code>events</code></br> 3466 <em> 3467 []string 3468 </em> 3469 </td> 3470 <td> 3471 <p>Events are gitlab event to listen to. 3472 Refer <a href="https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794">https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794</a>.</p> 3473 </td> 3474 </tr> 3475 <tr> 3476 <td> 3477 <code>accessToken</code></br> 3478 <em> 3479 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3480 Kubernetes core/v1.SecretKeySelector 3481 </a> 3482 </em> 3483 </td> 3484 <td> 3485 <p>AccessToken references to k8 secret which holds the gitlab api access information</p> 3486 </td> 3487 </tr> 3488 <tr> 3489 <td> 3490 <code>enableSSLVerification</code></br> 3491 <em> 3492 bool 3493 </em> 3494 </td> 3495 <td> 3496 <em>(Optional)</em> 3497 <p>EnableSSLVerification to enable ssl verification</p> 3498 </td> 3499 </tr> 3500 <tr> 3501 <td> 3502 <code>gitlabBaseURL</code></br> 3503 <em> 3504 string 3505 </em> 3506 </td> 3507 <td> 3508 <p>GitlabBaseURL is the base URL for API requests to a custom endpoint</p> 3509 </td> 3510 </tr> 3511 <tr> 3512 <td> 3513 <code>deleteHookOnFinish</code></br> 3514 <em> 3515 bool 3516 </em> 3517 </td> 3518 <td> 3519 <em>(Optional)</em> 3520 <p>DeleteHookOnFinish determines whether to delete the GitLab hook for the project once the event source is stopped.</p> 3521 </td> 3522 </tr> 3523 <tr> 3524 <td> 3525 <code>metadata</code></br> 3526 <em> 3527 map[string]string 3528 </em> 3529 </td> 3530 <td> 3531 <em>(Optional)</em> 3532 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 3533 </td> 3534 </tr> 3535 <tr> 3536 <td> 3537 <code>projects</code></br> 3538 <em> 3539 []string 3540 </em> 3541 </td> 3542 <td> 3543 <em>(Optional)</em> 3544 <p>List of project IDs or project namespace paths like “whynowy/test”. Projects and groups cannot be empty at the same time.</p> 3545 </td> 3546 </tr> 3547 <tr> 3548 <td> 3549 <code>secretToken</code></br> 3550 <em> 3551 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3552 Kubernetes core/v1.SecretKeySelector 3553 </a> 3554 </em> 3555 </td> 3556 <td> 3557 <p>SecretToken references to k8 secret which holds the Secret Token used by webhook config</p> 3558 </td> 3559 </tr> 3560 <tr> 3561 <td> 3562 <code>filter</code></br> 3563 <em> 3564 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 3565 EventSourceFilter 3566 </a> 3567 </em> 3568 </td> 3569 <td> 3570 <em>(Optional)</em> 3571 <p>Filter</p> 3572 </td> 3573 </tr> 3574 <tr> 3575 <td> 3576 <code>groups</code></br> 3577 <em> 3578 []string 3579 </em> 3580 </td> 3581 <td> 3582 <em>(Optional)</em> 3583 <p>List of group IDs or group name like “test”. 3584 Group level hook available in Premium and Ultimate Gitlab.</p> 3585 </td> 3586 </tr> 3587 </tbody> 3588 </table> 3589 <h3 id="argoproj.io/v1alpha1.HDFSEventSource">HDFSEventSource 3590 </h3> 3591 <p> 3592 (<em>Appears on:</em> 3593 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3594 </p> 3595 <p> 3596 <p>HDFSEventSource refers to event-source for HDFS related events</p> 3597 </p> 3598 <table> 3599 <thead> 3600 <tr> 3601 <th>Field</th> 3602 <th>Description</th> 3603 </tr> 3604 </thead> 3605 <tbody> 3606 <tr> 3607 <td> 3608 <code>WatchPathConfig</code></br> 3609 <em> 3610 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> 3611 WatchPathConfig 3612 </a> 3613 </em> 3614 </td> 3615 <td> 3616 <p> 3617 (Members of <code>WatchPathConfig</code> are embedded into this type.) 3618 </p> 3619 </td> 3620 </tr> 3621 <tr> 3622 <td> 3623 <code>type</code></br> 3624 <em> 3625 string 3626 </em> 3627 </td> 3628 <td> 3629 <p>Type of file operations to watch</p> 3630 </td> 3631 </tr> 3632 <tr> 3633 <td> 3634 <code>checkInterval</code></br> 3635 <em> 3636 string 3637 </em> 3638 </td> 3639 <td> 3640 <p>CheckInterval is a string that describes an interval duration to check the directory state, e.g. 1s, 30m, 2h… (defaults to 1m)</p> 3641 </td> 3642 </tr> 3643 <tr> 3644 <td> 3645 <code>addresses</code></br> 3646 <em> 3647 []string 3648 </em> 3649 </td> 3650 <td> 3651 </td> 3652 </tr> 3653 <tr> 3654 <td> 3655 <code>hdfsUser</code></br> 3656 <em> 3657 string 3658 </em> 3659 </td> 3660 <td> 3661 <p>HDFSUser is the user to access HDFS file system. 3662 It is ignored if either ccache or keytab is used.</p> 3663 </td> 3664 </tr> 3665 <tr> 3666 <td> 3667 <code>krbCCacheSecret</code></br> 3668 <em> 3669 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3670 Kubernetes core/v1.SecretKeySelector 3671 </a> 3672 </em> 3673 </td> 3674 <td> 3675 <p>KrbCCacheSecret is the secret selector for Kerberos ccache 3676 Either ccache or keytab can be set to use Kerberos.</p> 3677 </td> 3678 </tr> 3679 <tr> 3680 <td> 3681 <code>krbKeytabSecret</code></br> 3682 <em> 3683 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 3684 Kubernetes core/v1.SecretKeySelector 3685 </a> 3686 </em> 3687 </td> 3688 <td> 3689 <p>KrbKeytabSecret is the secret selector for Kerberos keytab 3690 Either ccache or keytab can be set to use Kerberos.</p> 3691 </td> 3692 </tr> 3693 <tr> 3694 <td> 3695 <code>krbUsername</code></br> 3696 <em> 3697 string 3698 </em> 3699 </td> 3700 <td> 3701 <p>KrbUsername is the Kerberos username used with Kerberos keytab 3702 It must be set if keytab is used.</p> 3703 </td> 3704 </tr> 3705 <tr> 3706 <td> 3707 <code>krbRealm</code></br> 3708 <em> 3709 string 3710 </em> 3711 </td> 3712 <td> 3713 <p>KrbRealm is the Kerberos realm used with Kerberos keytab 3714 It must be set if keytab is used.</p> 3715 </td> 3716 </tr> 3717 <tr> 3718 <td> 3719 <code>krbConfigConfigMap</code></br> 3720 <em> 3721 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#configmapkeyselector-v1-core"> 3722 Kubernetes core/v1.ConfigMapKeySelector 3723 </a> 3724 </em> 3725 </td> 3726 <td> 3727 <p>KrbConfig is the configmap selector for Kerberos config as string 3728 It must be set if either ccache or keytab is used.</p> 3729 </td> 3730 </tr> 3731 <tr> 3732 <td> 3733 <code>krbServicePrincipalName</code></br> 3734 <em> 3735 string 3736 </em> 3737 </td> 3738 <td> 3739 <p>KrbServicePrincipalName is the principal name of Kerberos service 3740 It must be set if either ccache or keytab is used.</p> 3741 </td> 3742 </tr> 3743 <tr> 3744 <td> 3745 <code>metadata</code></br> 3746 <em> 3747 map[string]string 3748 </em> 3749 </td> 3750 <td> 3751 <em>(Optional)</em> 3752 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 3753 </td> 3754 </tr> 3755 <tr> 3756 <td> 3757 <code>filter</code></br> 3758 <em> 3759 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 3760 EventSourceFilter 3761 </a> 3762 </em> 3763 </td> 3764 <td> 3765 <em>(Optional)</em> 3766 <p>Filter</p> 3767 </td> 3768 </tr> 3769 </tbody> 3770 </table> 3771 <h3 id="argoproj.io/v1alpha1.KafkaConsumerGroup">KafkaConsumerGroup 3772 </h3> 3773 <p> 3774 (<em>Appears on:</em> 3775 <a href="#argoproj.io/v1alpha1.KafkaEventSource">KafkaEventSource</a>) 3776 </p> 3777 <p> 3778 </p> 3779 <table> 3780 <thead> 3781 <tr> 3782 <th>Field</th> 3783 <th>Description</th> 3784 </tr> 3785 </thead> 3786 <tbody> 3787 <tr> 3788 <td> 3789 <code>groupName</code></br> 3790 <em> 3791 string 3792 </em> 3793 </td> 3794 <td> 3795 <p>The name for the consumer group to use</p> 3796 </td> 3797 </tr> 3798 <tr> 3799 <td> 3800 <code>oldest</code></br> 3801 <em> 3802 bool 3803 </em> 3804 </td> 3805 <td> 3806 <em>(Optional)</em> 3807 <p>When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false</p> 3808 </td> 3809 </tr> 3810 <tr> 3811 <td> 3812 <code>rebalanceStrategy</code></br> 3813 <em> 3814 string 3815 </em> 3816 </td> 3817 <td> 3818 <em>(Optional)</em> 3819 <p>Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default.</p> 3820 </td> 3821 </tr> 3822 </tbody> 3823 </table> 3824 <h3 id="argoproj.io/v1alpha1.KafkaEventSource">KafkaEventSource 3825 </h3> 3826 <p> 3827 (<em>Appears on:</em> 3828 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 3829 </p> 3830 <p> 3831 <p>KafkaEventSource refers to event-source for Kafka related events</p> 3832 </p> 3833 <table> 3834 <thead> 3835 <tr> 3836 <th>Field</th> 3837 <th>Description</th> 3838 </tr> 3839 </thead> 3840 <tbody> 3841 <tr> 3842 <td> 3843 <code>url</code></br> 3844 <em> 3845 string 3846 </em> 3847 </td> 3848 <td> 3849 <p>URL to kafka cluster, multiple URLs separated by comma</p> 3850 </td> 3851 </tr> 3852 <tr> 3853 <td> 3854 <code>partition</code></br> 3855 <em> 3856 string 3857 </em> 3858 </td> 3859 <td> 3860 <em>(Optional)</em> 3861 <p>Partition name</p> 3862 </td> 3863 </tr> 3864 <tr> 3865 <td> 3866 <code>topic</code></br> 3867 <em> 3868 string 3869 </em> 3870 </td> 3871 <td> 3872 <p>Topic name</p> 3873 </td> 3874 </tr> 3875 <tr> 3876 <td> 3877 <code>connectionBackoff</code></br> 3878 <em> 3879 github.com/argoproj/argo-events/pkg/apis/common.Backoff 3880 </em> 3881 </td> 3882 <td> 3883 <p>Backoff holds parameters applied to connection.</p> 3884 </td> 3885 </tr> 3886 <tr> 3887 <td> 3888 <code>tls</code></br> 3889 <em> 3890 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 3891 </em> 3892 </td> 3893 <td> 3894 <em>(Optional)</em> 3895 <p>TLS configuration for the kafka client.</p> 3896 </td> 3897 </tr> 3898 <tr> 3899 <td> 3900 <code>jsonBody</code></br> 3901 <em> 3902 bool 3903 </em> 3904 </td> 3905 <td> 3906 <em>(Optional)</em> 3907 <p>JSONBody specifies that all event body payload coming from this 3908 source will be JSON</p> 3909 </td> 3910 </tr> 3911 <tr> 3912 <td> 3913 <code>metadata</code></br> 3914 <em> 3915 map[string]string 3916 </em> 3917 </td> 3918 <td> 3919 <em>(Optional)</em> 3920 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 3921 </td> 3922 </tr> 3923 <tr> 3924 <td> 3925 <code>consumerGroup</code></br> 3926 <em> 3927 <a href="#argoproj.io/v1alpha1.KafkaConsumerGroup"> 3928 KafkaConsumerGroup 3929 </a> 3930 </em> 3931 </td> 3932 <td> 3933 <em>(Optional)</em> 3934 <p>Consumer group for kafka client</p> 3935 </td> 3936 </tr> 3937 <tr> 3938 <td> 3939 <code>limitEventsPerSecond</code></br> 3940 <em> 3941 int64 3942 </em> 3943 </td> 3944 <td> 3945 <em>(Optional)</em> 3946 <p>Sets a limit on how many events get read from kafka per second.</p> 3947 </td> 3948 </tr> 3949 <tr> 3950 <td> 3951 <code>version</code></br> 3952 <em> 3953 string 3954 </em> 3955 </td> 3956 <td> 3957 <em>(Optional)</em> 3958 <p>Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0</p> 3959 </td> 3960 </tr> 3961 <tr> 3962 <td> 3963 <code>sasl</code></br> 3964 <em> 3965 github.com/argoproj/argo-events/pkg/apis/common.SASLConfig 3966 </em> 3967 </td> 3968 <td> 3969 <em>(Optional)</em> 3970 <p>SASL configuration for the kafka client</p> 3971 </td> 3972 </tr> 3973 <tr> 3974 <td> 3975 <code>filter</code></br> 3976 <em> 3977 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 3978 EventSourceFilter 3979 </a> 3980 </em> 3981 </td> 3982 <td> 3983 <em>(Optional)</em> 3984 <p>Filter</p> 3985 </td> 3986 </tr> 3987 <tr> 3988 <td> 3989 <code>config</code></br> 3990 <em> 3991 string 3992 </em> 3993 </td> 3994 <td> 3995 <em>(Optional)</em> 3996 <p>Yaml format Sarama config for Kafka connection. 3997 It follows the struct of sarama.Config. See <a href="https://github.com/IBM/sarama/blob/main/config.go">https://github.com/IBM/sarama/blob/main/config.go</a> 3998 e.g.</p> 3999 <p>consumer: 4000 fetch: 4001 min: 1 4002 net: 4003 MaxOpenRequests: 5</p> 4004 </td> 4005 </tr> 4006 </tbody> 4007 </table> 4008 <h3 id="argoproj.io/v1alpha1.MQTTEventSource">MQTTEventSource 4009 </h3> 4010 <p> 4011 (<em>Appears on:</em> 4012 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4013 </p> 4014 <p> 4015 <p>MQTTEventSource refers to event-source for MQTT related events</p> 4016 </p> 4017 <table> 4018 <thead> 4019 <tr> 4020 <th>Field</th> 4021 <th>Description</th> 4022 </tr> 4023 </thead> 4024 <tbody> 4025 <tr> 4026 <td> 4027 <code>url</code></br> 4028 <em> 4029 string 4030 </em> 4031 </td> 4032 <td> 4033 <p>URL to connect to broker</p> 4034 </td> 4035 </tr> 4036 <tr> 4037 <td> 4038 <code>topic</code></br> 4039 <em> 4040 string 4041 </em> 4042 </td> 4043 <td> 4044 <p>Topic name</p> 4045 </td> 4046 </tr> 4047 <tr> 4048 <td> 4049 <code>clientId</code></br> 4050 <em> 4051 string 4052 </em> 4053 </td> 4054 <td> 4055 <p>ClientID is the id of the client</p> 4056 </td> 4057 </tr> 4058 <tr> 4059 <td> 4060 <code>connectionBackoff</code></br> 4061 <em> 4062 github.com/argoproj/argo-events/pkg/apis/common.Backoff 4063 </em> 4064 </td> 4065 <td> 4066 <p>ConnectionBackoff holds backoff applied to connection.</p> 4067 </td> 4068 </tr> 4069 <tr> 4070 <td> 4071 <code>jsonBody</code></br> 4072 <em> 4073 bool 4074 </em> 4075 </td> 4076 <td> 4077 <em>(Optional)</em> 4078 <p>JSONBody specifies that all event body payload coming from this 4079 source will be JSON</p> 4080 </td> 4081 </tr> 4082 <tr> 4083 <td> 4084 <code>tls</code></br> 4085 <em> 4086 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 4087 </em> 4088 </td> 4089 <td> 4090 <em>(Optional)</em> 4091 <p>TLS configuration for the mqtt client.</p> 4092 </td> 4093 </tr> 4094 <tr> 4095 <td> 4096 <code>metadata</code></br> 4097 <em> 4098 map[string]string 4099 </em> 4100 </td> 4101 <td> 4102 <em>(Optional)</em> 4103 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4104 </td> 4105 </tr> 4106 <tr> 4107 <td> 4108 <code>filter</code></br> 4109 <em> 4110 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4111 EventSourceFilter 4112 </a> 4113 </em> 4114 </td> 4115 <td> 4116 <em>(Optional)</em> 4117 <p>Filter</p> 4118 </td> 4119 </tr> 4120 <tr> 4121 <td> 4122 <code>auth</code></br> 4123 <em> 4124 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth 4125 </em> 4126 </td> 4127 <td> 4128 <em>(Optional)</em> 4129 <p>Auth hosts secret selectors for username and password</p> 4130 </td> 4131 </tr> 4132 </tbody> 4133 </table> 4134 <h3 id="argoproj.io/v1alpha1.NATSAuth">NATSAuth 4135 </h3> 4136 <p> 4137 (<em>Appears on:</em> 4138 <a href="#argoproj.io/v1alpha1.NATSEventsSource">NATSEventsSource</a>) 4139 </p> 4140 <p> 4141 <p>NATSAuth refers to the auth info for NATS EventSource</p> 4142 </p> 4143 <table> 4144 <thead> 4145 <tr> 4146 <th>Field</th> 4147 <th>Description</th> 4148 </tr> 4149 </thead> 4150 <tbody> 4151 <tr> 4152 <td> 4153 <code>basic</code></br> 4154 <em> 4155 github.com/argoproj/argo-events/pkg/apis/common.BasicAuth 4156 </em> 4157 </td> 4158 <td> 4159 <em>(Optional)</em> 4160 <p>Baisc auth with username and password</p> 4161 </td> 4162 </tr> 4163 <tr> 4164 <td> 4165 <code>token</code></br> 4166 <em> 4167 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4168 Kubernetes core/v1.SecretKeySelector 4169 </a> 4170 </em> 4171 </td> 4172 <td> 4173 <em>(Optional)</em> 4174 <p>Token used to connect</p> 4175 </td> 4176 </tr> 4177 <tr> 4178 <td> 4179 <code>nkey</code></br> 4180 <em> 4181 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4182 Kubernetes core/v1.SecretKeySelector 4183 </a> 4184 </em> 4185 </td> 4186 <td> 4187 <em>(Optional)</em> 4188 <p>NKey used to connect</p> 4189 </td> 4190 </tr> 4191 <tr> 4192 <td> 4193 <code>credential</code></br> 4194 <em> 4195 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4196 Kubernetes core/v1.SecretKeySelector 4197 </a> 4198 </em> 4199 </td> 4200 <td> 4201 <em>(Optional)</em> 4202 <p>credential used to connect</p> 4203 </td> 4204 </tr> 4205 </tbody> 4206 </table> 4207 <h3 id="argoproj.io/v1alpha1.NATSEventsSource">NATSEventsSource 4208 </h3> 4209 <p> 4210 (<em>Appears on:</em> 4211 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4212 </p> 4213 <p> 4214 <p>NATSEventsSource refers to event-source for NATS related events</p> 4215 </p> 4216 <table> 4217 <thead> 4218 <tr> 4219 <th>Field</th> 4220 <th>Description</th> 4221 </tr> 4222 </thead> 4223 <tbody> 4224 <tr> 4225 <td> 4226 <code>url</code></br> 4227 <em> 4228 string 4229 </em> 4230 </td> 4231 <td> 4232 <p>URL to connect to NATS cluster</p> 4233 </td> 4234 </tr> 4235 <tr> 4236 <td> 4237 <code>subject</code></br> 4238 <em> 4239 string 4240 </em> 4241 </td> 4242 <td> 4243 <p>Subject holds the name of the subject onto which messages are published</p> 4244 </td> 4245 </tr> 4246 <tr> 4247 <td> 4248 <code>connectionBackoff</code></br> 4249 <em> 4250 github.com/argoproj/argo-events/pkg/apis/common.Backoff 4251 </em> 4252 </td> 4253 <td> 4254 <p>ConnectionBackoff holds backoff applied to connection.</p> 4255 </td> 4256 </tr> 4257 <tr> 4258 <td> 4259 <code>jsonBody</code></br> 4260 <em> 4261 bool 4262 </em> 4263 </td> 4264 <td> 4265 <em>(Optional)</em> 4266 <p>JSONBody specifies that all event body payload coming from this 4267 source will be JSON</p> 4268 </td> 4269 </tr> 4270 <tr> 4271 <td> 4272 <code>tls</code></br> 4273 <em> 4274 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 4275 </em> 4276 </td> 4277 <td> 4278 <em>(Optional)</em> 4279 <p>TLS configuration for the nats client.</p> 4280 </td> 4281 </tr> 4282 <tr> 4283 <td> 4284 <code>metadata</code></br> 4285 <em> 4286 map[string]string 4287 </em> 4288 </td> 4289 <td> 4290 <em>(Optional)</em> 4291 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4292 </td> 4293 </tr> 4294 <tr> 4295 <td> 4296 <code>auth</code></br> 4297 <em> 4298 <a href="#argoproj.io/v1alpha1.NATSAuth"> 4299 NATSAuth 4300 </a> 4301 </em> 4302 </td> 4303 <td> 4304 <em>(Optional)</em> 4305 <p>Auth information</p> 4306 </td> 4307 </tr> 4308 <tr> 4309 <td> 4310 <code>filter</code></br> 4311 <em> 4312 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4313 EventSourceFilter 4314 </a> 4315 </em> 4316 </td> 4317 <td> 4318 <em>(Optional)</em> 4319 <p>Filter</p> 4320 </td> 4321 </tr> 4322 </tbody> 4323 </table> 4324 <h3 id="argoproj.io/v1alpha1.NSQEventSource">NSQEventSource 4325 </h3> 4326 <p> 4327 (<em>Appears on:</em> 4328 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4329 </p> 4330 <p> 4331 <p>NSQEventSource describes the event source for NSQ PubSub 4332 More info at <a href="https://godoc.org/github.com/nsqio/go-nsq">https://godoc.org/github.com/nsqio/go-nsq</a></p> 4333 </p> 4334 <table> 4335 <thead> 4336 <tr> 4337 <th>Field</th> 4338 <th>Description</th> 4339 </tr> 4340 </thead> 4341 <tbody> 4342 <tr> 4343 <td> 4344 <code>hostAddress</code></br> 4345 <em> 4346 string 4347 </em> 4348 </td> 4349 <td> 4350 <p>HostAddress is the address of the host for NSQ lookup</p> 4351 </td> 4352 </tr> 4353 <tr> 4354 <td> 4355 <code>topic</code></br> 4356 <em> 4357 string 4358 </em> 4359 </td> 4360 <td> 4361 <p>Topic to subscribe to.</p> 4362 </td> 4363 </tr> 4364 <tr> 4365 <td> 4366 <code>channel</code></br> 4367 <em> 4368 string 4369 </em> 4370 </td> 4371 <td> 4372 <p>Channel used for subscription</p> 4373 </td> 4374 </tr> 4375 <tr> 4376 <td> 4377 <code>connectionBackoff</code></br> 4378 <em> 4379 github.com/argoproj/argo-events/pkg/apis/common.Backoff 4380 </em> 4381 </td> 4382 <td> 4383 <em>(Optional)</em> 4384 <p>Backoff holds parameters applied to connection.</p> 4385 </td> 4386 </tr> 4387 <tr> 4388 <td> 4389 <code>jsonBody</code></br> 4390 <em> 4391 bool 4392 </em> 4393 </td> 4394 <td> 4395 <em>(Optional)</em> 4396 <p>JSONBody specifies that all event body payload coming from this 4397 source will be JSON</p> 4398 </td> 4399 </tr> 4400 <tr> 4401 <td> 4402 <code>tls</code></br> 4403 <em> 4404 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 4405 </em> 4406 </td> 4407 <td> 4408 <em>(Optional)</em> 4409 <p>TLS configuration for the nsq client.</p> 4410 </td> 4411 </tr> 4412 <tr> 4413 <td> 4414 <code>metadata</code></br> 4415 <em> 4416 map[string]string 4417 </em> 4418 </td> 4419 <td> 4420 <em>(Optional)</em> 4421 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4422 </td> 4423 </tr> 4424 <tr> 4425 <td> 4426 <code>filter</code></br> 4427 <em> 4428 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4429 EventSourceFilter 4430 </a> 4431 </em> 4432 </td> 4433 <td> 4434 <em>(Optional)</em> 4435 <p>Filter</p> 4436 </td> 4437 </tr> 4438 </tbody> 4439 </table> 4440 <h3 id="argoproj.io/v1alpha1.OwnedRepositories">OwnedRepositories 4441 </h3> 4442 <p> 4443 (<em>Appears on:</em> 4444 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>) 4445 </p> 4446 <p> 4447 </p> 4448 <table> 4449 <thead> 4450 <tr> 4451 <th>Field</th> 4452 <th>Description</th> 4453 </tr> 4454 </thead> 4455 <tbody> 4456 <tr> 4457 <td> 4458 <code>owner</code></br> 4459 <em> 4460 string 4461 </em> 4462 </td> 4463 <td> 4464 <p>Organization or user name</p> 4465 </td> 4466 </tr> 4467 <tr> 4468 <td> 4469 <code>names</code></br> 4470 <em> 4471 []string 4472 </em> 4473 </td> 4474 <td> 4475 <p>Repository names</p> 4476 </td> 4477 </tr> 4478 </tbody> 4479 </table> 4480 <h3 id="argoproj.io/v1alpha1.PubSubEventSource">PubSubEventSource 4481 </h3> 4482 <p> 4483 (<em>Appears on:</em> 4484 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4485 </p> 4486 <p> 4487 <p>PubSubEventSource refers to event-source for GCP PubSub related events.</p> 4488 </p> 4489 <table> 4490 <thead> 4491 <tr> 4492 <th>Field</th> 4493 <th>Description</th> 4494 </tr> 4495 </thead> 4496 <tbody> 4497 <tr> 4498 <td> 4499 <code>projectID</code></br> 4500 <em> 4501 string 4502 </em> 4503 </td> 4504 <td> 4505 <em>(Optional)</em> 4506 <p>ProjectID is GCP project ID for the subscription. 4507 Required if you run Argo Events outside of GKE/GCE. 4508 (otherwise, the default value is its project)</p> 4509 </td> 4510 </tr> 4511 <tr> 4512 <td> 4513 <code>topicProjectID</code></br> 4514 <em> 4515 string 4516 </em> 4517 </td> 4518 <td> 4519 <em>(Optional)</em> 4520 <p>TopicProjectID is GCP project ID for the topic. 4521 By default, it is same as ProjectID.</p> 4522 </td> 4523 </tr> 4524 <tr> 4525 <td> 4526 <code>topic</code></br> 4527 <em> 4528 string 4529 </em> 4530 </td> 4531 <td> 4532 <em>(Optional)</em> 4533 <p>Topic to which the subscription should belongs. 4534 Required if you want the eventsource to create a new subscription. 4535 If you specify this field along with an existing subscription, 4536 it will be verified whether it actually belongs to the specified topic.</p> 4537 </td> 4538 </tr> 4539 <tr> 4540 <td> 4541 <code>subscriptionID</code></br> 4542 <em> 4543 string 4544 </em> 4545 </td> 4546 <td> 4547 <em>(Optional)</em> 4548 <p>SubscriptionID is ID of subscription. 4549 Required if you use existing subscription. 4550 The default value will be auto generated hash based on this eventsource setting, so the subscription 4551 might be recreated every time you update the setting, which has a possibility of event loss.</p> 4552 </td> 4553 </tr> 4554 <tr> 4555 <td> 4556 <code>credentialSecret</code></br> 4557 <em> 4558 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4559 Kubernetes core/v1.SecretKeySelector 4560 </a> 4561 </em> 4562 </td> 4563 <td> 4564 <em>(Optional)</em> 4565 <p>CredentialSecret references to the secret that contains JSON credentials to access GCP. 4566 If it is missing, it implicitly uses Workload Identity to access. 4567 <a href="https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity">https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity</a></p> 4568 </td> 4569 </tr> 4570 <tr> 4571 <td> 4572 <code>deleteSubscriptionOnFinish</code></br> 4573 <em> 4574 bool 4575 </em> 4576 </td> 4577 <td> 4578 <em>(Optional)</em> 4579 <p>DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub subscription once the event source is stopped.</p> 4580 </td> 4581 </tr> 4582 <tr> 4583 <td> 4584 <code>jsonBody</code></br> 4585 <em> 4586 bool 4587 </em> 4588 </td> 4589 <td> 4590 <em>(Optional)</em> 4591 <p>JSONBody specifies that all event body payload coming from this 4592 source will be JSON</p> 4593 </td> 4594 </tr> 4595 <tr> 4596 <td> 4597 <code>metadata</code></br> 4598 <em> 4599 map[string]string 4600 </em> 4601 </td> 4602 <td> 4603 <em>(Optional)</em> 4604 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4605 </td> 4606 </tr> 4607 <tr> 4608 <td> 4609 <code>filter</code></br> 4610 <em> 4611 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4612 EventSourceFilter 4613 </a> 4614 </em> 4615 </td> 4616 <td> 4617 <em>(Optional)</em> 4618 <p>Filter</p> 4619 </td> 4620 </tr> 4621 </tbody> 4622 </table> 4623 <h3 id="argoproj.io/v1alpha1.PulsarEventSource">PulsarEventSource 4624 </h3> 4625 <p> 4626 (<em>Appears on:</em> 4627 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4628 </p> 4629 <p> 4630 <p>PulsarEventSource describes the event source for Apache Pulsar</p> 4631 </p> 4632 <table> 4633 <thead> 4634 <tr> 4635 <th>Field</th> 4636 <th>Description</th> 4637 </tr> 4638 </thead> 4639 <tbody> 4640 <tr> 4641 <td> 4642 <code>topics</code></br> 4643 <em> 4644 []string 4645 </em> 4646 </td> 4647 <td> 4648 <p>Name of the topics to subscribe to.</p> 4649 </td> 4650 </tr> 4651 <tr> 4652 <td> 4653 <code>type</code></br> 4654 <em> 4655 string 4656 </em> 4657 </td> 4658 <td> 4659 <em>(Optional)</em> 4660 <p>Type of the subscription. 4661 Only “exclusive” and “shared” is supported. 4662 Defaults to exclusive.</p> 4663 </td> 4664 </tr> 4665 <tr> 4666 <td> 4667 <code>url</code></br> 4668 <em> 4669 string 4670 </em> 4671 </td> 4672 <td> 4673 <p>Configure the service URL for the Pulsar service.</p> 4674 </td> 4675 </tr> 4676 <tr> 4677 <td> 4678 <code>tlsTrustCertsSecret</code></br> 4679 <em> 4680 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4681 Kubernetes core/v1.SecretKeySelector 4682 </a> 4683 </em> 4684 </td> 4685 <td> 4686 <em>(Optional)</em> 4687 <p>Trusted TLS certificate secret.</p> 4688 </td> 4689 </tr> 4690 <tr> 4691 <td> 4692 <code>tlsAllowInsecureConnection</code></br> 4693 <em> 4694 bool 4695 </em> 4696 </td> 4697 <td> 4698 <em>(Optional)</em> 4699 <p>Whether the Pulsar client accept untrusted TLS certificate from broker.</p> 4700 </td> 4701 </tr> 4702 <tr> 4703 <td> 4704 <code>tlsValidateHostname</code></br> 4705 <em> 4706 bool 4707 </em> 4708 </td> 4709 <td> 4710 <em>(Optional)</em> 4711 <p>Whether the Pulsar client verify the validity of the host name from broker.</p> 4712 </td> 4713 </tr> 4714 <tr> 4715 <td> 4716 <code>tls</code></br> 4717 <em> 4718 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 4719 </em> 4720 </td> 4721 <td> 4722 <em>(Optional)</em> 4723 <p>TLS configuration for the pulsar client.</p> 4724 </td> 4725 </tr> 4726 <tr> 4727 <td> 4728 <code>connectionBackoff</code></br> 4729 <em> 4730 github.com/argoproj/argo-events/pkg/apis/common.Backoff 4731 </em> 4732 </td> 4733 <td> 4734 <em>(Optional)</em> 4735 <p>Backoff holds parameters applied to connection.</p> 4736 </td> 4737 </tr> 4738 <tr> 4739 <td> 4740 <code>jsonBody</code></br> 4741 <em> 4742 bool 4743 </em> 4744 </td> 4745 <td> 4746 <em>(Optional)</em> 4747 <p>JSONBody specifies that all event body payload coming from this 4748 source will be JSON</p> 4749 </td> 4750 </tr> 4751 <tr> 4752 <td> 4753 <code>metadata</code></br> 4754 <em> 4755 map[string]string 4756 </em> 4757 </td> 4758 <td> 4759 <em>(Optional)</em> 4760 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4761 </td> 4762 </tr> 4763 <tr> 4764 <td> 4765 <code>authTokenSecret</code></br> 4766 <em> 4767 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4768 Kubernetes core/v1.SecretKeySelector 4769 </a> 4770 </em> 4771 </td> 4772 <td> 4773 <em>(Optional)</em> 4774 <p>Authentication token for the pulsar client. 4775 Either token or athenz can be set to use auth.</p> 4776 </td> 4777 </tr> 4778 <tr> 4779 <td> 4780 <code>filter</code></br> 4781 <em> 4782 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4783 EventSourceFilter 4784 </a> 4785 </em> 4786 </td> 4787 <td> 4788 <em>(Optional)</em> 4789 <p>Filter</p> 4790 </td> 4791 </tr> 4792 <tr> 4793 <td> 4794 <code>authAthenzParams</code></br> 4795 <em> 4796 map[string]string 4797 </em> 4798 </td> 4799 <td> 4800 <em>(Optional)</em> 4801 <p>Authentication athenz parameters for the pulsar client. 4802 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> 4803 Either token or athenz can be set to use auth.</p> 4804 </td> 4805 </tr> 4806 <tr> 4807 <td> 4808 <code>authAthenzSecret</code></br> 4809 <em> 4810 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4811 Kubernetes core/v1.SecretKeySelector 4812 </a> 4813 </em> 4814 </td> 4815 <td> 4816 <em>(Optional)</em> 4817 <p>Authentication athenz privateKey secret for the pulsar client. 4818 AuthAthenzSecret must be set if AuthAthenzParams is used.</p> 4819 </td> 4820 </tr> 4821 </tbody> 4822 </table> 4823 <h3 id="argoproj.io/v1alpha1.RedisEventSource">RedisEventSource 4824 </h3> 4825 <p> 4826 (<em>Appears on:</em> 4827 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4828 </p> 4829 <p> 4830 <p>RedisEventSource describes an event source for the Redis PubSub. 4831 More info at <a href="https://godoc.org/github.com/go-redis/redis#example-PubSub">https://godoc.org/github.com/go-redis/redis#example-PubSub</a></p> 4832 </p> 4833 <table> 4834 <thead> 4835 <tr> 4836 <th>Field</th> 4837 <th>Description</th> 4838 </tr> 4839 </thead> 4840 <tbody> 4841 <tr> 4842 <td> 4843 <code>hostAddress</code></br> 4844 <em> 4845 string 4846 </em> 4847 </td> 4848 <td> 4849 <p>HostAddress refers to the address of the Redis host/server</p> 4850 </td> 4851 </tr> 4852 <tr> 4853 <td> 4854 <code>password</code></br> 4855 <em> 4856 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4857 Kubernetes core/v1.SecretKeySelector 4858 </a> 4859 </em> 4860 </td> 4861 <td> 4862 <em>(Optional)</em> 4863 <p>Password required for authentication if any.</p> 4864 </td> 4865 </tr> 4866 <tr> 4867 <td> 4868 <code>namespace</code></br> 4869 <em> 4870 string 4871 </em> 4872 </td> 4873 <td> 4874 <em>(Optional)</em> 4875 <p>Namespace to use to retrieve the password from. It should only be specified if password is declared</p> 4876 </td> 4877 </tr> 4878 <tr> 4879 <td> 4880 <code>db</code></br> 4881 <em> 4882 int32 4883 </em> 4884 </td> 4885 <td> 4886 <em>(Optional)</em> 4887 <p>DB to use. If not specified, default DB 0 will be used.</p> 4888 </td> 4889 </tr> 4890 <tr> 4891 <td> 4892 <code>channels</code></br> 4893 <em> 4894 []string 4895 </em> 4896 </td> 4897 <td> 4898 </td> 4899 </tr> 4900 <tr> 4901 <td> 4902 <code>tls</code></br> 4903 <em> 4904 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 4905 </em> 4906 </td> 4907 <td> 4908 <em>(Optional)</em> 4909 <p>TLS configuration for the redis client.</p> 4910 </td> 4911 </tr> 4912 <tr> 4913 <td> 4914 <code>metadata</code></br> 4915 <em> 4916 map[string]string 4917 </em> 4918 </td> 4919 <td> 4920 <em>(Optional)</em> 4921 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 4922 </td> 4923 </tr> 4924 <tr> 4925 <td> 4926 <code>filter</code></br> 4927 <em> 4928 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 4929 EventSourceFilter 4930 </a> 4931 </em> 4932 </td> 4933 <td> 4934 <em>(Optional)</em> 4935 <p>Filter</p> 4936 </td> 4937 </tr> 4938 <tr> 4939 <td> 4940 <code>jsonBody</code></br> 4941 <em> 4942 bool 4943 </em> 4944 </td> 4945 <td> 4946 <em>(Optional)</em> 4947 <p>JSONBody specifies that all event body payload coming from this 4948 source will be JSON</p> 4949 </td> 4950 </tr> 4951 <tr> 4952 <td> 4953 <code>username</code></br> 4954 <em> 4955 string 4956 </em> 4957 </td> 4958 <td> 4959 <em>(Optional)</em> 4960 <p>Username required for ACL style authentication if any.</p> 4961 </td> 4962 </tr> 4963 </tbody> 4964 </table> 4965 <h3 id="argoproj.io/v1alpha1.RedisStreamEventSource">RedisStreamEventSource 4966 </h3> 4967 <p> 4968 (<em>Appears on:</em> 4969 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 4970 </p> 4971 <p> 4972 <p>RedisStreamEventSource describes an event source for 4973 Redis streams (<a href="https://redis.io/topics/streams-intro">https://redis.io/topics/streams-intro</a>)</p> 4974 </p> 4975 <table> 4976 <thead> 4977 <tr> 4978 <th>Field</th> 4979 <th>Description</th> 4980 </tr> 4981 </thead> 4982 <tbody> 4983 <tr> 4984 <td> 4985 <code>hostAddress</code></br> 4986 <em> 4987 string 4988 </em> 4989 </td> 4990 <td> 4991 <p>HostAddress refers to the address of the Redis host/server (master instance)</p> 4992 </td> 4993 </tr> 4994 <tr> 4995 <td> 4996 <code>password</code></br> 4997 <em> 4998 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 4999 Kubernetes core/v1.SecretKeySelector 5000 </a> 5001 </em> 5002 </td> 5003 <td> 5004 <em>(Optional)</em> 5005 <p>Password required for authentication if any.</p> 5006 </td> 5007 </tr> 5008 <tr> 5009 <td> 5010 <code>db</code></br> 5011 <em> 5012 int32 5013 </em> 5014 </td> 5015 <td> 5016 <em>(Optional)</em> 5017 <p>DB to use. If not specified, default DB 0 will be used.</p> 5018 </td> 5019 </tr> 5020 <tr> 5021 <td> 5022 <code>streams</code></br> 5023 <em> 5024 []string 5025 </em> 5026 </td> 5027 <td> 5028 <p>Streams to look for entries. XREADGROUP is used on all streams using a single consumer group.</p> 5029 </td> 5030 </tr> 5031 <tr> 5032 <td> 5033 <code>maxMsgCountPerRead</code></br> 5034 <em> 5035 int32 5036 </em> 5037 </td> 5038 <td> 5039 <em>(Optional)</em> 5040 <p>MaxMsgCountPerRead holds the maximum number of messages per stream that will be read in each XREADGROUP of all streams 5041 Example: if there are 2 streams and MaxMsgCountPerRead=10, then each XREADGROUP may read upto a total of 20 messages. 5042 Same as COUNT option in XREADGROUP(<a href="https://redis.io/topics/streams-intro">https://redis.io/topics/streams-intro</a>). Defaults to 10</p> 5043 </td> 5044 </tr> 5045 <tr> 5046 <td> 5047 <code>consumerGroup</code></br> 5048 <em> 5049 string 5050 </em> 5051 </td> 5052 <td> 5053 <em>(Optional)</em> 5054 <p>ConsumerGroup refers to the Redis stream consumer group that will be 5055 created on all redis streams. Messages are read through this group. Defaults to ‘argo-events-cg’</p> 5056 </td> 5057 </tr> 5058 <tr> 5059 <td> 5060 <code>tls</code></br> 5061 <em> 5062 github.com/argoproj/argo-events/pkg/apis/common.TLSConfig 5063 </em> 5064 </td> 5065 <td> 5066 <em>(Optional)</em> 5067 <p>TLS configuration for the redis client.</p> 5068 </td> 5069 </tr> 5070 <tr> 5071 <td> 5072 <code>metadata</code></br> 5073 <em> 5074 map[string]string 5075 </em> 5076 </td> 5077 <td> 5078 <em>(Optional)</em> 5079 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5080 </td> 5081 </tr> 5082 <tr> 5083 <td> 5084 <code>filter</code></br> 5085 <em> 5086 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 5087 EventSourceFilter 5088 </a> 5089 </em> 5090 </td> 5091 <td> 5092 <em>(Optional)</em> 5093 <p>Filter</p> 5094 </td> 5095 </tr> 5096 <tr> 5097 <td> 5098 <code>username</code></br> 5099 <em> 5100 string 5101 </em> 5102 </td> 5103 <td> 5104 <em>(Optional)</em> 5105 <p>Username required for ACL style authentication if any.</p> 5106 </td> 5107 </tr> 5108 </tbody> 5109 </table> 5110 <h3 id="argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource 5111 </h3> 5112 <p> 5113 (<em>Appears on:</em> 5114 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5115 </p> 5116 <p> 5117 <p>ResourceEventSource refers to a event-source for K8s resource related events.</p> 5118 </p> 5119 <table> 5120 <thead> 5121 <tr> 5122 <th>Field</th> 5123 <th>Description</th> 5124 </tr> 5125 </thead> 5126 <tbody> 5127 <tr> 5128 <td> 5129 <code>namespace</code></br> 5130 <em> 5131 string 5132 </em> 5133 </td> 5134 <td> 5135 <p>Namespace where resource is deployed</p> 5136 </td> 5137 </tr> 5138 <tr> 5139 <td> 5140 <code>filter</code></br> 5141 <em> 5142 <a href="#argoproj.io/v1alpha1.ResourceFilter"> 5143 ResourceFilter 5144 </a> 5145 </em> 5146 </td> 5147 <td> 5148 <em>(Optional)</em> 5149 <p>Filter is applied on the metadata of the resource 5150 If you apply filter, then the internal event informer will only monitor objects that pass the filter.</p> 5151 </td> 5152 </tr> 5153 <tr> 5154 <td> 5155 <code>GroupVersionResource</code></br> 5156 <em> 5157 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#groupversionresource-v1-meta"> 5158 Kubernetes meta/v1.GroupVersionResource 5159 </a> 5160 </em> 5161 </td> 5162 <td> 5163 <p> 5164 (Members of <code>GroupVersionResource</code> are embedded into this type.) 5165 </p> 5166 <p>Group of the resource</p> 5167 </td> 5168 </tr> 5169 <tr> 5170 <td> 5171 <code>eventTypes</code></br> 5172 <em> 5173 <a href="#argoproj.io/v1alpha1.ResourceEventType"> 5174 []ResourceEventType 5175 </a> 5176 </em> 5177 </td> 5178 <td> 5179 <p>EventTypes is the list of event type to watch. 5180 Possible values are - ADD, UPDATE and DELETE.</p> 5181 </td> 5182 </tr> 5183 <tr> 5184 <td> 5185 <code>metadata</code></br> 5186 <em> 5187 map[string]string 5188 </em> 5189 </td> 5190 <td> 5191 <em>(Optional)</em> 5192 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5193 </td> 5194 </tr> 5195 </tbody> 5196 </table> 5197 <h3 id="argoproj.io/v1alpha1.ResourceEventType">ResourceEventType 5198 (<code>string</code> alias)</p></h3> 5199 <p> 5200 (<em>Appears on:</em> 5201 <a href="#argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource</a>) 5202 </p> 5203 <p> 5204 <p>ResourceEventType is the type of event for the K8s resource mutation</p> 5205 </p> 5206 <h3 id="argoproj.io/v1alpha1.ResourceFilter">ResourceFilter 5207 </h3> 5208 <p> 5209 (<em>Appears on:</em> 5210 <a href="#argoproj.io/v1alpha1.ResourceEventSource">ResourceEventSource</a>) 5211 </p> 5212 <p> 5213 <p>ResourceFilter contains K8s ObjectMeta information to further filter resource event objects</p> 5214 </p> 5215 <table> 5216 <thead> 5217 <tr> 5218 <th>Field</th> 5219 <th>Description</th> 5220 </tr> 5221 </thead> 5222 <tbody> 5223 <tr> 5224 <td> 5225 <code>prefix</code></br> 5226 <em> 5227 string 5228 </em> 5229 </td> 5230 <td> 5231 <em>(Optional)</em> 5232 <p>Prefix filter is applied on the resource name.</p> 5233 </td> 5234 </tr> 5235 <tr> 5236 <td> 5237 <code>labels</code></br> 5238 <em> 5239 <a href="#argoproj.io/v1alpha1.Selector"> 5240 []Selector 5241 </a> 5242 </em> 5243 </td> 5244 <td> 5245 <em>(Optional)</em> 5246 <p>Labels provide listing options to K8s API to watch resource/s. 5247 Refer <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/">https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/</a> for more info. 5248 Unlike K8s field selector, multiple values are passed as comma separated values instead of list of values. 5249 Eg: value: value1,value2. 5250 Same as K8s label selector, operator “=”, “==”, “!=”, “exists”, “!”, “notin”, “in”, “gt” and “lt” 5251 are supported</p> 5252 </td> 5253 </tr> 5254 <tr> 5255 <td> 5256 <code>fields</code></br> 5257 <em> 5258 <a href="#argoproj.io/v1alpha1.Selector"> 5259 []Selector 5260 </a> 5261 </em> 5262 </td> 5263 <td> 5264 <em>(Optional)</em> 5265 <p>Fields provide field filters similar to K8s field selector 5266 (see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/">https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/</a>). 5267 Unlike K8s field selector, it supports arbitrary fileds like “spec.serviceAccountName”, 5268 and the value could be a string or a regex. 5269 Same as K8s field selector, operator “=”, “==” and “!=” are supported.</p> 5270 </td> 5271 </tr> 5272 <tr> 5273 <td> 5274 <code>createdBy</code></br> 5275 <em> 5276 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#time-v1-meta"> 5277 Kubernetes meta/v1.Time 5278 </a> 5279 </em> 5280 </td> 5281 <td> 5282 <em>(Optional)</em> 5283 <p>If resource is created before the specified time then the event is treated as valid.</p> 5284 </td> 5285 </tr> 5286 <tr> 5287 <td> 5288 <code>afterStart</code></br> 5289 <em> 5290 bool 5291 </em> 5292 </td> 5293 <td> 5294 <em>(Optional)</em> 5295 <p>If the resource is created after the start time then the event is treated as valid.</p> 5296 </td> 5297 </tr> 5298 </tbody> 5299 </table> 5300 <h3 id="argoproj.io/v1alpha1.SFTPEventSource">SFTPEventSource 5301 </h3> 5302 <p> 5303 (<em>Appears on:</em> 5304 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5305 </p> 5306 <p> 5307 <p>SFTPEventSource describes an event-source for sftp related events.</p> 5308 </p> 5309 <table> 5310 <thead> 5311 <tr> 5312 <th>Field</th> 5313 <th>Description</th> 5314 </tr> 5315 </thead> 5316 <tbody> 5317 <tr> 5318 <td> 5319 <code>eventType</code></br> 5320 <em> 5321 string 5322 </em> 5323 </td> 5324 <td> 5325 <p>Type of file operations to watch 5326 Refer <a href="https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go">https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go</a> for more information</p> 5327 </td> 5328 </tr> 5329 <tr> 5330 <td> 5331 <code>watchPathConfig</code></br> 5332 <em> 5333 <a href="#argoproj.io/v1alpha1.WatchPathConfig"> 5334 WatchPathConfig 5335 </a> 5336 </em> 5337 </td> 5338 <td> 5339 <p>WatchPathConfig contains configuration about the file path to watch</p> 5340 </td> 5341 </tr> 5342 <tr> 5343 <td> 5344 <code>username</code></br> 5345 <em> 5346 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5347 Kubernetes core/v1.SecretKeySelector 5348 </a> 5349 </em> 5350 </td> 5351 <td> 5352 <p>Username required for authentication if any.</p> 5353 </td> 5354 </tr> 5355 <tr> 5356 <td> 5357 <code>password</code></br> 5358 <em> 5359 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5360 Kubernetes core/v1.SecretKeySelector 5361 </a> 5362 </em> 5363 </td> 5364 <td> 5365 <p>Password required for authentication if any.</p> 5366 </td> 5367 </tr> 5368 <tr> 5369 <td> 5370 <code>sshKeySecret</code></br> 5371 <em> 5372 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5373 Kubernetes core/v1.SecretKeySelector 5374 </a> 5375 </em> 5376 </td> 5377 <td> 5378 <p>SSHKeySecret refers to the secret that contains SSH key</p> 5379 </td> 5380 </tr> 5381 <tr> 5382 <td> 5383 <code>address</code></br> 5384 <em> 5385 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5386 Kubernetes core/v1.SecretKeySelector 5387 </a> 5388 </em> 5389 </td> 5390 <td> 5391 <p>Address sftp address.</p> 5392 </td> 5393 </tr> 5394 <tr> 5395 <td> 5396 <code>metadata</code></br> 5397 <em> 5398 map[string]string 5399 </em> 5400 </td> 5401 <td> 5402 <em>(Optional)</em> 5403 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5404 </td> 5405 </tr> 5406 <tr> 5407 <td> 5408 <code>filter</code></br> 5409 <em> 5410 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 5411 EventSourceFilter 5412 </a> 5413 </em> 5414 </td> 5415 <td> 5416 <em>(Optional)</em> 5417 <p>Filter</p> 5418 </td> 5419 </tr> 5420 <tr> 5421 <td> 5422 <code>pollIntervalDuration</code></br> 5423 <em> 5424 string 5425 </em> 5426 </td> 5427 <td> 5428 <em>(Optional)</em> 5429 <p>PollIntervalDuration the interval at which to poll the SFTP server 5430 defaults to 10 seconds</p> 5431 </td> 5432 </tr> 5433 </tbody> 5434 </table> 5435 <h3 id="argoproj.io/v1alpha1.SNSEventSource">SNSEventSource 5436 </h3> 5437 <p> 5438 (<em>Appears on:</em> 5439 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5440 </p> 5441 <p> 5442 <p>SNSEventSource refers to event-source for AWS SNS related events</p> 5443 </p> 5444 <table> 5445 <thead> 5446 <tr> 5447 <th>Field</th> 5448 <th>Description</th> 5449 </tr> 5450 </thead> 5451 <tbody> 5452 <tr> 5453 <td> 5454 <code>webhook</code></br> 5455 <em> 5456 <a href="#argoproj.io/v1alpha1.WebhookContext"> 5457 WebhookContext 5458 </a> 5459 </em> 5460 </td> 5461 <td> 5462 <p>Webhook configuration for http server</p> 5463 </td> 5464 </tr> 5465 <tr> 5466 <td> 5467 <code>topicArn</code></br> 5468 <em> 5469 string 5470 </em> 5471 </td> 5472 <td> 5473 <p>TopicArn</p> 5474 </td> 5475 </tr> 5476 <tr> 5477 <td> 5478 <code>accessKey</code></br> 5479 <em> 5480 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5481 Kubernetes core/v1.SecretKeySelector 5482 </a> 5483 </em> 5484 </td> 5485 <td> 5486 <p>AccessKey refers K8s secret containing aws access key</p> 5487 </td> 5488 </tr> 5489 <tr> 5490 <td> 5491 <code>secretKey</code></br> 5492 <em> 5493 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5494 Kubernetes core/v1.SecretKeySelector 5495 </a> 5496 </em> 5497 </td> 5498 <td> 5499 <p>SecretKey refers K8s secret containing aws secret key</p> 5500 </td> 5501 </tr> 5502 <tr> 5503 <td> 5504 <code>region</code></br> 5505 <em> 5506 string 5507 </em> 5508 </td> 5509 <td> 5510 <p>Region is AWS region</p> 5511 </td> 5512 </tr> 5513 <tr> 5514 <td> 5515 <code>roleARN</code></br> 5516 <em> 5517 string 5518 </em> 5519 </td> 5520 <td> 5521 <em>(Optional)</em> 5522 <p>RoleARN is the Amazon Resource Name (ARN) of the role to assume.</p> 5523 </td> 5524 </tr> 5525 <tr> 5526 <td> 5527 <code>metadata</code></br> 5528 <em> 5529 map[string]string 5530 </em> 5531 </td> 5532 <td> 5533 <em>(Optional)</em> 5534 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5535 </td> 5536 </tr> 5537 <tr> 5538 <td> 5539 <code>validateSignature</code></br> 5540 <em> 5541 bool 5542 </em> 5543 </td> 5544 <td> 5545 <em>(Optional)</em> 5546 <p>ValidateSignature is boolean that can be set to true for SNS signature verification</p> 5547 </td> 5548 </tr> 5549 <tr> 5550 <td> 5551 <code>filter</code></br> 5552 <em> 5553 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 5554 EventSourceFilter 5555 </a> 5556 </em> 5557 </td> 5558 <td> 5559 <em>(Optional)</em> 5560 <p>Filter</p> 5561 </td> 5562 </tr> 5563 <tr> 5564 <td> 5565 <code>endpoint</code></br> 5566 <em> 5567 string 5568 </em> 5569 </td> 5570 <td> 5571 <em>(Optional)</em> 5572 <p>Endpoint configures connection to a specific SNS endpoint instead of Amazons servers</p> 5573 </td> 5574 </tr> 5575 </tbody> 5576 </table> 5577 <h3 id="argoproj.io/v1alpha1.SQSEventSource">SQSEventSource 5578 </h3> 5579 <p> 5580 (<em>Appears on:</em> 5581 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5582 </p> 5583 <p> 5584 <p>SQSEventSource refers to event-source for AWS SQS related events</p> 5585 </p> 5586 <table> 5587 <thead> 5588 <tr> 5589 <th>Field</th> 5590 <th>Description</th> 5591 </tr> 5592 </thead> 5593 <tbody> 5594 <tr> 5595 <td> 5596 <code>accessKey</code></br> 5597 <em> 5598 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5599 Kubernetes core/v1.SecretKeySelector 5600 </a> 5601 </em> 5602 </td> 5603 <td> 5604 <p>AccessKey refers K8s secret containing aws access key</p> 5605 </td> 5606 </tr> 5607 <tr> 5608 <td> 5609 <code>secretKey</code></br> 5610 <em> 5611 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5612 Kubernetes core/v1.SecretKeySelector 5613 </a> 5614 </em> 5615 </td> 5616 <td> 5617 <p>SecretKey refers K8s secret containing aws secret key</p> 5618 </td> 5619 </tr> 5620 <tr> 5621 <td> 5622 <code>region</code></br> 5623 <em> 5624 string 5625 </em> 5626 </td> 5627 <td> 5628 <p>Region is AWS region</p> 5629 </td> 5630 </tr> 5631 <tr> 5632 <td> 5633 <code>queue</code></br> 5634 <em> 5635 string 5636 </em> 5637 </td> 5638 <td> 5639 <p>Queue is AWS SQS queue to listen to for messages</p> 5640 </td> 5641 </tr> 5642 <tr> 5643 <td> 5644 <code>waitTimeSeconds</code></br> 5645 <em> 5646 int64 5647 </em> 5648 </td> 5649 <td> 5650 <p>WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive 5651 in the queue before returning.</p> 5652 </td> 5653 </tr> 5654 <tr> 5655 <td> 5656 <code>roleARN</code></br> 5657 <em> 5658 string 5659 </em> 5660 </td> 5661 <td> 5662 <em>(Optional)</em> 5663 <p>RoleARN is the Amazon Resource Name (ARN) of the role to assume.</p> 5664 </td> 5665 </tr> 5666 <tr> 5667 <td> 5668 <code>jsonBody</code></br> 5669 <em> 5670 bool 5671 </em> 5672 </td> 5673 <td> 5674 <em>(Optional)</em> 5675 <p>JSONBody specifies that all event body payload coming from this 5676 source will be JSON</p> 5677 </td> 5678 </tr> 5679 <tr> 5680 <td> 5681 <code>queueAccountId</code></br> 5682 <em> 5683 string 5684 </em> 5685 </td> 5686 <td> 5687 <em>(Optional)</em> 5688 <p>QueueAccountID is the ID of the account that created the queue to monitor</p> 5689 </td> 5690 </tr> 5691 <tr> 5692 <td> 5693 <code>metadata</code></br> 5694 <em> 5695 map[string]string 5696 </em> 5697 </td> 5698 <td> 5699 <em>(Optional)</em> 5700 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5701 </td> 5702 </tr> 5703 <tr> 5704 <td> 5705 <code>dlq</code></br> 5706 <em> 5707 bool 5708 </em> 5709 </td> 5710 <td> 5711 <em>(Optional)</em> 5712 <p>DLQ specifies if a dead-letter queue is configured for messages that can’t be processed successfully. 5713 If set to true, messages with invalid payload won’t be acknowledged to allow to forward them farther to the dead-letter queue. 5714 The default value is false.</p> 5715 </td> 5716 </tr> 5717 <tr> 5718 <td> 5719 <code>filter</code></br> 5720 <em> 5721 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 5722 EventSourceFilter 5723 </a> 5724 </em> 5725 </td> 5726 <td> 5727 <em>(Optional)</em> 5728 <p>Filter</p> 5729 </td> 5730 </tr> 5731 <tr> 5732 <td> 5733 <code>endpoint</code></br> 5734 <em> 5735 string 5736 </em> 5737 </td> 5738 <td> 5739 <em>(Optional)</em> 5740 <p>Endpoint configures connection to a specific SQS endpoint instead of Amazons servers</p> 5741 </td> 5742 </tr> 5743 <tr> 5744 <td> 5745 <code>sessionToken</code></br> 5746 <em> 5747 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5748 Kubernetes core/v1.SecretKeySelector 5749 </a> 5750 </em> 5751 </td> 5752 <td> 5753 <em>(Optional)</em> 5754 <p>SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token</p> 5755 </td> 5756 </tr> 5757 </tbody> 5758 </table> 5759 <h3 id="argoproj.io/v1alpha1.Selector">Selector 5760 </h3> 5761 <p> 5762 (<em>Appears on:</em> 5763 <a href="#argoproj.io/v1alpha1.ResourceFilter">ResourceFilter</a>) 5764 </p> 5765 <p> 5766 <p>Selector represents conditional operation to select K8s objects.</p> 5767 </p> 5768 <table> 5769 <thead> 5770 <tr> 5771 <th>Field</th> 5772 <th>Description</th> 5773 </tr> 5774 </thead> 5775 <tbody> 5776 <tr> 5777 <td> 5778 <code>key</code></br> 5779 <em> 5780 string 5781 </em> 5782 </td> 5783 <td> 5784 <p>Key name</p> 5785 </td> 5786 </tr> 5787 <tr> 5788 <td> 5789 <code>operation</code></br> 5790 <em> 5791 string 5792 </em> 5793 </td> 5794 <td> 5795 <em>(Optional)</em> 5796 <p>Supported operations like ==, != etc. 5797 Defaults to ==. 5798 Refer <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors">https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors</a> for more info.</p> 5799 </td> 5800 </tr> 5801 <tr> 5802 <td> 5803 <code>value</code></br> 5804 <em> 5805 string 5806 </em> 5807 </td> 5808 <td> 5809 <p>Value</p> 5810 </td> 5811 </tr> 5812 </tbody> 5813 </table> 5814 <h3 id="argoproj.io/v1alpha1.Service">Service 5815 </h3> 5816 <p> 5817 (<em>Appears on:</em> 5818 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5819 </p> 5820 <p> 5821 <p>Service holds the service information eventsource exposes</p> 5822 </p> 5823 <table> 5824 <thead> 5825 <tr> 5826 <th>Field</th> 5827 <th>Description</th> 5828 </tr> 5829 </thead> 5830 <tbody> 5831 <tr> 5832 <td> 5833 <code>ports</code></br> 5834 <em> 5835 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#serviceport-v1-core"> 5836 []Kubernetes core/v1.ServicePort 5837 </a> 5838 </em> 5839 </td> 5840 <td> 5841 <p>The list of ports that are exposed by this ClusterIP service.</p> 5842 </td> 5843 </tr> 5844 <tr> 5845 <td> 5846 <code>clusterIP</code></br> 5847 <em> 5848 string 5849 </em> 5850 </td> 5851 <td> 5852 <em>(Optional)</em> 5853 <p>clusterIP is the IP address of the service and is usually assigned 5854 randomly by the master. If an address is specified manually and is not in 5855 use by others, it will be allocated to the service; otherwise, creation 5856 of the service will fail. This field can not be changed through updates. 5857 Valid values are “None”, empty string (“”), or a valid IP address. “None” 5858 can be specified for headless services when proxying is not required. 5859 More info: <a href="https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies">https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies</a></p> 5860 </td> 5861 </tr> 5862 </tbody> 5863 </table> 5864 <h3 id="argoproj.io/v1alpha1.SlackEventSource">SlackEventSource 5865 </h3> 5866 <p> 5867 (<em>Appears on:</em> 5868 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5869 </p> 5870 <p> 5871 <p>SlackEventSource refers to event-source for Slack related events</p> 5872 </p> 5873 <table> 5874 <thead> 5875 <tr> 5876 <th>Field</th> 5877 <th>Description</th> 5878 </tr> 5879 </thead> 5880 <tbody> 5881 <tr> 5882 <td> 5883 <code>signingSecret</code></br> 5884 <em> 5885 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5886 Kubernetes core/v1.SecretKeySelector 5887 </a> 5888 </em> 5889 </td> 5890 <td> 5891 <p>Slack App signing secret</p> 5892 </td> 5893 </tr> 5894 <tr> 5895 <td> 5896 <code>token</code></br> 5897 <em> 5898 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 5899 Kubernetes core/v1.SecretKeySelector 5900 </a> 5901 </em> 5902 </td> 5903 <td> 5904 <p>Token for URL verification handshake</p> 5905 </td> 5906 </tr> 5907 <tr> 5908 <td> 5909 <code>webhook</code></br> 5910 <em> 5911 <a href="#argoproj.io/v1alpha1.WebhookContext"> 5912 WebhookContext 5913 </a> 5914 </em> 5915 </td> 5916 <td> 5917 <p>Webhook holds configuration for a REST endpoint</p> 5918 </td> 5919 </tr> 5920 <tr> 5921 <td> 5922 <code>metadata</code></br> 5923 <em> 5924 map[string]string 5925 </em> 5926 </td> 5927 <td> 5928 <em>(Optional)</em> 5929 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 5930 </td> 5931 </tr> 5932 <tr> 5933 <td> 5934 <code>filter</code></br> 5935 <em> 5936 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 5937 EventSourceFilter 5938 </a> 5939 </em> 5940 </td> 5941 <td> 5942 <em>(Optional)</em> 5943 <p>Filter</p> 5944 </td> 5945 </tr> 5946 </tbody> 5947 </table> 5948 <h3 id="argoproj.io/v1alpha1.StorageGridEventSource">StorageGridEventSource 5949 </h3> 5950 <p> 5951 (<em>Appears on:</em> 5952 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 5953 </p> 5954 <p> 5955 <p>StorageGridEventSource refers to event-source for StorageGrid related events</p> 5956 </p> 5957 <table> 5958 <thead> 5959 <tr> 5960 <th>Field</th> 5961 <th>Description</th> 5962 </tr> 5963 </thead> 5964 <tbody> 5965 <tr> 5966 <td> 5967 <code>webhook</code></br> 5968 <em> 5969 <a href="#argoproj.io/v1alpha1.WebhookContext"> 5970 WebhookContext 5971 </a> 5972 </em> 5973 </td> 5974 <td> 5975 <p>Webhook holds configuration for a REST endpoint</p> 5976 </td> 5977 </tr> 5978 <tr> 5979 <td> 5980 <code>events</code></br> 5981 <em> 5982 []string 5983 </em> 5984 </td> 5985 <td> 5986 </td> 5987 </tr> 5988 <tr> 5989 <td> 5990 <code>filter</code></br> 5991 <em> 5992 <a href="#argoproj.io/v1alpha1.StorageGridFilter"> 5993 StorageGridFilter 5994 </a> 5995 </em> 5996 </td> 5997 <td> 5998 <p>Filter on object key which caused the notification.</p> 5999 </td> 6000 </tr> 6001 <tr> 6002 <td> 6003 <code>topicArn</code></br> 6004 <em> 6005 string 6006 </em> 6007 </td> 6008 <td> 6009 <p>TopicArn</p> 6010 </td> 6011 </tr> 6012 <tr> 6013 <td> 6014 <code>bucket</code></br> 6015 <em> 6016 string 6017 </em> 6018 </td> 6019 <td> 6020 <p>Name of the bucket to register notifications for.</p> 6021 </td> 6022 </tr> 6023 <tr> 6024 <td> 6025 <code>region</code></br> 6026 <em> 6027 string 6028 </em> 6029 </td> 6030 <td> 6031 <em>(Optional)</em> 6032 <p>S3 region. 6033 Defaults to us-east-1</p> 6034 </td> 6035 </tr> 6036 <tr> 6037 <td> 6038 <code>authToken</code></br> 6039 <em> 6040 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6041 Kubernetes core/v1.SecretKeySelector 6042 </a> 6043 </em> 6044 </td> 6045 <td> 6046 <p>Auth token for storagegrid api</p> 6047 </td> 6048 </tr> 6049 <tr> 6050 <td> 6051 <code>apiURL</code></br> 6052 <em> 6053 string 6054 </em> 6055 </td> 6056 <td> 6057 <p>APIURL is the url of the storagegrid api.</p> 6058 </td> 6059 </tr> 6060 <tr> 6061 <td> 6062 <code>metadata</code></br> 6063 <em> 6064 map[string]string 6065 </em> 6066 </td> 6067 <td> 6068 <em>(Optional)</em> 6069 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 6070 </td> 6071 </tr> 6072 </tbody> 6073 </table> 6074 <h3 id="argoproj.io/v1alpha1.StorageGridFilter">StorageGridFilter 6075 </h3> 6076 <p> 6077 (<em>Appears on:</em> 6078 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">StorageGridEventSource</a>) 6079 </p> 6080 <p> 6081 <p>StorageGridFilter represents filters to apply to bucket notifications for specifying constraints on objects</p> 6082 </p> 6083 <table> 6084 <thead> 6085 <tr> 6086 <th>Field</th> 6087 <th>Description</th> 6088 </tr> 6089 </thead> 6090 <tbody> 6091 <tr> 6092 <td> 6093 <code>prefix</code></br> 6094 <em> 6095 string 6096 </em> 6097 </td> 6098 <td> 6099 </td> 6100 </tr> 6101 <tr> 6102 <td> 6103 <code>suffix</code></br> 6104 <em> 6105 string 6106 </em> 6107 </td> 6108 <td> 6109 </td> 6110 </tr> 6111 </tbody> 6112 </table> 6113 <h3 id="argoproj.io/v1alpha1.StripeEventSource">StripeEventSource 6114 </h3> 6115 <p> 6116 (<em>Appears on:</em> 6117 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6118 </p> 6119 <p> 6120 <p>StripeEventSource describes the event source for stripe webhook notifications 6121 More info at <a href="https://stripe.com/docs/webhooks">https://stripe.com/docs/webhooks</a></p> 6122 </p> 6123 <table> 6124 <thead> 6125 <tr> 6126 <th>Field</th> 6127 <th>Description</th> 6128 </tr> 6129 </thead> 6130 <tbody> 6131 <tr> 6132 <td> 6133 <code>webhook</code></br> 6134 <em> 6135 <a href="#argoproj.io/v1alpha1.WebhookContext"> 6136 WebhookContext 6137 </a> 6138 </em> 6139 </td> 6140 <td> 6141 <p>Webhook holds configuration for a REST endpoint</p> 6142 </td> 6143 </tr> 6144 <tr> 6145 <td> 6146 <code>createWebhook</code></br> 6147 <em> 6148 bool 6149 </em> 6150 </td> 6151 <td> 6152 <em>(Optional)</em> 6153 <p>CreateWebhook if specified creates a new webhook programmatically.</p> 6154 </td> 6155 </tr> 6156 <tr> 6157 <td> 6158 <code>apiKey</code></br> 6159 <em> 6160 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6161 Kubernetes core/v1.SecretKeySelector 6162 </a> 6163 </em> 6164 </td> 6165 <td> 6166 <em>(Optional)</em> 6167 <p>APIKey refers to K8s secret that holds Stripe API key. Used only if CreateWebhook is enabled.</p> 6168 </td> 6169 </tr> 6170 <tr> 6171 <td> 6172 <code>eventFilter</code></br> 6173 <em> 6174 []string 6175 </em> 6176 </td> 6177 <td> 6178 <em>(Optional)</em> 6179 <p>EventFilter describes the type of events to listen to. If not specified, all types of events will be processed. 6180 More info at <a href="https://stripe.com/docs/api/events/list">https://stripe.com/docs/api/events/list</a></p> 6181 </td> 6182 </tr> 6183 <tr> 6184 <td> 6185 <code>metadata</code></br> 6186 <em> 6187 map[string]string 6188 </em> 6189 </td> 6190 <td> 6191 <em>(Optional)</em> 6192 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 6193 </td> 6194 </tr> 6195 </tbody> 6196 </table> 6197 <h3 id="argoproj.io/v1alpha1.Template">Template 6198 </h3> 6199 <p> 6200 (<em>Appears on:</em> 6201 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6202 </p> 6203 <p> 6204 <p>Template holds the information of an EventSource deployment template</p> 6205 </p> 6206 <table> 6207 <thead> 6208 <tr> 6209 <th>Field</th> 6210 <th>Description</th> 6211 </tr> 6212 </thead> 6213 <tbody> 6214 <tr> 6215 <td> 6216 <code>metadata</code></br> 6217 <em> 6218 github.com/argoproj/argo-events/pkg/apis/common.Metadata 6219 </em> 6220 </td> 6221 <td> 6222 <p>Metadata sets the pods’s metadata, i.e. annotations and labels</p> 6223 </td> 6224 </tr> 6225 <tr> 6226 <td> 6227 <code>serviceAccountName</code></br> 6228 <em> 6229 string 6230 </em> 6231 </td> 6232 <td> 6233 <em>(Optional)</em> 6234 <p>ServiceAccountName is the name of the ServiceAccount to use to run event source pod. 6235 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> 6236 </td> 6237 </tr> 6238 <tr> 6239 <td> 6240 <code>container</code></br> 6241 <em> 6242 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core"> 6243 Kubernetes core/v1.Container 6244 </a> 6245 </em> 6246 </td> 6247 <td> 6248 <em>(Optional)</em> 6249 <p>Container is the main container image to run in the event source pod</p> 6250 </td> 6251 </tr> 6252 <tr> 6253 <td> 6254 <code>volumes</code></br> 6255 <em> 6256 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#volume-v1-core"> 6257 []Kubernetes core/v1.Volume 6258 </a> 6259 </em> 6260 </td> 6261 <td> 6262 <em>(Optional)</em> 6263 <p>Volumes is a list of volumes that can be mounted by containers in an eventsource.</p> 6264 </td> 6265 </tr> 6266 <tr> 6267 <td> 6268 <code>securityContext</code></br> 6269 <em> 6270 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#podsecuritycontext-v1-core"> 6271 Kubernetes core/v1.PodSecurityContext 6272 </a> 6273 </em> 6274 </td> 6275 <td> 6276 <em>(Optional)</em> 6277 <p>SecurityContext holds pod-level security attributes and common container settings. 6278 Optional: Defaults to empty. See type description for default values of each field.</p> 6279 </td> 6280 </tr> 6281 <tr> 6282 <td> 6283 <code>affinity</code></br> 6284 <em> 6285 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#affinity-v1-core"> 6286 Kubernetes core/v1.Affinity 6287 </a> 6288 </em> 6289 </td> 6290 <td> 6291 <em>(Optional)</em> 6292 <p>If specified, the pod’s scheduling constraints</p> 6293 </td> 6294 </tr> 6295 <tr> 6296 <td> 6297 <code>tolerations</code></br> 6298 <em> 6299 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#toleration-v1-core"> 6300 []Kubernetes core/v1.Toleration 6301 </a> 6302 </em> 6303 </td> 6304 <td> 6305 <em>(Optional)</em> 6306 <p>If specified, the pod’s tolerations.</p> 6307 </td> 6308 </tr> 6309 <tr> 6310 <td> 6311 <code>nodeSelector</code></br> 6312 <em> 6313 map[string]string 6314 </em> 6315 </td> 6316 <td> 6317 <em>(Optional)</em> 6318 <p>NodeSelector is a selector which must be true for the pod to fit on a node. 6319 Selector which must match a node’s labels for the pod to be scheduled on that node. 6320 More info: <a href="https://kubernetes.io/docs/concepts/configuration/assign-pod-node/">https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</a></p> 6321 </td> 6322 </tr> 6323 <tr> 6324 <td> 6325 <code>imagePullSecrets</code></br> 6326 <em> 6327 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#localobjectreference-v1-core"> 6328 []Kubernetes core/v1.LocalObjectReference 6329 </a> 6330 </em> 6331 </td> 6332 <td> 6333 <em>(Optional)</em> 6334 <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. 6335 If specified, these secrets will be passed to individual puller implementations for them to use. For example, 6336 in the case of docker, only DockerConfig type secrets are honored. 6337 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> 6338 </td> 6339 </tr> 6340 <tr> 6341 <td> 6342 <code>priorityClassName</code></br> 6343 <em> 6344 string 6345 </em> 6346 </td> 6347 <td> 6348 <em>(Optional)</em> 6349 <p>If specified, indicates the EventSource pod’s priority. “system-node-critical” 6350 and “system-cluster-critical” are two special keywords which indicate the 6351 highest priorities with the former being the highest priority. Any other 6352 name must be defined by creating a PriorityClass object with that name. 6353 If not specified, the pod priority will be default or zero if there is no 6354 default. 6355 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 6356 </td> 6357 </tr> 6358 <tr> 6359 <td> 6360 <code>priority</code></br> 6361 <em> 6362 int32 6363 </em> 6364 </td> 6365 <td> 6366 <em>(Optional)</em> 6367 <p>The priority value. Various system components use this field to find the 6368 priority of the EventSource pod. When Priority Admission Controller is enabled, 6369 it prevents users from setting this field. The admission controller populates 6370 this field from PriorityClassName. 6371 The higher the value, the higher the priority. 6372 More info: <a href="https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/">https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/</a></p> 6373 </td> 6374 </tr> 6375 </tbody> 6376 </table> 6377 <h3 id="argoproj.io/v1alpha1.WatchPathConfig">WatchPathConfig 6378 </h3> 6379 <p> 6380 (<em>Appears on:</em> 6381 <a href="#argoproj.io/v1alpha1.FileEventSource">FileEventSource</a>, 6382 <a href="#argoproj.io/v1alpha1.HDFSEventSource">HDFSEventSource</a>, 6383 <a href="#argoproj.io/v1alpha1.SFTPEventSource">SFTPEventSource</a>) 6384 </p> 6385 <p> 6386 </p> 6387 <table> 6388 <thead> 6389 <tr> 6390 <th>Field</th> 6391 <th>Description</th> 6392 </tr> 6393 </thead> 6394 <tbody> 6395 <tr> 6396 <td> 6397 <code>directory</code></br> 6398 <em> 6399 string 6400 </em> 6401 </td> 6402 <td> 6403 <p>Directory to watch for events</p> 6404 </td> 6405 </tr> 6406 <tr> 6407 <td> 6408 <code>path</code></br> 6409 <em> 6410 string 6411 </em> 6412 </td> 6413 <td> 6414 <p>Path is relative path of object to watch with respect to the directory</p> 6415 </td> 6416 </tr> 6417 <tr> 6418 <td> 6419 <code>pathRegexp</code></br> 6420 <em> 6421 string 6422 </em> 6423 </td> 6424 <td> 6425 <p>PathRegexp is regexp of relative path of object to watch with respect to the directory</p> 6426 </td> 6427 </tr> 6428 </tbody> 6429 </table> 6430 <h3 id="argoproj.io/v1alpha1.WebhookContext">WebhookContext 6431 </h3> 6432 <p> 6433 (<em>Appears on:</em> 6434 <a href="#argoproj.io/v1alpha1.BitbucketEventSource">BitbucketEventSource</a>, 6435 <a href="#argoproj.io/v1alpha1.BitbucketServerEventSource">BitbucketServerEventSource</a>, 6436 <a href="#argoproj.io/v1alpha1.GerritEventSource">GerritEventSource</a>, 6437 <a href="#argoproj.io/v1alpha1.GithubEventSource">GithubEventSource</a>, 6438 <a href="#argoproj.io/v1alpha1.GitlabEventSource">GitlabEventSource</a>, 6439 <a href="#argoproj.io/v1alpha1.SNSEventSource">SNSEventSource</a>, 6440 <a href="#argoproj.io/v1alpha1.SlackEventSource">SlackEventSource</a>, 6441 <a href="#argoproj.io/v1alpha1.StorageGridEventSource">StorageGridEventSource</a>, 6442 <a href="#argoproj.io/v1alpha1.StripeEventSource">StripeEventSource</a>, 6443 <a href="#argoproj.io/v1alpha1.WebhookEventSource">WebhookEventSource</a>) 6444 </p> 6445 <p> 6446 <p>WebhookContext holds a general purpose REST API context</p> 6447 </p> 6448 <table> 6449 <thead> 6450 <tr> 6451 <th>Field</th> 6452 <th>Description</th> 6453 </tr> 6454 </thead> 6455 <tbody> 6456 <tr> 6457 <td> 6458 <code>endpoint</code></br> 6459 <em> 6460 string 6461 </em> 6462 </td> 6463 <td> 6464 <p>REST API endpoint</p> 6465 </td> 6466 </tr> 6467 <tr> 6468 <td> 6469 <code>method</code></br> 6470 <em> 6471 string 6472 </em> 6473 </td> 6474 <td> 6475 <p>Method is HTTP request method that indicates the desired action to be performed for a given resource. 6476 See RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</p> 6477 </td> 6478 </tr> 6479 <tr> 6480 <td> 6481 <code>port</code></br> 6482 <em> 6483 string 6484 </em> 6485 </td> 6486 <td> 6487 <p>Port on which HTTP server is listening for incoming events.</p> 6488 </td> 6489 </tr> 6490 <tr> 6491 <td> 6492 <code>url</code></br> 6493 <em> 6494 string 6495 </em> 6496 </td> 6497 <td> 6498 <p>URL is the url of the server.</p> 6499 </td> 6500 </tr> 6501 <tr> 6502 <td> 6503 <code>serverCertSecret</code></br> 6504 <em> 6505 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6506 Kubernetes core/v1.SecretKeySelector 6507 </a> 6508 </em> 6509 </td> 6510 <td> 6511 <p>ServerCertPath refers the file that contains the cert.</p> 6512 </td> 6513 </tr> 6514 <tr> 6515 <td> 6516 <code>serverKeySecret</code></br> 6517 <em> 6518 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6519 Kubernetes core/v1.SecretKeySelector 6520 </a> 6521 </em> 6522 </td> 6523 <td> 6524 <p>ServerKeyPath refers the file that contains private key</p> 6525 </td> 6526 </tr> 6527 <tr> 6528 <td> 6529 <code>metadata</code></br> 6530 <em> 6531 map[string]string 6532 </em> 6533 </td> 6534 <td> 6535 <em>(Optional)</em> 6536 <p>Metadata holds the user defined metadata which will passed along the event payload.</p> 6537 </td> 6538 </tr> 6539 <tr> 6540 <td> 6541 <code>authSecret</code></br> 6542 <em> 6543 <a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secretkeyselector-v1-core"> 6544 Kubernetes core/v1.SecretKeySelector 6545 </a> 6546 </em> 6547 </td> 6548 <td> 6549 <em>(Optional)</em> 6550 <p>AuthSecret holds a secret selector that contains a bearer token for authentication</p> 6551 </td> 6552 </tr> 6553 <tr> 6554 <td> 6555 <code>maxPayloadSize</code></br> 6556 <em> 6557 int64 6558 </em> 6559 </td> 6560 <td> 6561 <em>(Optional)</em> 6562 <p>MaxPayloadSize is the maximum webhook payload size that the server will accept. 6563 Requests exceeding that limit will be rejected with “request too large” response. 6564 Default value: 1048576 (1MB).</p> 6565 </td> 6566 </tr> 6567 </tbody> 6568 </table> 6569 <h3 id="argoproj.io/v1alpha1.WebhookEventSource">WebhookEventSource 6570 </h3> 6571 <p> 6572 (<em>Appears on:</em> 6573 <a href="#argoproj.io/v1alpha1.EventSourceSpec">EventSourceSpec</a>) 6574 </p> 6575 <p> 6576 <p>CalendarEventSource describes an HTTP based EventSource</p> 6577 </p> 6578 <table> 6579 <thead> 6580 <tr> 6581 <th>Field</th> 6582 <th>Description</th> 6583 </tr> 6584 </thead> 6585 <tbody> 6586 <tr> 6587 <td> 6588 <code>WebhookContext</code></br> 6589 <em> 6590 <a href="#argoproj.io/v1alpha1.WebhookContext"> 6591 WebhookContext 6592 </a> 6593 </em> 6594 </td> 6595 <td> 6596 <p> 6597 (Members of <code>WebhookContext</code> are embedded into this type.) 6598 </p> 6599 </td> 6600 </tr> 6601 <tr> 6602 <td> 6603 <code>filter</code></br> 6604 <em> 6605 <a href="#argoproj.io/v1alpha1.EventSourceFilter"> 6606 EventSourceFilter 6607 </a> 6608 </em> 6609 </td> 6610 <td> 6611 <em>(Optional)</em> 6612 <p>Filter</p> 6613 </td> 6614 </tr> 6615 </tbody> 6616 </table> 6617 <hr/> 6618 <p><em> 6619 Generated with <code>gen-crd-api-reference-docs</code>. 6620 </em></p>