APIs

Packages:

• argoproj.io/v1alpha1

argoproj.io/v1alpha1

Resource Types:

AMQPConsumeConfig

(Appears on: AMQPEventSource)

AMQPConsumeConfig holds the configuration to immediately starts delivering queued messages

Field	Description
consumerTag string	(Optional) ConsumerTag is the identity of the consumer included in every delivery
autoAck bool	(Optional) AutoAck when true, the server will acknowledge deliveries to this consumer prior to writing the delivery to the network
exclusive bool	(Optional) Exclusive when true, the server will ensure that this is the sole consumer from this queue
noLocal bool	(Optional) NoLocal flag is not supported by RabbitMQ
noWait bool	(Optional) NowWait when true, do not wait for the server to confirm the request and immediately begin deliveries

AMQPEventSource

(Appears on: EventSourceSpec)

AMQPEventSource refers to an event-source for AMQP stream events

Field	Description
url string	URL for rabbitmq service
exchangeName string	ExchangeName is the exchange name For more information, visit https://www.rabbitmq.com/tutorials/amqp-concepts.html
exchangeType string	ExchangeType is rabbitmq exchange type
routingKey string	Routing key for bindings
connectionBackoff Backoff	(Optional) Backoff holds parameters applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
tls TLSConfig	(Optional) TLS configuration for the amqp client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
exchangeDeclare AMQPExchangeDeclareConfig	(Optional) ExchangeDeclare holds the configuration for the exchange on the server For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare
queueDeclare AMQPQueueDeclareConfig	(Optional) QueueDeclare holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches the same parameters For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare
queueBind AMQPQueueBindConfig	(Optional) QueueBind holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind
consume AMQPConsumeConfig	(Optional) Consume holds the configuration to immediately starts delivering queued messages For more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume
auth BasicAuth	(Optional) Auth hosts secret selectors for username and password
urlSecret Kubernetes core/v1.SecretKeySelector	URLSecret is secret reference for rabbitmq service URL
filter EventSourceFilter	(Optional) Filter

AMQPExchangeDeclareConfig

(Appears on: AMQPEventSource)

AMQPExchangeDeclareConfig holds the configuration for the exchange on the server

Field	Description
durable bool	(Optional) Durable keeps the exchange also after the server restarts
autoDelete bool	(Optional) AutoDelete removes the exchange when no bindings are active
internal bool	(Optional) Internal when true does not accept publishings
noWait bool	(Optional) NowWait when true does not wait for a confirmation from the server

AMQPQueueBindConfig

(Appears on: AMQPEventSource)

AMQPQueueBindConfig holds the configuration that binds an exchange to a queue so that publishings to the exchange will be routed to the queue when the publishing routing key matches the binding routing key

Field	Description
noWait bool	(Optional) NowWait false and the queue could not be bound, the channel will be closed with an error

AMQPQueueDeclareConfig

(Appears on: AMQPEventSource)

AMQPQueueDeclareConfig holds the configuration of a queue to hold messages and deliver to consumers. Declaring creates a queue if it doesn’t already exist, or ensures that an existing queue matches the same parameters

Field	Description
name string	(Optional) Name of the queue. If empty the server auto-generates a unique name for this queue
durable bool	(Optional) Durable keeps the queue also after the server restarts
autoDelete bool	(Optional) AutoDelete removes the queue when no consumers are active
exclusive bool	(Optional) Exclusive sets the queues to be accessible only by the connection that declares them and will be deleted wgen the connection closes
noWait bool	(Optional) NowWait when true, the queue assumes to be declared on the server
arguments string	(Optional) Arguments of a queue (also known as “x-arguments”) used for optional features and plugins

AWSLambdaTrigger

(Appears on: TriggerTemplate)

AWSLambdaTrigger refers to specification of the trigger to invoke an AWS Lambda function

Field	Description
functionName string	FunctionName refers to the name of the function to invoke.
accessKey Kubernetes core/v1.SecretKeySelector	(Optional) AccessKey refers K8s secret containing aws access key
secretKey Kubernetes core/v1.SecretKeySelector	(Optional) SecretKey refers K8s secret containing aws secret key
region string	Region is AWS region
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.
invocationType string	(Optional) Choose from the following options. RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data. Event - Invoke the function asynchronously. Send events that fail multiple times to the function’s dead-letter queue (if it’s configured). The API response only includes a status code. DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.
roleARN string	(Optional) RoleARN is the Amazon Resource Name (ARN) of the role to assume.

Amount

(Appears on: Backoff)

Amount represent a numeric amount.

Field	Description
value \[\]byte

ArgoWorkflowOperation (string alias)

(Appears on: ArgoWorkflowTrigger)

ArgoWorkflowOperation refers to the type of the operation performed on the Argo Workflow

ArgoWorkflowTrigger

(Appears on: TriggerTemplate)

ArgoWorkflowTrigger is the trigger for the Argo Workflow

Field	Description
source ArtifactLocation	Source of the K8s resource file(s)
operation ArgoWorkflowOperation	(Optional) Operation refers to the type of operation performed on the argo workflow resource. Default value is Submit.
parameters \[\]TriggerParameter	Parameters is the list of parameters to pass to resolved Argo Workflow object
args \[\]string	Args is the list of arguments to pass to the argo CLI

ArtifactLocation

(Appears on: ArgoWorkflowTrigger, StandardK8STrigger)

ArtifactLocation describes the source location for an external artifact

Field	Description
s3 S3Artifact	S3 compliant artifact
inline string	Inline artifact is embedded in sensor spec as a string
file FileArtifact	File artifact is artifact stored in a file
url URLArtifact	URL to fetch the artifact from
configmap Kubernetes core/v1.ConfigMapKeySelector	Configmap that stores the artifact
git GitArtifact	Git repository hosting the artifact
resource K8SResource	Resource is generic template for K8s resource

AuthStrategy (string alias)

(Appears on: NATSConfig, NativeStrategy)

AuthStrategy is the auth strategy of native nats installaion

AzureEventHubsTrigger

(Appears on: TriggerTemplate)

AzureEventHubsTrigger refers to specification of the Azure Event Hubs Trigger

Field	Description
fqdn string	FQDN refers to the namespace dns of Azure Event Hubs to be used i.e. .servicebus.windows.net
hubName string	HubName refers to the Azure Event Hub to send events to
sharedAccessKeyName Kubernetes core/v1.SecretKeySelector	SharedAccessKeyName refers to the name of the Shared Access Key
sharedAccessKey Kubernetes core/v1.SecretKeySelector	SharedAccessKey refers to a K8s secret containing the primary key for the
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.

AzureEventsHubEventSource

(Appears on: EventSourceSpec)

AzureEventsHubEventSource describes the event source for azure events hub More info at https://docs.microsoft.com/en-us/azure/event-hubs/

Field	Description
fqdn string	FQDN of the EventHubs namespace you created More info at https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string
sharedAccessKeyName Kubernetes core/v1.SecretKeySelector	SharedAccessKeyName is the name you chose for your application’s SAS keys
sharedAccessKey Kubernetes core/v1.SecretKeySelector	SharedAccessKey is the generated value of the key
hubName string	Event Hub path/name
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

AzureQueueStorageEventSource

(Appears on: EventSourceSpec)

AzureQueueStorageEventSource describes the event source for azure queue storage more info at https://learn.microsoft.com/en-us/azure/storage/queues/

Field	Description
storageAccountName string	(Optional) StorageAccountName is the name of the storage account where the queue is. This field is necessary to access via Azure AD (managed identity) and it is ignored if ConnectionString is set.
connectionString Kubernetes core/v1.SecretKeySelector	(Optional) ConnectionString is the connection string to access Azure Queue Storage. If this fields is not provided it will try to access via Azure AD with StorageAccountName.
queueName string	QueueName is the name of the queue
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
dlq bool	(Optional) DLQ specifies if a dead-letter queue is configured for messages that can’t be processed successfully. If set to true, messages with invalid payload won’t be acknowledged to allow to forward them farther to the dead-letter queue. The default value is false.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
decodeMessage bool	(Optional) DecodeMessage specifies if all the messages should be base64 decoded. If set to true the decoding is done before the evaluation of JSONBody
waitTimeInSeconds int32	(Optional) WaitTimeInSeconds is the duration (in seconds) for which the event source waits between empty results from the queue. The default value is 3 seconds.

AzureServiceBusEventSource

(Appears on: EventSourceSpec)

AzureServiceBusEventSource describes the event source for azure service bus More info at https://docs.microsoft.com/en-us/azure/service-bus-messaging/

Field	Description
connectionString Kubernetes core/v1.SecretKeySelector	(Optional) ConnectionString is the connection string for the Azure Service Bus. If this fields is not provided it will try to access via Azure AD with DefaultAzureCredential and FullyQualifiedNamespace.
queueName string	QueueName is the name of the Azure Service Bus Queue
topicName string	TopicName is the name of the Azure Service Bus Topic
subscriptionName string	SubscriptionName is the name of the Azure Service Bus Topic Subscription
tls TLSConfig	(Optional) TLS configuration for the service bus client
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
fullyQualifiedNamespace string	(Optional) FullyQualifiedNamespace is the Service Bus namespace name (ex: myservicebus.servicebus.windows.net). This field is necessary to access via Azure AD (managed identity) and it is ignored if ConnectionString is set.

AzureServiceBusTrigger

(Appears on: TriggerTemplate)

Field	Description
connectionString Kubernetes core/v1.SecretKeySelector	ConnectionString is the connection string for the Azure Service Bus
queueName string	QueueName is the name of the Azure Service Bus Queue
topicName string	TopicName is the name of the Azure Service Bus Topic
subscriptionName string	SubscriptionName is the name of the Azure Service Bus Topic Subscription
tls TLSConfig	(Optional) TLS configuration for the service bus client
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.

Backoff

(Appears on: AMQPEventSource, EmitterEventSource, K8SResourcePolicy, KafkaEventSource, MQTTEventSource, NATSEventsSource, NSQEventSource, PulsarEventSource, PulsarTrigger, Trigger)

Backoff for an operation

Field	Description
duration Int64OrString	(Optional) The initial duration in nanoseconds or strings like “1s”, “3m”
factor Amount	(Optional) Duration is multiplied by factor each iteration
jitter Amount	(Optional) The amount of jitter applied each iteration
steps int32	(Optional) Exit with error after this many steps

BasicAuth

(Appears on: AMQPEventSource, GerritEventSource, HTTPTrigger, MQTTEventSource, NATSAuth, SchemaRegistryConfig)

BasicAuth contains the reference to K8s secrets that holds the username and password

Field	Description
username Kubernetes core/v1.SecretKeySelector	Username refers to the Kubernetes secret that holds the username required for basic auth.
password Kubernetes core/v1.SecretKeySelector	Password refers to the Kubernetes secret that holds the password required for basic auth.

BitbucketAuth

(Appears on: BitbucketEventSource)

BitbucketAuth holds the different auth strategies for connecting to Bitbucket

Field	Description
basic BitbucketBasicAuth	(Optional) Basic is BasicAuth auth strategy.
oauthToken Kubernetes core/v1.SecretKeySelector	(Optional) OAuthToken refers to the K8s secret that holds the OAuth Bearer token.

BitbucketBasicAuth

(Appears on: BitbucketAuth)

BitbucketBasicAuth holds the information required to authenticate user via basic auth mechanism

Field	Description
username Kubernetes core/v1.SecretKeySelector	Username refers to the K8s secret that holds the username.
password Kubernetes core/v1.SecretKeySelector	Password refers to the K8s secret that holds the password.

BitbucketEventSource

(Appears on: EventSourceSpec)

BitbucketEventSource describes the event source for Bitbucket

Field	Description
deleteHookOnFinish bool	(Optional) DeleteHookOnFinish determines whether to delete the defined Bitbucket hook once the event source is stopped.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will be passed along the event payload.
webhook WebhookContext	Webhook refers to the configuration required to run an http server
auth BitbucketAuth	Auth information required to connect to Bitbucket.
events \[\]string	Events this webhook is subscribed to.
owner string	(Optional) DeprecatedOwner is the owner of the repository. Deprecated: use Repositories instead. Will be unsupported in v1.9
projectKey string	(Optional) DeprecatedProjectKey is the key of the project to which the repository relates Deprecated: use Repositories instead. Will be unsupported in v1.9
repositorySlug string	(Optional) DeprecatedRepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL Deprecated: use Repositories instead. Will be unsupported in v1.9
repositories \[\]BitbucketRepository	(Optional) Repositories holds a list of repositories for which integration needs to set up
filter EventSourceFilter	(Optional) Filter

BitbucketRepository

(Appears on: BitbucketEventSource)

Field	Description
owner string	Owner is the owner of the repository
repositorySlug string	RepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL

BitbucketServerEventSource

(Appears on: EventSourceSpec)

BitbucketServerEventSource refers to event-source related to Bitbucket Server events

Field	Description
webhook WebhookContext	Webhook holds configuration to run a http server.
projectKey string	(Optional) DeprecatedProjectKey is the key of project for which integration needs to set up. Deprecated: use Repositories instead. Will be unsupported in v1.8.
repositorySlug string	(Optional) DeprecatedRepositorySlug is the slug of the repository for which integration needs to set up. Deprecated: use Repositories instead. Will be unsupported in v1.8.
projects \[\]string	(Optional) Projects holds a list of projects for which integration needs to set up, this will add the webhook to all repositories in the project.
repositories \[\]BitbucketServerRepository	(Optional) Repositories holds a list of repositories for which integration needs to set up.
events \[\]string	(Optional) Events are bitbucket event to listen to. Refer https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html
skipBranchRefsChangedOnOpenPR bool	(Optional) SkipBranchRefsChangedOnOpenPR bypasses the event repo:refs_changed for branches whenever there’s an associated open pull request. This helps in optimizing the event handling process by avoiding unnecessary triggers for branch reference changes that are already part of a pull request under review.
oneEventPerChange bool	(Optional) OneEventPerChange controls whether to process each change in a repo:refs_changed webhook event as a separate event. This setting is useful when multiple tags are pushed simultaneously for the same commit, and each tag needs to independently trigger an action, such as a distinct workflow in Argo Workflows. When enabled, the BitbucketServerEventSource publishes an individual BitbucketServerEventData for each change, ensuring independent processing of each tag or reference update in a single webhook event.
accessToken Kubernetes core/v1.SecretKeySelector	(Optional) AccessToken is reference to K8s secret which holds the bitbucket api access information.
webhookSecret Kubernetes core/v1.SecretKeySelector	(Optional) WebhookSecret is reference to K8s secret which holds the bitbucket webhook secret (for HMAC validation).
bitbucketserverBaseURL string	BitbucketServerBaseURL is the base URL for API requests to a custom endpoint.
deleteHookOnFinish bool	(Optional) DeleteHookOnFinish determines whether to delete the Bitbucket Server hook for the project once the event source is stopped.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
tls TLSConfig	(Optional) TLS configuration for the bitbucketserver client.
checkInterval string	(Optional) CheckInterval is a duration in which to wait before checking that the webhooks exist, e.g. 1s, 30m, 2h… (defaults to 1m)

BitbucketServerRepository

(Appears on: BitbucketServerEventSource)

Field	Description
projectKey string	ProjectKey is the key of project for which integration needs to set up.
repositorySlug string	RepositorySlug is the slug of the repository for which integration needs to set up.

BusConfig

(Appears on: EventBusStatus)

BusConfig has the finalized configuration for EventBus

Field	Description
nats NATSConfig	(Optional)
jetstream JetStreamConfig	(Optional)
kafka KafkaBus	(Optional)

CalendarEventSource

(Appears on: EventSourceSpec)

CalendarEventSource describes a time based dependency. One of the fields (schedule, interval, or recurrence) must be passed. Schedule takes precedence over interval; interval takes precedence over recurrence

Field	Description
schedule string	(Optional) Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron
interval string	(Optional) Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h…
exclusionDates \[\]string	ExclusionDates defines the list of DATE-TIME exceptions for recurring events.
timezone string	(Optional) Timezone in which to run the schedule
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
persistence EventPersistence	Persistence hold the configuration for event persistence
filter EventSourceFilter	(Optional) Filter

CatchupConfiguration

(Appears on: EventPersistence)

Field	Description
enabled bool	Enabled enables to triggered the missed schedule when eventsource restarts
maxDuration string	MaxDuration holds max catchup duration

Comparator (string alias)

(Appears on: DataFilter)

Comparator refers to the comparator operator for a data filter

Condition

(Appears on: Status)

Condition contains details about resource state

Field	Description
type ConditionType	Condition type.
status Kubernetes core/v1.ConditionStatus	Condition status, True, False or Unknown.
lastTransitionTime Kubernetes meta/v1.Time	(Optional) Last time the condition transitioned from one status to another.
reason string	(Optional) Unique, this should be a short, machine understandable string that gives the reason for condition’s last transition. For example, “ImageNotFound”
message string	(Optional) Human-readable message indicating details about last transition.

ConditionType (string alias)

(Appears on: Condition)

ConditionType is a valid value of Condition.Type

ConditionsResetByTime

(Appears on: ConditionsResetCriteria)

Field	Description
cron string	Cron is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron
timezone string	(Optional)

ConditionsResetCriteria

(Appears on: TriggerTemplate)

Field	Description
byTime ConditionsResetByTime	Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron

ConfigMapPersistence

(Appears on: EventPersistence)

Field	Description
name string	Name of the configmap
createIfNotExist bool	CreateIfNotExist will create configmap if it doesn’t exists

ContainerTemplate

(Appears on: JetStreamBus, NativeStrategy)

ContainerTemplate defines customized spec for a container

Field	Description
resources Kubernetes core/v1.ResourceRequirements
imagePullPolicy Kubernetes core/v1.PullPolicy
securityContext Kubernetes core/v1.SecurityContext

CustomTrigger

(Appears on: TriggerTemplate)

CustomTrigger refers to the specification of the custom trigger.

Field	Description
serverURL string	ServerURL is the url of the gRPC server that executes custom trigger
secure bool	Secure refers to type of the connection between sensor to custom trigger gRPC
certSecret Kubernetes core/v1.SecretKeySelector	CertSecret refers to the secret that contains cert for secure connection between sensor and custom trigger gRPC server.
serverNameOverride string	ServerNameOverride for the secure connection between sensor and custom trigger gRPC server.
spec map\[string\]string	Spec is the custom trigger resource specification that custom trigger gRPC server knows how to interpret.
parameters \[\]TriggerParameter	Parameters is the list of parameters that is applied to resolved custom trigger trigger object.
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.

DataFilter

(Appears on: EventDependencyFilter)

DataFilter describes constraints and filters for event data Regular Expressions are purposefully not a feature as they are overkill for our uses here See Rob Pike’s Post: https://commandcenter.blogspot.com/2011/08/regular-expressions-in-lexing-and.html

Field	Description
path string	Path is the JSONPath of the event’s (JSON decoded) data key Path is a series of keys separated by a dot. A key may contain wildcard characters ‘\*’ and ‘?’. To access an array value use the index as the key. The dot and wildcard characters can be escaped with ‘’. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
type JSONType	Type contains the JSON type of the data
value \[\]string	Value is the allowed string values for this key Booleans are passed using strconv.ParseBool() Numbers are parsed using as float64 using strconv.ParseFloat() Strings are taken as is Nils this value is ignored
comparator Comparator	Comparator compares the event data with a user given value. Can be “\>=”, “\>”, “=”, “!=”, “\<”, or “\<=”. Is optional, and if left blank treated as equality “=”.
template string	Template is a go-template for extracting a string from the event’s data. A Template is evaluated with provided path, type and value. The templating follows the standard go-template syntax as well as sprig’s extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/

EmailTrigger

(Appears on: TriggerTemplate)

EmailTrigger refers to the specification of the email notification trigger.

Field	Description
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.
username string	(Optional) Username refers to the username used to connect to the smtp server.
smtpPassword Kubernetes core/v1.SecretKeySelector	(Optional) SMTPPassword refers to the Kubernetes secret that holds the smtp password used to connect to smtp server.
host string	Host refers to the smtp host url to which email is send.
port int32	(Optional) Port refers to the smtp server port to which email is send. Defaults to 0.
to \[\]string	(Optional) To refers to the email addresses to which the emails are send.
from string	(Optional) From refers to the address from which the email is send from.
subject string	(Optional) Subject refers to the subject line for the email send.
body string	(Optional) Body refers to the body/content of the email send.

EmitterEventSource

(Appears on: EventSourceSpec)

EmitterEventSource describes the event source for emitter More info at https://emitter.io/develop/getting-started/

Field	Description
broker string	Broker URI to connect to.
channelKey string	ChannelKey refers to the channel key
channelName string	ChannelName refers to the channel name
username Kubernetes core/v1.SecretKeySelector	(Optional) Username to use to connect to broker
password Kubernetes core/v1.SecretKeySelector	(Optional) Password to use to connect to broker
connectionBackoff Backoff	(Optional) Backoff holds parameters applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
tls TLSConfig	(Optional) TLS configuration for the emitter client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

Event

Event represents the cloudevent received from an event source.

Field	Description
context EventContext
data \[\]byte

EventBus

EventBus is the definition of a eventbus resource

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EventBusSpec	nats NATSBus (Optional) NATS eventbus jetstream JetStreamBus (Optional) kafka KafkaBus (Optional) Kafka eventbus jetstreamExotic JetStreamConfig (Optional) Exotic JetStream
status EventBusStatus	(Optional)

EventBusSpec

(Appears on: EventBus)

EventBusSpec refers to specification of eventbus resource

Field	Description
nats NATSBus	(Optional) NATS eventbus
jetstream JetStreamBus	(Optional)
kafka KafkaBus	(Optional) Kafka eventbus
jetstreamExotic JetStreamConfig	(Optional) Exotic JetStream

EventBusStatus

(Appears on: EventBus)

EventBusStatus holds the status of the eventbus resource

Field	Description
Status Status	(Members of Status are embedded into this type.)
config BusConfig	Config holds the fininalized configuration of EventBus

EventBusType (string alias)

EventBusType is the type of event bus

EventContext

(Appears on: Event, EventDependencyFilter)

EventContext holds the context of the cloudevent received from an event source.

Field	Description
id string	ID of the event; must be non-empty and unique within the scope of the producer.
source string	Source - A URI describing the event producer.
specversion string	SpecVersion - The version of the CloudEvents specification used by the event.
type string	Type - The type of the occurrence which has happened.
datacontenttype string	DataContentType - A MIME (RFC2046) string describing the media type of data.
subject string	Subject - The subject of the event in the context of the event producer
time Kubernetes meta/v1.Time	Time - A Timestamp when the event happened.

EventDependency

(Appears on: SensorSpec)

EventDependency describes a dependency

Field	Description
name string	Name is a unique name of this dependency
eventSourceName string	EventSourceName is the name of EventSource that Sensor depends on
eventName string	EventName is the name of the event
filters EventDependencyFilter	Filters and rules governing toleration of success and constraints on the context and data of an event
transform EventDependencyTransformer	Transform transforms the event data
filtersLogicalOperator LogicalOperator	FiltersLogicalOperator defines how different filters are evaluated together. Available values: and (&&), or (\|\|) Is optional and if left blank treated as and (&&).

EventDependencyFilter

(Appears on: EventDependency)

EventDependencyFilter defines filters and constraints for a event.

Field	Description
time TimeFilter	Time filter on the event with escalation
context EventContext	Context filter constraints
data \[\]DataFilter	Data filter constraints with escalation
exprs \[\]ExprFilter	Exprs contains the list of expressions evaluated against the event payload.
dataLogicalOperator LogicalOperator	DataLogicalOperator defines how multiple Data filters (if defined) are evaluated together. Available values: and (&&), or (\|\|) Is optional and if left blank treated as and (&&).
exprLogicalOperator LogicalOperator	ExprLogicalOperator defines how multiple Exprs filters (if defined) are evaluated together. Available values: and (&&), or (\|\|) Is optional and if left blank treated as and (&&).
script string	Script refers to a Lua script evaluated to determine the validity of an event.

EventDependencyTransformer

(Appears on: EventDependency)

EventDependencyTransformer transforms the event

Field	Description
jq string	(Optional) JQ holds the jq command applied for transformation
script string	(Optional) Script refers to a Lua script used to transform the event

EventPersistence

(Appears on: CalendarEventSource)

Field	Description
catchup CatchupConfiguration	Catchup enables to triggered the missed schedule when eventsource restarts
configMap ConfigMapPersistence	ConfigMap holds configmap details for persistence

EventSource

EventSource is the definition of a eventsource resource

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec EventSourceSpec	eventBusName string EventBusName references to a EventBus name. By default the value is “default” template Template (Optional) Template is the pod specification for the event source service Service (Optional) Service is the specifications of the service to expose the event source minio map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.S3Artifact Minio event sources calendar map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.CalendarEventSource Calendar event sources file map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.FileEventSource File event sources resource map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.ResourceEventSource Resource event sources webhook map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.WebhookEventSource Webhook event sources amqp map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AMQPEventSource AMQP event sources kafka map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.KafkaEventSource Kafka event sources mqtt map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.MQTTEventSource MQTT event sources nats map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.NATSEventsSource NATS event sources sns map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SNSEventSource SNS event sources sqs map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SQSEventSource SQS event sources pubSub map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.PubSubEventSource PubSub event sources github map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GithubEventSource Github event sources gitlab map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GitlabEventSource Gitlab event sources hdfs map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.HDFSEventSource HDFS event sources slack map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SlackEventSource Slack event sources storageGrid map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.StorageGridEventSource StorageGrid event sources azureEventsHub map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureEventsHubEventSource AzureEventsHub event sources stripe map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.StripeEventSource Stripe event sources emitter map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.EmitterEventSource Emitter event source redis map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.RedisEventSource Redis event source nsq map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.NSQEventSource NSQ event source pulsar map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.PulsarEventSource Pulsar event source generic map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GenericEventSource Generic event source replicas int32 Replicas is the event source deployment replicas bitbucketserver map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.BitbucketServerEventSource Bitbucket Server event sources bitbucket map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.BitbucketEventSource Bitbucket event sources redisStream map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.RedisStreamEventSource Redis stream source azureServiceBus map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureServiceBusEventSource Azure Service Bus event source azureQueueStorage map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureQueueStorageEventSource AzureQueueStorage event source sftp map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SFTPEventSource SFTP event sources gerrit map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GerritEventSource Gerrit event source
status EventSourceStatus	(Optional)

EventSourceFilter

(Appears on: AMQPEventSource, AzureEventsHubEventSource, AzureQueueStorageEventSource, AzureServiceBusEventSource, BitbucketEventSource, BitbucketServerEventSource, CalendarEventSource, EmitterEventSource, FileEventSource, GenericEventSource, GerritEventSource, GithubEventSource, GitlabEventSource, HDFSEventSource, KafkaEventSource, MQTTEventSource, NATSEventsSource, NSQEventSource, PubSubEventSource, PulsarEventSource, RedisEventSource, RedisStreamEventSource, SFTPEventSource, SNSEventSource, SQSEventSource, SlackEventSource, WebhookEventSource)

Field	Description
expression string

EventSourceSpec

(Appears on: EventSource)

EventSourceSpec refers to specification of event-source resource

Field	Description
eventBusName string	EventBusName references to a EventBus name. By default the value is “default”
template Template	(Optional) Template is the pod specification for the event source
service Service	(Optional) Service is the specifications of the service to expose the event source
minio map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.S3Artifact	Minio event sources
calendar map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.CalendarEventSource	Calendar event sources
file map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.FileEventSource	File event sources
resource map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.ResourceEventSource	Resource event sources
webhook map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.WebhookEventSource	Webhook event sources
amqp map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AMQPEventSource	AMQP event sources
kafka map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.KafkaEventSource	Kafka event sources
mqtt map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.MQTTEventSource	MQTT event sources
nats map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.NATSEventsSource	NATS event sources
sns map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SNSEventSource	SNS event sources
sqs map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SQSEventSource	SQS event sources
pubSub map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.PubSubEventSource	PubSub event sources
github map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GithubEventSource	Github event sources
gitlab map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GitlabEventSource	Gitlab event sources
hdfs map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.HDFSEventSource	HDFS event sources
slack map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SlackEventSource	Slack event sources
storageGrid map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.StorageGridEventSource	StorageGrid event sources
azureEventsHub map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureEventsHubEventSource	AzureEventsHub event sources
stripe map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.StripeEventSource	Stripe event sources
emitter map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.EmitterEventSource	Emitter event source
redis map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.RedisEventSource	Redis event source
nsq map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.NSQEventSource	NSQ event source
pulsar map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.PulsarEventSource	Pulsar event source
generic map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GenericEventSource	Generic event source
replicas int32	Replicas is the event source deployment replicas
bitbucketserver map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.BitbucketServerEventSource	Bitbucket Server event sources
bitbucket map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.BitbucketEventSource	Bitbucket event sources
redisStream map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.RedisStreamEventSource	Redis stream source
azureServiceBus map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureServiceBusEventSource	Azure Service Bus event source
azureQueueStorage map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.AzureQueueStorageEventSource	AzureQueueStorage event source
sftp map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SFTPEventSource	SFTP event sources
gerrit map\[string\]github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.GerritEventSource	Gerrit event source

EventSourceStatus

(Appears on: EventSource)

EventSourceStatus holds the status of the event-source resource

Field	Description
Status Status	(Members of Status are embedded into this type.)

EventSourceType (string alias)

EventSourceType is the type of event source

ExprFilter

(Appears on: EventDependencyFilter)

Field	Description
expr string	Expr refers to the expression that determines the outcome of the filter.
fields \[\]PayloadField	Fields refers to set of keys that refer to the paths within event payload.

FileArtifact

(Appears on: ArtifactLocation)

FileArtifact contains information about an artifact in a filesystem

Field	Description
path string

FileEventSource

(Appears on: EventSourceSpec)

FileEventSource describes an event-source for file related events.

Field	Description
eventType string	Type of file operations to watch Refer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information
watchPathConfig WatchPathConfig	WatchPathConfig contains configuration about the file path to watch
polling bool	Use polling instead of inotify
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

GenericEventSource

(Appears on: EventSourceSpec)

GenericEventSource refers to a generic event source. It can be used to implement a custom event source.

Field	Description
url string	URL of the gRPC server that implements the event source.
config string	Config is the event source configuration
insecure bool	Insecure determines the type of connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
authSecret Kubernetes core/v1.SecretKeySelector	(Optional) AuthSecret holds a secret selector that contains a bearer token for authentication
filter EventSourceFilter	(Optional) Filter

GerritEventSource

(Appears on: EventSourceSpec)

GerritEventSource refers to event-source related to gerrit events

Field	Description
webhook WebhookContext	Webhook holds configuration to run a http server
hookName string	HookName is the name of the webhook
events \[\]string	Events are gerrit event to listen to. Refer https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events
auth BasicAuth	(Optional) Auth hosts secret selectors for username and password
gerritBaseURL string	GerritBaseURL is the base URL for API requests to a custom endpoint
deleteHookOnFinish bool	(Optional) DeleteHookOnFinish determines whether to delete the Gerrit hook for the project once the event source is stopped.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
projects \[\]string	List of project namespace paths like “whynowy/test”.
sslVerify bool	(Optional) SslVerify to enable ssl verification
filter EventSourceFilter	(Optional) Filter

GitArtifact

(Appears on: ArtifactLocation)

GitArtifact contains information about an artifact stored in git

Field	Description
url string	Git URL
cloneDirectory string	Directory to clone the repository. We clone complete directory because GitArtifact is not limited to any specific Git service providers. Hence we don’t use any specific git provider client.
creds GitCreds	(Optional) Creds contain reference to git username and password
sshKeySecret Kubernetes core/v1.SecretKeySelector	SSHKeySecret refers to the secret that contains SSH key
filePath string	Path to file that contains trigger resource definition
branch string	(Optional) Branch to use to pull trigger resource
tag string	(Optional) Tag to use to pull trigger resource
ref string	(Optional) Ref to use to pull trigger resource. Will result in a shallow clone and fetch.
remote GitRemoteConfig	(Optional) Remote to manage set of tracked repositories. Defaults to “origin”. Refer https://git-scm.com/docs/git-remote
insecureIgnoreHostKey bool	(Optional) Whether to ignore host key

GitCreds

(Appears on: GitArtifact)

GitCreds contain reference to git username and password

Field	Description
username Kubernetes core/v1.SecretKeySelector
password Kubernetes core/v1.SecretKeySelector

GitRemoteConfig

(Appears on: GitArtifact)

GitRemoteConfig contains the configuration of a Git remote

Field	Description
name string	Name of the remote to fetch from.
urls \[\]string	URLs the URLs of a remote repository. It must be non-empty. Fetch will always use the first URL, while push will use all of them.

GithubAppCreds

(Appears on: GithubEventSource)

Field	Description
privateKey Kubernetes core/v1.SecretKeySelector	PrivateKey refers to a K8s secret containing the GitHub app private key
appID int64	AppID refers to the GitHub App ID for the application you created
installationID int64	InstallationID refers to the Installation ID of the GitHub app you created and installed

GithubEventSource

(Appears on: EventSourceSpec)

GithubEventSource refers to event-source for github related events

Field	Description
id int64	(Optional) Id is the webhook’s id Deprecated: This is not used at all, will be removed in v1.6
webhook WebhookContext	Webhook refers to the configuration required to run a http server
owner string	(Optional) DeprecatedOwner refers to GitHub owner name i.e. argoproj Deprecated: use Repositories instead. Will be unsupported in v 1.6
repository string	(Optional) DeprecatedRepository refers to GitHub repo name i.e. argo-events Deprecated: use Repositories instead. Will be unsupported in v 1.6
events \[\]string	Events refer to Github events to which the event source will subscribe
apiToken Kubernetes core/v1.SecretKeySelector	(Optional) APIToken refers to a K8s secret containing github api token
webhookSecret Kubernetes core/v1.SecretKeySelector	(Optional) WebhookSecret refers to K8s secret containing GitHub webhook secret https://developer.github.com/webhooks/securing/
insecure bool	Insecure tls verification
active bool	(Optional) Active refers to status of the webhook for event deliveries. https://developer.github.com/webhooks/creating/#active
contentType string	ContentType of the event delivery
githubBaseURL string	(Optional) GitHub base URL (for GitHub Enterprise)
githubUploadURL string	(Optional) GitHub upload URL (for GitHub Enterprise)
deleteHookOnFinish bool	(Optional) DeleteHookOnFinish determines whether to delete the GitHub hook for the repository once the event source is stopped.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
repositories \[\]OwnedRepositories	Repositories holds the information of repositories, which uses repo owner as the key, and list of repo names as the value. Not required if Organizations is set.
organizations \[\]string	Organizations holds the names of organizations (used for organization level webhooks). Not required if Repositories is set.
githubApp GithubAppCreds	(Optional) GitHubApp holds the GitHub app credentials
filter EventSourceFilter	(Optional) Filter

GitlabEventSource

(Appears on: EventSourceSpec)

GitlabEventSource refers to event-source related to Gitlab events

Field	Description
webhook WebhookContext	Webhook holds configuration to run a http server
projectID string	(Optional) DeprecatedProjectID is the id of project for which integration needs to setup Deprecated: use Projects instead. Will be unsupported in v 1.7
events \[\]string	Events are gitlab event to listen to. Refer https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794.
accessToken Kubernetes core/v1.SecretKeySelector	AccessToken references to k8 secret which holds the gitlab api access information
enableSSLVerification bool	(Optional) EnableSSLVerification to enable ssl verification
gitlabBaseURL string	GitlabBaseURL is the base URL for API requests to a custom endpoint
deleteHookOnFinish bool	(Optional) DeleteHookOnFinish determines whether to delete the GitLab hook for the project once the event source is stopped.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
projects \[\]string	(Optional) List of project IDs or project namespace paths like “whynowy/test”. Projects and groups cannot be empty at the same time.
secretToken Kubernetes core/v1.SecretKeySelector	SecretToken references to k8 secret which holds the Secret Token used by webhook config
filter EventSourceFilter	(Optional) Filter
groups \[\]string	(Optional) List of group IDs or group name like “test”. Group level hook available in Premium and Ultimate Gitlab.

HDFSEventSource

(Appears on: EventSourceSpec)

HDFSEventSource refers to event-source for HDFS related events

Field	Description
WatchPathConfig WatchPathConfig	(Members of WatchPathConfig are embedded into this type.)
type string	Type of file operations to watch
checkInterval string	CheckInterval is a string that describes an interval duration to check the directory state, e.g. 1s, 30m, 2h… (defaults to 1m)
addresses \[\]string
hdfsUser string	HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.
krbCCacheSecret Kubernetes core/v1.SecretKeySelector	KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.
krbKeytabSecret Kubernetes core/v1.SecretKeySelector	KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.
krbUsername string	KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.
krbRealm string	KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.
krbConfigConfigMap Kubernetes core/v1.ConfigMapKeySelector	KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.
krbServicePrincipalName string	KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

HTTPTrigger

(Appears on: TriggerTemplate)

HTTPTrigger is the trigger for the HTTP request

Field	Description
url string	URL refers to the URL to send HTTP request to.
payload \[\]TriggerParameter
tls TLSConfig	(Optional) TLS configuration for the HTTP client.
method string	(Optional) Method refers to the type of the HTTP request. Refer https://golang.org/src/net/http/method.go for more info. Default value is POST.
parameters \[\]TriggerParameter	Parameters is the list of key-value extracted from event’s payload that are applied to the HTTP trigger resource.
timeout int64	(Optional) Timeout refers to the HTTP request timeout in seconds. Default value is 60 seconds.
basicAuth BasicAuth	(Optional) BasicAuth configuration for the http request.
headers map\[string\]string	(Optional) Headers for the HTTP request.
secureHeaders \[\]\*github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SecureHeader	(Optional) Secure Headers stored in Kubernetes Secrets for the HTTP requests.

Int64OrString

(Appears on: Backoff)

Field	Description
type Type
int64Val int64
strVal string

JSONType (string alias)

(Appears on: DataFilter)

JSONType contains the supported JSON types for data filtering

JetStreamBus

(Appears on: EventBusSpec)

JetStreamBus holds the JetStream EventBus information

Field	Description
version string	JetStream version, such as “2.7.3”
replicas int32	JetStream StatefulSet size
containerTemplate ContainerTemplate	(Optional) ContainerTemplate contains customized spec for Nats JetStream container
reloaderContainerTemplate ContainerTemplate	(Optional) ReloaderContainerTemplate contains customized spec for config reloader container
metricsContainerTemplate ContainerTemplate	(Optional) MetricsContainerTemplate contains customized spec for metrics container
persistence PersistenceStrategy	(Optional)
metadata Metadata	Metadata sets the pods’s metadata, i.e. annotations and labels
nodeSelector map\[string\]string	(Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations \[\]Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
securityContext Kubernetes core/v1.PodSecurityContext	(Optional) SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
imagePullSecrets \[\]Kubernetes core/v1.LocalObjectReference	(Optional) 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. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
priorityClassName string	(Optional) If specified, indicates the Redis pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
priority int32	(Optional) The priority value. Various system components use this field to find the priority of the Redis pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
affinity Kubernetes core/v1.Affinity	(Optional) The pod’s scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
serviceAccountName string	(Optional) ServiceAccountName to apply to the StatefulSet
settings string	(Optional) JetStream configuration, if not specified, global settings in controller-config will be used. See https://docs.nats.io/running-a-nats-service/configuration#jetstream. Only configure “max_memory_store” or “max_file_store”, do not set “store_dir” as it has been hardcoded.
startArgs \[\]string	(Optional) Optional arguments to start nats-server. For example, “-D” to enable debugging output, “-DV” to enable debugging and tracing. Check https://docs.nats.io/ for all the available arguments.
streamConfig string	(Optional) Optional configuration for the streams to be created in this JetStream service, if specified, it will be merged with the default configuration in controller-config. It accepts a YAML format configuration, available fields include, “maxBytes”, “maxMsgs”, “maxAge” (e.g. 72h), “replicas” (1, 3, 5), “duplicates” (e.g. 5m), “retention” (e.g. 0: Limits (default), 1: Interest, 2: WorkQueue), “Discard” (e.g. 0: DiscardOld (default), 1: DiscardNew).
maxPayload string	(Optional) Maximum number of bytes in a message payload, 0 means unlimited. Defaults to 1MB

JetStreamConfig

(Appears on: BusConfig, EventBusSpec)

Field	Description
url string	JetStream (Nats) URL
accessSecret Kubernetes core/v1.SecretKeySelector	(Optional) Secret for auth
streamConfig string	(Optional)
tls TLSConfig	(Optional) SSL/TLS settings for the NATS client

K8SResource

(Appears on: ArtifactLocation)

K8SResource represent arbitrary structured data.

Field	Description
value \[\]byte

K8SResourcePolicy

(Appears on: TriggerPolicy)

K8SResourcePolicy refers to the policy used to check the state of K8s based triggers using labels

Field	Description
labels map\[string\]string	Labels required to identify whether a resource is in success state
backoff Backoff	Backoff before checking resource state
errorOnBackoffTimeout bool	ErrorOnBackoffTimeout determines whether sensor should transition to error state if the trigger policy is unable to determine the state of the resource

KafkaBus

(Appears on: BusConfig, EventBusSpec)

KafkaBus holds the KafkaBus EventBus information

Field	Description
url string	URL to kafka cluster, multiple URLs separated by comma
topic string	(Optional) Topic name, defaults to {namespace_name}-{eventbus_name}
version string	(Optional) Kafka version, sarama defaults to the oldest supported stable version
tls TLSConfig	(Optional) TLS configuration for the kafka client.
sasl SASLConfig	(Optional) SASL configuration for the kafka client
consumerGroup KafkaConsumerGroup	(Optional) Consumer group for kafka client

KafkaConsumerGroup

(Appears on: KafkaBus, KafkaEventSource)

Field	Description
groupName string	The name for the consumer group to use
oldest bool	(Optional) When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false
rebalanceStrategy string	(Optional) Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default.

KafkaEventSource

(Appears on: EventSourceSpec)

KafkaEventSource refers to event-source for Kafka related events

Field	Description
url string	URL to kafka cluster, multiple URLs separated by comma
partition string	(Optional) Partition name
topic string	Topic name
connectionBackoff Backoff	Backoff holds parameters applied to connection.
tls TLSConfig	(Optional) TLS configuration for the kafka client.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
consumerGroup KafkaConsumerGroup	(Optional) Consumer group for kafka client
limitEventsPerSecond int64	(Optional) Sets a limit on how many events get read from kafka per second.
version string	(Optional) Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0
sasl SASLConfig	(Optional) SASL configuration for the kafka client
filter EventSourceFilter	(Optional) Filter
config string	(Optional) Yaml format Sarama config for Kafka connection. It follows the struct of sarama.Config. See https://github.com/IBM/sarama/blob/main/config.go e.g. consumer: fetch: min: 1 net: MaxOpenRequests: 5

KafkaTrigger

(Appears on: TriggerTemplate)

KafkaTrigger refers to the specification of the Kafka trigger.

Field	Description
url string	URL of the Kafka broker, multiple URLs separated by comma.
topic string	Name of the topic. More info at https://kafka.apache.org/documentation/#intro_topics
partition int32	(Optional) DEPRECATED
parameters \[\]TriggerParameter	Parameters is the list of parameters that is applied to resolved Kafka trigger object.
requiredAcks int32	RequiredAcks used in producer to tell the broker how many replica acknowledgements Defaults to 1 (Only wait for the leader to ack).
compress bool	(Optional) Compress determines whether to compress message or not. Defaults to false. If set to true, compresses message using snappy compression.
flushFrequency int32	(Optional) FlushFrequency refers to the frequency in milliseconds to flush batches. Defaults to 500 milliseconds.
tls TLSConfig	(Optional) TLS configuration for the Kafka producer.
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
partitioningKey string	The partitioning key for the messages put on the Kafka topic.
version string	(Optional) Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0
sasl SASLConfig	(Optional) SASL configuration for the kafka client
schemaRegistry SchemaRegistryConfig	(Optional) Schema Registry configuration to producer message with avro format
headers map\[string\]string	(Optional) Headers for the Kafka Messages.
secureHeaders \[\]\*github.com/argoproj/argo-events/pkg/apis/events/v1alpha1.SecureHeader	(Optional) Secure Headers stored in Kubernetes Secrets for the Kafka messages.

KubernetesResourceOperation (string alias)

(Appears on: StandardK8STrigger)

KubernetesResourceOperation refers to the type of operation performed on the K8s resource

LogTrigger

(Appears on: TriggerTemplate)

Field	Description
intervalSeconds uint64	(Optional) Only print messages every interval. Useful to prevent logging too much data for busy events.

LogicalOperator (string alias)

(Appears on: EventDependency, EventDependencyFilter)

MQTTEventSource

(Appears on: EventSourceSpec)

MQTTEventSource refers to event-source for MQTT related events

Field	Description
url string	URL to connect to broker
topic string	Topic name
clientId string	ClientID is the id of the client
connectionBackoff Backoff	ConnectionBackoff holds backoff applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
tls TLSConfig	(Optional) TLS configuration for the mqtt client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
auth BasicAuth	(Optional) Auth hosts secret selectors for username and password

Metadata

(Appears on: JetStreamBus, NativeStrategy, Service, Template)

Metadata holds the annotations and labels of an event source pod

Field	Description
annotations map\[string\]string
labels map\[string\]string

NATSAuth

(Appears on: NATSEventsSource)

NATSAuth refers to the auth info for NATS EventSource

Field	Description
basic BasicAuth	(Optional) Baisc auth with username and password
token Kubernetes core/v1.SecretKeySelector	(Optional) Token used to connect
nkey Kubernetes core/v1.SecretKeySelector	(Optional) NKey used to connect
credential Kubernetes core/v1.SecretKeySelector	(Optional) credential used to connect

NATSBus

(Appears on: EventBusSpec)

NATSBus holds the NATS eventbus information

Field	Description
native NativeStrategy	Native means to bring up a native NATS service
exotic NATSConfig	Exotic holds an exotic NATS config

NATSConfig

(Appears on: BusConfig, NATSBus)

NATSConfig holds the config of NATS

Field	Description
url string	NATS streaming url
clusterID string	Cluster ID for nats streaming
auth AuthStrategy	(Optional) Auth strategy, default to AuthStrategyNone
accessSecret Kubernetes core/v1.SecretKeySelector	(Optional) Secret for auth

NATSEventsSource

(Appears on: EventSourceSpec)

NATSEventsSource refers to event-source for NATS related events

Field	Description
url string	URL to connect to NATS cluster
subject string	Subject holds the name of the subject onto which messages are published
connectionBackoff Backoff	ConnectionBackoff holds backoff applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
tls TLSConfig	(Optional) TLS configuration for the nats client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
auth NATSAuth	(Optional) Auth information
filter EventSourceFilter	(Optional) Filter
queue string	(Optional) Queue is the name of the queue group to subscribe as if specified. Uses QueueSubscribe logic to subscribe as queue group. If the queue is empty, uses default Subscribe logic.

NATSTrigger

(Appears on: TriggerTemplate)

NATSTrigger refers to the specification of the NATS trigger.

Field	Description
url string	URL of the NATS cluster.
subject string	Name of the subject to put message on.
payload \[\]TriggerParameter
parameters \[\]TriggerParameter
tls TLSConfig	(Optional) TLS configuration for the NATS producer.

NSQEventSource

(Appears on: EventSourceSpec)

NSQEventSource describes the event source for NSQ PubSub More info at https://godoc.org/github.com/nsqio/go-nsq

Field	Description
hostAddress string	HostAddress is the address of the host for NSQ lookup
topic string	Topic to subscribe to.
channel string	Channel used for subscription
connectionBackoff Backoff	(Optional) Backoff holds parameters applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
tls TLSConfig	(Optional) TLS configuration for the nsq client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

NativeStrategy

(Appears on: NATSBus)

NativeStrategy indicates to install a native NATS service

Field	Description
replicas int32	Size is the NATS StatefulSet size
auth AuthStrategy
persistence PersistenceStrategy	(Optional)
containerTemplate ContainerTemplate	(Optional) ContainerTemplate contains customized spec for NATS container
metricsContainerTemplate ContainerTemplate	(Optional) MetricsContainerTemplate contains customized spec for metrics container
nodeSelector map\[string\]string	(Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations \[\]Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
metadata Metadata	Metadata sets the pods’s metadata, i.e. annotations and labels
securityContext Kubernetes core/v1.PodSecurityContext	(Optional) SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
maxAge string	(Optional) Max Age of existing messages, i.e. “72h”, “4h35m”
imagePullSecrets \[\]Kubernetes core/v1.LocalObjectReference	(Optional) 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. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
serviceAccountName string	(Optional) ServiceAccountName to apply to NATS StatefulSet
priorityClassName string	(Optional) If specified, indicates the EventSource pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
priority int32	(Optional) The priority value. Various system components use this field to find the priority of the EventSource pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
affinity Kubernetes core/v1.Affinity	(Optional) The pod’s scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
maxMsgs uint64	Maximum number of messages per channel, 0 means unlimited. Defaults to 1000000
maxBytes string	Total size of messages per channel, 0 means unlimited. Defaults to 1GB
maxSubs uint64	Maximum number of subscriptions per channel, 0 means unlimited. Defaults to 1000
maxPayload string	Maximum number of bytes in a message payload, 0 means unlimited. Defaults to 1MB
raftHeartbeatTimeout string	Specifies the time in follower state without a leader before attempting an election, i.e. “72h”, “4h35m”. Defaults to 2s
raftElectionTimeout string	Specifies the time in candidate state without a leader before attempting an election, i.e. “72h”, “4h35m”. Defaults to 2s
raftLeaseTimeout string	Specifies how long a leader waits without being able to contact a quorum of nodes before stepping down as leader, i.e. “72h”, “4h35m”. Defaults to 1s
raftCommitTimeout string	Specifies the time without an Apply() operation before sending an heartbeat to ensure timely commit, i.e. “72h”, “4h35m”. Defaults to 100ms

OpenWhiskTrigger

(Appears on: TriggerTemplate)

OpenWhiskTrigger refers to the specification of the OpenWhisk trigger.

Field	Description
host string	Host URL of the OpenWhisk.
version string	(Optional) Version for the API. Defaults to v1.
namespace string	Namespace for the action. Defaults to “\_”.
authToken Kubernetes core/v1.SecretKeySelector	(Optional) AuthToken for authentication.
actionName string	Name of the action/function.
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.

OwnedRepositories

(Appears on: GithubEventSource)

Field	Description
owner string	Organization or user name
names \[\]string	Repository names

PayloadField

(Appears on: ExprFilter)

PayloadField binds a value at path within the event payload against a name.

Field	Description
path string	Path is the JSONPath of the event’s (JSON decoded) data key Path is a series of keys separated by a dot. A key may contain wildcard characters ‘\*’ and ‘?’. To access an array value use the index as the key. The dot and wildcard characters can be escaped with ‘’. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
name string	Name acts as key that holds the value at the path.

PersistenceStrategy

(Appears on: JetStreamBus, NativeStrategy)

PersistenceStrategy defines the strategy of persistence

Field	Description
storageClassName string	(Optional) Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
accessMode Kubernetes core/v1.PersistentVolumeAccessMode	(Optional) Available access modes such as ReadWriteOnce, ReadWriteMany https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes
volumeSize k8s.io/apimachinery/pkg/api/resource.Quantity	Volume size, e.g. 10Gi

PubSubEventSource

(Appears on: EventSourceSpec)

PubSubEventSource refers to event-source for GCP PubSub related events.

Field	Description
projectID string	(Optional) ProjectID is GCP project ID for the subscription. Required if you run Argo Events outside of GKE/GCE. (otherwise, the default value is its project)
topicProjectID string	(Optional) TopicProjectID is GCP project ID for the topic. By default, it is same as ProjectID.
topic string	(Optional) Topic to which the subscription should belongs. Required if you want the eventsource to create a new subscription. If you specify this field along with an existing subscription, it will be verified whether it actually belongs to the specified topic.
subscriptionID string	(Optional) SubscriptionID is ID of subscription. Required if you use existing subscription. The default value will be auto generated hash based on this eventsource setting, so the subscription might be recreated every time you update the setting, which has a possibility of event loss.
credentialSecret Kubernetes core/v1.SecretKeySelector	(Optional) CredentialSecret references to the secret that contains JSON credentials to access GCP. If it is missing, it implicitly uses Workload Identity to access. https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
deleteSubscriptionOnFinish bool	(Optional) DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub subscription once the event source is stopped.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

PulsarEventSource

(Appears on: EventSourceSpec)

PulsarEventSource describes the event source for Apache Pulsar

Field	Description
topics \[\]string	Name of the topics to subscribe to.
type string	(Optional) Type of the subscription. Only “exclusive” and “shared” is supported. Defaults to exclusive.
url string	Configure the service URL for the Pulsar service.
tlsTrustCertsSecret Kubernetes core/v1.SecretKeySelector	(Optional) Trusted TLS certificate secret.
tlsAllowInsecureConnection bool	(Optional) Whether the Pulsar client accept untrusted TLS certificate from broker.
tlsValidateHostname bool	(Optional) Whether the Pulsar client verify the validity of the host name from broker.
tls TLSConfig	(Optional) TLS configuration for the pulsar client.
connectionBackoff Backoff	(Optional) Backoff holds parameters applied to connection.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
authTokenSecret Kubernetes core/v1.SecretKeySelector	(Optional) Authentication token for the pulsar client. Either token or athenz can be set to use auth.
filter EventSourceFilter	(Optional) Filter
authAthenzParams map\[string\]string	(Optional) Authentication athenz parameters for the pulsar client. Refer https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go Either token or athenz can be set to use auth.
authAthenzSecret Kubernetes core/v1.SecretKeySelector	(Optional) Authentication athenz privateKey secret for the pulsar client. AuthAthenzSecret must be set if AuthAthenzParams is used.

PulsarTrigger

(Appears on: TriggerTemplate)

PulsarTrigger refers to the specification of the Pulsar trigger.

Field	Description
url string	Configure the service URL for the Pulsar service.
topic string	Name of the topic. See https://pulsar.apache.org/docs/en/concepts-messaging/
parameters \[\]TriggerParameter	Parameters is the list of parameters that is applied to resolved Kafka trigger object.
payload \[\]TriggerParameter	Payload is the list of key-value extracted from an event payload to construct the request payload.
tlsTrustCertsSecret Kubernetes core/v1.SecretKeySelector	(Optional) Trusted TLS certificate secret.
tlsAllowInsecureConnection bool	(Optional) Whether the Pulsar client accept untrusted TLS certificate from broker.
tlsValidateHostname bool	(Optional) Whether the Pulsar client verify the validity of the host name from broker.
tls TLSConfig	(Optional) TLS configuration for the pulsar client.
authTokenSecret Kubernetes core/v1.SecretKeySelector	(Optional) Authentication token for the pulsar client. Either token or athenz can be set to use auth.
connectionBackoff Backoff	(Optional) Backoff holds parameters applied to connection.
authAthenzParams map\[string\]string	(Optional) Authentication athenz parameters for the pulsar client. Refer https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go Either token or athenz can be set to use auth.
authAthenzSecret Kubernetes core/v1.SecretKeySelector	(Optional) Authentication athenz privateKey secret for the pulsar client. AuthAthenzSecret must be set if AuthAthenzParams is used.

RateLimit

(Appears on: Trigger)

Field	Description
unit RateLimiteUnit	Defaults to Second
requestsPerUnit int32

RateLimiteUnit (string alias)

(Appears on: RateLimit)

RedisEventSource

(Appears on: EventSourceSpec)

RedisEventSource describes an event source for the Redis PubSub. More info at https://godoc.org/github.com/go-redis/redis#example-PubSub

Field	Description
hostAddress string	HostAddress refers to the address of the Redis host/server
password Kubernetes core/v1.SecretKeySelector	(Optional) Password required for authentication if any.
namespace string	(Optional) Namespace to use to retrieve the password from. It should only be specified if password is declared
db int32	(Optional) DB to use. If not specified, default DB 0 will be used.
channels \[\]string
tls TLSConfig	(Optional) TLS configuration for the redis client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
username string	(Optional) Username required for ACL style authentication if any.

RedisStreamEventSource

(Appears on: EventSourceSpec)

RedisStreamEventSource describes an event source for Redis streams (https://redis.io/topics/streams-intro)

Field	Description
hostAddress string	HostAddress refers to the address of the Redis host/server (master instance)
password Kubernetes core/v1.SecretKeySelector	(Optional) Password required for authentication if any.
db int32	(Optional) DB to use. If not specified, default DB 0 will be used.
streams \[\]string	Streams to look for entries. XREADGROUP is used on all streams using a single consumer group.
maxMsgCountPerRead int32	(Optional) MaxMsgCountPerRead holds the maximum number of messages per stream that will be read in each XREADGROUP of all streams Example: if there are 2 streams and MaxMsgCountPerRead=10, then each XREADGROUP may read upto a total of 20 messages. Same as COUNT option in XREADGROUP(https://redis.io/topics/streams-intro). Defaults to 10
consumerGroup string	(Optional) ConsumerGroup refers to the Redis stream consumer group that will be created on all redis streams. Messages are read through this group. Defaults to ‘argo-events-cg’
tls TLSConfig	(Optional) TLS configuration for the redis client.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
username string	(Optional) Username required for ACL style authentication if any.

ResourceEventSource

(Appears on: EventSourceSpec)

ResourceEventSource refers to a event-source for K8s resource related events.

Field	Description
namespace string	Namespace where resource is deployed
filter ResourceFilter	(Optional) Filter is applied on the metadata of the resource If you apply filter, then the internal event informer will only monitor objects that pass the filter.
GroupVersionResource Kubernetes meta/v1.GroupVersionResource	(Members of GroupVersionResource are embedded into this type.) Group of the resource
eventTypes \[\]ResourceEventType	EventTypes is the list of event type to watch. Possible values are - ADD, UPDATE and DELETE.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.

ResourceEventType (string alias)

(Appears on: ResourceEventSource)

ResourceEventType is the type of event for the K8s resource mutation

ResourceFilter

(Appears on: ResourceEventSource)

ResourceFilter contains K8s ObjectMeta information to further filter resource event objects

Field	Description
prefix string	(Optional) Prefix filter is applied on the resource name.
labels \[\]Selector	(Optional) Labels provide listing options to K8s API to watch resource/s. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/ for more info. Unlike K8s field selector, multiple values are passed as comma separated values instead of list of values. Eg: value: value1,value2. Same as K8s label selector, operator “=”, “==”, “!=”, “exists”, “!”, “notin”, “in”, “gt” and “lt” are supported
fields \[\]Selector	(Optional) Fields provide field filters similar to K8s field selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/). Unlike K8s field selector, it supports arbitrary fileds like “spec.serviceAccountName”, and the value could be a string or a regex. Same as K8s field selector, operator “=”, “==” and “!=” are supported.
createdBy Kubernetes meta/v1.Time	(Optional) If resource is created before the specified time then the event is treated as valid.
afterStart bool	(Optional) If the resource is created after the start time then the event is treated as valid.

S3Artifact

(Appears on: ArtifactLocation, EventSourceSpec)

S3Artifact contains information about an S3 connection and bucket

Field	Description
endpoint string
bucket S3Bucket
region string
insecure bool
accessKey Kubernetes core/v1.SecretKeySelector
secretKey Kubernetes core/v1.SecretKeySelector
events \[\]string
filter S3Filter
metadata map\[string\]string
caCertificate Kubernetes core/v1.SecretKeySelector

S3Bucket

(Appears on: S3Artifact)

S3Bucket contains information to describe an S3 Bucket

Field	Description
key string
name string

S3Filter

(Appears on: S3Artifact)

S3Filter represents filters to apply to bucket notifications for specifying constraints on objects

Field	Description
prefix string
suffix string

SASLConfig

(Appears on: KafkaBus, KafkaEventSource, KafkaTrigger)

SASLConfig refers to SASL configuration for a client

Field	Description
mechanism string	(Optional) SASLMechanism is the name of the enabled SASL mechanism. Possible values: OAUTHBEARER, PLAIN (defaults to PLAIN).
userSecret Kubernetes core/v1.SecretKeySelector	User is the authentication identity (authcid) to present for SASL/PLAIN or SASL/SCRAM authentication
passwordSecret Kubernetes core/v1.SecretKeySelector	Password for SASL/PLAIN authentication

SFTPEventSource

(Appears on: EventSourceSpec)

SFTPEventSource describes an event-source for sftp related events.

Field	Description
eventType string	Type of file operations to watch Refer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information
watchPathConfig WatchPathConfig	WatchPathConfig contains configuration about the file path to watch
username Kubernetes core/v1.SecretKeySelector	Username required for authentication if any.
password Kubernetes core/v1.SecretKeySelector	Password required for authentication if any.
sshKeySecret Kubernetes core/v1.SecretKeySelector	SSHKeySecret refers to the secret that contains SSH key. Key needs to contain private key and public key.
address Kubernetes core/v1.SecretKeySelector	Address sftp address.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter
pollIntervalDuration string	(Optional) PollIntervalDuration the interval at which to poll the SFTP server defaults to 10 seconds

SNSEventSource

(Appears on: EventSourceSpec)

SNSEventSource refers to event-source for AWS SNS related events

Field	Description
webhook WebhookContext	Webhook configuration for http server
topicArn string	TopicArn
accessKey Kubernetes core/v1.SecretKeySelector	AccessKey refers K8s secret containing aws access key
secretKey Kubernetes core/v1.SecretKeySelector	SecretKey refers K8s secret containing aws secret key
region string	Region is AWS region
roleARN string	(Optional) RoleARN is the Amazon Resource Name (ARN) of the role to assume.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
validateSignature bool	(Optional) ValidateSignature is boolean that can be set to true for SNS signature verification
filter EventSourceFilter	(Optional) Filter
endpoint string	(Optional) Endpoint configures connection to a specific SNS endpoint instead of Amazons servers

SQSEventSource

(Appears on: EventSourceSpec)

SQSEventSource refers to event-source for AWS SQS related events

Field	Description
accessKey Kubernetes core/v1.SecretKeySelector	AccessKey refers K8s secret containing aws access key
secretKey Kubernetes core/v1.SecretKeySelector	SecretKey refers K8s secret containing aws secret key
region string	Region is AWS region
queue string	Queue is AWS SQS queue to listen to for messages
waitTimeSeconds int64	WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive in the queue before returning.
roleARN string	(Optional) RoleARN is the Amazon Resource Name (ARN) of the role to assume.
jsonBody bool	(Optional) JSONBody specifies that all event body payload coming from this source will be JSON
queueAccountId string	(Optional) QueueAccountID is the ID of the account that created the queue to monitor
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
dlq bool	(Optional) DLQ specifies if a dead-letter queue is configured for messages that can’t be processed successfully. If set to true, messages with invalid payload won’t be acknowledged to allow to forward them farther to the dead-letter queue. The default value is false.
filter EventSourceFilter	(Optional) Filter
endpoint string	(Optional) Endpoint configures connection to a specific SQS endpoint instead of Amazons servers
sessionToken Kubernetes core/v1.SecretKeySelector	(Optional) SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token

SchemaRegistryConfig

(Appears on: KafkaTrigger)

SchemaRegistryConfig refers to configuration for a client

Field	Description
url string	Schema Registry URL.
schemaId int32	Schema ID
auth BasicAuth	(Optional) SchemaRegistry - basic authentication

SecureHeader

SecureHeader refers to HTTP Headers with auth tokens as values

Field	Description
name string
valueFrom ValueFromSource	Values can be read from either secrets or configmaps

Selector

(Appears on: ResourceFilter)

Selector represents conditional operation to select K8s objects.

Field	Description
key string	Key name
operation string	(Optional) Supported operations like ==, != etc. Defaults to ==. Refer https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors for more info.
value string	Value

Sensor

Sensor is the definition of a sensor resource

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec SensorSpec	dependencies \[\]EventDependency Dependencies is a list of the events that this sensor is dependent on. triggers \[\]Trigger Triggers is a list of the things that this sensor evokes. These are the outputs from this sensor. template Template (Optional) Template is the pod specification for the sensor errorOnFailedRound bool ErrorOnFailedRound if set to true, marks sensor state as error if the previous trigger round fails. Once sensor state is set to error, no further triggers will be processed. eventBusName string EventBusName references to a EventBus name. By default the value is “default” replicas int32 Replicas is the sensor deployment replicas revisionHistoryLimit int32 (Optional) RevisionHistoryLimit specifies how many old deployment revisions to retain loggingFields map\[string\]string (Optional) LoggingFields add additional key-value pairs when logging happens
status SensorStatus	(Optional)

SensorSpec

(Appears on: Sensor)

SensorSpec represents desired sensor state

Field	Description
dependencies \[\]EventDependency	Dependencies is a list of the events that this sensor is dependent on.
triggers \[\]Trigger	Triggers is a list of the things that this sensor evokes. These are the outputs from this sensor.
template Template	(Optional) Template is the pod specification for the sensor
errorOnFailedRound bool	ErrorOnFailedRound if set to true, marks sensor state as error if the previous trigger round fails. Once sensor state is set to error, no further triggers will be processed.
eventBusName string	EventBusName references to a EventBus name. By default the value is “default”
replicas int32	Replicas is the sensor deployment replicas
revisionHistoryLimit int32	(Optional) RevisionHistoryLimit specifies how many old deployment revisions to retain
loggingFields map\[string\]string	(Optional) LoggingFields add additional key-value pairs when logging happens

SensorStatus

(Appears on: Sensor)

SensorStatus contains information about the status of a sensor.

Field	Description
Status Status	(Members of Status are embedded into this type.)

Service

(Appears on: EventSourceSpec)

Service holds the service information eventsource exposes

Field	Description
metadata Metadata	Metadata sets the pods’s metadata, i.e. annotations and labels default={annotations: {}, labels: {}}
ports \[\]Kubernetes core/v1.ServicePort	The list of ports that are exposed by this ClusterIP service.
clusterIP string	(Optional) clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are “None”, empty string (“”), or a valid IP address. “None” can be specified for headless services when proxying is not required. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

SlackEventSource

(Appears on: EventSourceSpec)

SlackEventSource refers to event-source for Slack related events

Field	Description
signingSecret Kubernetes core/v1.SecretKeySelector	Slack App signing secret
token Kubernetes core/v1.SecretKeySelector	Token for URL verification handshake
webhook WebhookContext	Webhook holds configuration for a REST endpoint
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
filter EventSourceFilter	(Optional) Filter

SlackSender

(Appears on: SlackTrigger)

Field	Description
username string	(Optional) Username is the Slack application’s username
icon string	(Optional) Icon is the Slack application’s icon, e.g. :robot_face: or https://example.com/image.png

SlackThread

(Appears on: SlackTrigger)

Field	Description
messageAggregationKey string	(Optional) MessageAggregationKey allows to aggregate the messages to a thread by some key.
broadcastMessageToChannel bool	(Optional) BroadcastMessageToChannel allows to also broadcast the message from the thread to the channel

SlackTrigger

(Appears on: TriggerTemplate)

SlackTrigger refers to the specification of the slack notification trigger.

Field	Description
parameters \[\]TriggerParameter	(Optional) Parameters is the list of key-value extracted from event’s payload that are applied to the trigger resource.
slackToken Kubernetes core/v1.SecretKeySelector	SlackToken refers to the Kubernetes secret that holds the slack token required to send messages.
channel string	(Optional) Channel refers to which Slack channel to send Slack message.
message string	(Optional) Message refers to the message to send to the Slack channel.
attachments string	(Optional) Attachments is a JSON format string that represents an array of Slack attachments according to the attachments API: https://api.slack.com/reference/messaging/attachments .
blocks string	(Optional) Blocks is a JSON format string that represents an array of Slack blocks according to the blocks API: https://api.slack.com/reference/block-kit/blocks .
thread SlackThread	(Optional) Thread refers to additional options for sending messages to a Slack thread.
sender SlackSender	(Optional) Sender refers to additional configuration of the Slack application that sends the message.

StandardK8STrigger

(Appears on: TriggerTemplate)

StandardK8STrigger is the standard Kubernetes resource trigger

Field	Description
source ArtifactLocation	Source of the K8s resource file(s)
operation KubernetesResourceOperation	(Optional) Operation refers to the type of operation performed on the k8s resource. Default value is Create.
parameters \[\]TriggerParameter	Parameters is the list of parameters that is applied to resolved K8s trigger object.
patchStrategy k8s.io/apimachinery/pkg/types.PatchType	(Optional) PatchStrategy controls the K8s object patching strategy when the trigger operation is specified as patch. possible values: “application/json-patch+json” “application/merge-patch+json” “application/strategic-merge-patch+json” “application/apply-patch+yaml”. Defaults to “application/merge-patch+json”
liveObject bool	(Optional) LiveObject specifies whether the resource should be directly fetched from K8s instead of being marshaled from the resource artifact. If set to true, the resource artifact must contain the information required to uniquely identify the resource in the cluster, that is, you must specify “apiVersion”, “kind” as well as “name” and “namespace” meta data. Only valid for operation type update

Status

(Appears on: EventBusStatus, EventSourceStatus, SensorStatus)

Status is a common structure which can be used for Status field.

Field	Description
conditions \[\]Condition	(Optional) Conditions are the latest available observations of a resource’s current state.

StatusPolicy

(Appears on: TriggerPolicy)

StatusPolicy refers to the policy used to check the state of the trigger using response status

Field	Description
allow \[\]int32

StorageGridEventSource

(Appears on: EventSourceSpec)

StorageGridEventSource refers to event-source for StorageGrid related events

Field	Description
webhook WebhookContext	Webhook holds configuration for a REST endpoint
events \[\]string
filter StorageGridFilter	Filter on object key which caused the notification.
topicArn string	TopicArn
bucket string	Name of the bucket to register notifications for.
region string	(Optional) S3 region. Defaults to us-east-1
authToken Kubernetes core/v1.SecretKeySelector	Auth token for storagegrid api
apiURL string	APIURL is the url of the storagegrid api.
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.

StorageGridFilter

(Appears on: StorageGridEventSource)

StorageGridFilter represents filters to apply to bucket notifications for specifying constraints on objects

Field	Description
prefix string
suffix string

StripeEventSource

(Appears on: EventSourceSpec)

StripeEventSource describes the event source for stripe webhook notifications More info at https://stripe.com/docs/webhooks

Field	Description
webhook WebhookContext	Webhook holds configuration for a REST endpoint
createWebhook bool	(Optional) CreateWebhook if specified creates a new webhook programmatically.
apiKey Kubernetes core/v1.SecretKeySelector	(Optional) APIKey refers to K8s secret that holds Stripe API key. Used only if CreateWebhook is enabled.
eventFilter \[\]string	(Optional) EventFilter describes the type of events to listen to. If not specified, all types of events will be processed. More info at https://stripe.com/docs/api/events/list
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.

TLSConfig

(Appears on: AMQPEventSource, AzureServiceBusEventSource, AzureServiceBusTrigger, BitbucketServerEventSource, EmitterEventSource, HTTPTrigger, JetStreamConfig, KafkaBus, KafkaEventSource, KafkaTrigger, MQTTEventSource, NATSEventsSource, NATSTrigger, NSQEventSource, PulsarEventSource, PulsarTrigger, RedisEventSource, RedisStreamEventSource)

TLSConfig refers to TLS configuration for a client.

Field	Description
caCertSecret Kubernetes core/v1.SecretKeySelector	CACertSecret refers to the secret that contains the CA cert
clientCertSecret Kubernetes core/v1.SecretKeySelector	ClientCertSecret refers to the secret that contains the client cert
clientKeySecret Kubernetes core/v1.SecretKeySelector	ClientKeySecret refers to the secret that contains the client key
insecureSkipVerify bool	(Optional) If true, skips creation of TLSConfig with certs and creates an empty TLSConfig. (Defaults to false)

Template

(Appears on: EventSourceSpec, SensorSpec)

Template holds the information of a deployment template

Field	Description
metadata Metadata	Metadata sets the pods’s metadata, i.e. annotations and labels
serviceAccountName string	(Optional) ServiceAccountName is the name of the ServiceAccount to use to run sensor pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
container Kubernetes core/v1.Container	(Optional) Container is the main container image to run in the sensor pod
volumes \[\]Kubernetes core/v1.Volume	(Optional) Volumes is a list of volumes that can be mounted by containers in a workflow.
securityContext Kubernetes core/v1.PodSecurityContext	(Optional) SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
nodeSelector map\[string\]string	(Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
tolerations \[\]Kubernetes core/v1.Toleration	(Optional) If specified, the pod’s tolerations.
imagePullSecrets \[\]Kubernetes core/v1.LocalObjectReference	(Optional) 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. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
priorityClassName string	(Optional) If specified, indicates the EventSource pod’s priority. “system-node-critical” and “system-cluster-critical” are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
priority int32	(Optional) The priority value. Various system components use this field to find the priority of the EventSource pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/
affinity Kubernetes core/v1.Affinity	(Optional) If specified, the pod’s scheduling constraints

TimeFilter

(Appears on: EventDependencyFilter)

TimeFilter describes a window in time. It filters out events that occur outside the time limits. In other words, only events that occur after Start and before Stop will pass this filter.

Field	Description
start string	Start is the beginning of a time window in UTC. Before this time, events for this dependency are ignored. Format is hh:mm:ss.
stop string	Stop is the end of a time window in UTC. After or equal to this time, events for this dependency are ignored and Format is hh:mm:ss. If it is smaller than Start, it is treated as next day of Start (e.g.: 22:00:00-01:00:00 means 22:00:00-25:00:00).

Trigger

(Appears on: SensorSpec, Trigger)

Trigger is an action taken, output produced, an event created, a message sent

Field	Description
template TriggerTemplate	Template describes the trigger specification.
parameters \[\]TriggerParameter	Parameters is the list of parameters applied to the trigger template definition
policy TriggerPolicy	(Optional) Policy to configure backoff and execution criteria for the trigger
retryStrategy Backoff	(Optional) Retry strategy, defaults to no retry
rateLimit RateLimit	(Optional) Rate limit, default unit is Second
atLeastOnce bool	(Optional) AtLeastOnce determines the trigger execution semantics. Defaults to false. Trigger execution will use at-most-once semantics. If set to true, Trigger execution will switch to at-least-once semantics.
dlqTrigger Trigger	(Optional) If the trigger fails, it will retry up to the configured number of retries. If the maximum retries are reached and the trigger is set to execute atLeastOnce, the dead letter queue (DLQ) trigger will be invoked if specified. Invoking the dead letter queue trigger helps prevent data loss.

TriggerParameter

(Appears on: AWSLambdaTrigger, ArgoWorkflowTrigger, AzureEventHubsTrigger, AzureServiceBusTrigger, CustomTrigger, EmailTrigger, HTTPTrigger, KafkaTrigger, NATSTrigger, OpenWhiskTrigger, PulsarTrigger, SlackTrigger, StandardK8STrigger, Trigger)

TriggerParameter indicates a passed parameter to a service template

Field	Description
src TriggerParameterSource	Src contains a source reference to the value of the parameter from a dependency
dest string	Dest is the JSONPath of a resource key. A path is a series of keys separated by a dot. The colon character can be escaped with ‘.’ The -1 key can be used to append a value to an existing array. See https://github.com/tidwall/sjson#path-syntax for more information about how this is used.
operation TriggerParameterOperation	Operation is what to do with the existing value at Dest, whether to ‘prepend’, ‘overwrite’, or ‘append’ it.

TriggerParameterOperation (string alias)

(Appears on: TriggerParameter)

TriggerParameterOperation represents how to set a trigger destination resource key

TriggerParameterSource

(Appears on: TriggerParameter)

TriggerParameterSource defines the source for a parameter from a event event

Field	Description
dependencyName string	DependencyName refers to the name of the dependency. The event which is stored for this dependency is used as payload for the parameterization. Make sure to refer to one of the dependencies you have defined under Dependencies list.
contextKey string	ContextKey is the JSONPath of the event’s (JSON decoded) context key ContextKey is a series of keys separated by a dot. A key may contain wildcard characters ‘\*’ and ‘?’. To access an array value use the index as the key. The dot and wildcard characters can be escaped with ‘’. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
contextTemplate string	ContextTemplate is a go-template for extracting a string from the event’s context. If a ContextTemplate is provided with a ContextKey, the template will be evaluated first and fallback to the ContextKey. The templating follows the standard go-template syntax as well as sprig’s extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/
dataKey string	DataKey is the JSONPath of the event’s (JSON decoded) data key DataKey is a series of keys separated by a dot. A key may contain wildcard characters ‘\*’ and ‘?’. To access an array value use the index as the key. The dot and wildcard characters can be escaped with ‘’. See https://github.com/tidwall/gjson#path-syntax for more information on how to use this.
dataTemplate string	DataTemplate is a go-template for extracting a string from the event’s data. If a DataTemplate is provided with a DataKey, the template will be evaluated first and fallback to the DataKey. The templating follows the standard go-template syntax as well as sprig’s extra functions. See https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/
value string	Value is the default literal value to use for this parameter source This is only used if the DataKey is invalid. If the DataKey is invalid and this is not defined, this param source will produce an error.
useRawData bool	(Optional) UseRawData indicates if the value in an event at data key should be used without converting to string. When true, a number, boolean, json or string parameter may be extracted. When the field is unspecified, or explicitly false, the behavior is to turn the extracted field into a string. (e.g. when set to true, the parameter 123 will resolve to the numerical type, but when false, or not provided, the string “123” will be resolved)

TriggerPolicy

(Appears on: Trigger)

TriggerPolicy dictates the policy for the trigger retries

Field	Description
k8s K8SResourcePolicy	K8SResourcePolicy refers to the policy used to check the state of K8s based triggers using using labels
status StatusPolicy	Status refers to the policy used to check the state of the trigger using response status

TriggerTemplate

(Appears on: Trigger)

TriggerTemplate is the template that describes trigger specification.

Field	Description
name string	Name is a unique name of the action to take.
conditions string	(Optional) Conditions is the conditions to execute the trigger. For example: “(dep01 \|\| dep02) && dep04”
k8s StandardK8STrigger	(Optional) StandardK8STrigger refers to the trigger designed to create or update a generic Kubernetes resource.
argoWorkflow ArgoWorkflowTrigger	(Optional) ArgoWorkflow refers to the trigger that can perform various operations on an Argo workflow.
http HTTPTrigger	(Optional) HTTP refers to the trigger designed to dispatch a HTTP request with on-the-fly constructable payload.
awsLambda AWSLambdaTrigger	(Optional) AWSLambda refers to the trigger designed to invoke AWS Lambda function with with on-the-fly constructable payload.
custom CustomTrigger	(Optional) CustomTrigger refers to the trigger designed to connect to a gRPC trigger server and execute a custom trigger.
kafka KafkaTrigger	Kafka refers to the trigger designed to place messages on Kafka topic.
nats NATSTrigger	NATS refers to the trigger designed to place message on NATS subject.
slack SlackTrigger	(Optional) Slack refers to the trigger designed to send slack notification message.
openWhisk OpenWhiskTrigger	(Optional) OpenWhisk refers to the trigger designed to invoke OpenWhisk action.
log LogTrigger	(Optional) Log refers to the trigger designed to invoke log the event.
azureEventHubs AzureEventHubsTrigger	(Optional) AzureEventHubs refers to the trigger send an event to an Azure Event Hub.
pulsar PulsarTrigger	(Optional) Pulsar refers to the trigger designed to place messages on Pulsar topic.
conditionsReset \[\]ConditionsResetCriteria	(Optional) Criteria to reset the conditons
azureServiceBus AzureServiceBusTrigger	(Optional) AzureServiceBus refers to the trigger designed to place messages on Azure Service Bus
email EmailTrigger	(Optional) Email refers to the trigger designed to send an email notification

TriggerType (string alias)

TriggerType is the type of trigger

Type (int64 alias)

(Appears on: Int64OrString)

Type represents the stored type of Int64OrString.

URLArtifact

(Appears on: ArtifactLocation)

URLArtifact contains information about an artifact at an http endpoint.

Field	Description
path string	Path is the complete URL
verifyCert bool	VerifyCert decides whether the connection is secure or not

ValueFromSource

(Appears on: SecureHeader)

ValueFromSource allows you to reference keys from either a Configmap or Secret

Field	Description
secretKeyRef Kubernetes core/v1.SecretKeySelector
configMapKeyRef Kubernetes core/v1.ConfigMapKeySelector

WatchPathConfig

(Appears on: FileEventSource, HDFSEventSource, SFTPEventSource)

Field	Description
directory string	Directory to watch for events
path string	Path is relative path of object to watch with respect to the directory
pathRegexp string	PathRegexp is regexp of relative path of object to watch with respect to the directory

WebhookContext

(Appears on: BitbucketEventSource, BitbucketServerEventSource, GerritEventSource, GithubEventSource, GitlabEventSource, SNSEventSource, SlackEventSource, StorageGridEventSource, StripeEventSource, WebhookEventSource)

WebhookContext holds a general purpose REST API context

Field	Description
endpoint string	REST API endpoint
method string	Method is HTTP request method that indicates the desired action to be performed for a given resource. See RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
port string	Port on which HTTP server is listening for incoming events.
url string	URL is the url of the server.
serverCertSecret Kubernetes core/v1.SecretKeySelector	ServerCertPath refers the file that contains the cert.
serverKeySecret Kubernetes core/v1.SecretKeySelector	ServerKeyPath refers the file that contains private key
metadata map\[string\]string	(Optional) Metadata holds the user defined metadata which will passed along the event payload.
authSecret Kubernetes core/v1.SecretKeySelector	(Optional) AuthSecret holds a secret selector that contains a bearer token for authentication
maxPayloadSize int64	(Optional) MaxPayloadSize is the maximum webhook payload size that the server will accept. Requests exceeding that limit will be rejected with “request too large” response. Default value: 1048576 (1MB).

WebhookEventSource

(Appears on: EventSourceSpec)

CalendarEventSource describes an HTTP based EventSource

Field	Description
WebhookContext WebhookContext	(Members of WebhookContext are embedded into this type.)
filter EventSourceFilter	(Optional) Filter

---

Generated with gen-crd-api-reference-docs.