Hera Events Auto-generated Models
hera.events.models
AMQPConsumeConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auto_ack
class-attribute
auto_ack: Optional[bool] = Field(None, alias='autoAck', title='AutoAck when true, the server will acknowledge deliveries to this consumer prior to writing\nthe delivery to the network\n+optional')
consumer_tag
class-attribute
consumer_tag: Optional[str] = Field(None, alias='consumerTag', title='ConsumerTag is the identity of the consumer included in every delivery\n+optional')
exclusive
class-attribute
exclusive: Optional[bool] = Field(None, title='Exclusive when true, the server will ensure that this is the sole consumer from this queue\n+optional')
AMQPEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth
class-attribute
auth: Optional[BasicAuth] = Field(None, title='Auth hosts secret selectors for username and password\n+optional')
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
consume
class-attribute
consume: Optional[AMQPConsumeConfig] = Field(None, title='Consume holds the configuration to immediately starts delivering queued messages\nFor more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.Consume\n+optional')
exchange_declare
class-attribute
exchange_declare: Optional[AMQPExchangeDeclareConfig] = Field(None, alias='exchangeDeclare', title='ExchangeDeclare holds the configuration for the exchange on the server\nFor more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.ExchangeDeclare\n+optional')
exchange_name
class-attribute
exchange_name: Optional[str] = Field(None, alias='exchangeName', title='ExchangeName is the exchange name\nFor more information, visit https://www.rabbitmq.com/tutorials/amqp-concepts.html')
exchange_type
class-attribute
exchange_type: Optional[str] = Field(None, alias='exchangeType', title='ExchangeType is rabbitmq exchange type')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
queue_bind
class-attribute
queue_bind: Optional[AMQPQueueBindConfig] = Field(None, alias='queueBind', title='QueueBind holds the configuration that binds an exchange to a queue so that publishings to the\nexchange will be routed to the queue when the publishing routing key matches the binding routing key\nFor more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueBind\n+optional')
queue_declare
class-attribute
queue_declare: Optional[AMQPQueueDeclareConfig] = Field(None, alias='queueDeclare', title="QueueDeclare holds the configuration of a queue to hold messages and deliver to consumers.\nDeclaring creates a queue if it doesn't already exist, or ensures that an existing queue matches\nthe same parameters\nFor more information, visit https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Channel.QueueDeclare\n+optional")
routing_key
class-attribute
tls
class-attribute
AMQPExchangeDeclareConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auto_delete
class-attribute
auto_delete: Optional[bool] = Field(None, alias='autoDelete', title='AutoDelete removes the exchange when no bindings are active\n+optional')
durable
class-attribute
durable: Optional[bool] = Field(None, title='Durable keeps the exchange also after the server restarts\n+optional')
AMQPQueueBindConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
AMQPQueueDeclareConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
arguments
class-attribute
arguments: Optional[str] = Field(None, title='Arguments of a queue (also known as "x-arguments") used for optional features and plugins\n+optional')
auto_delete
class-attribute
auto_delete: Optional[bool] = Field(None, alias='autoDelete', title='AutoDelete removes the queue when no consumers are active\n+optional')
durable
class-attribute
durable: Optional[bool] = Field(None, title='Durable keeps the queue also after the server restarts\n+optional')
exclusive
class-attribute
exclusive: Optional[bool] = Field(None, title='Exclusive sets the queues to be accessible only by the connection that declares them and will be\ndeleted wgen the connection closes\n+optional')
AWSLambdaTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
access_key: Optional[v1.SecretKeySelector] = Field(None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key\n+optional')
function_name
class-attribute
function_name: Optional[str] = Field(None, alias='functionName', description='FunctionName refers to the name of the function to invoke.')
invocation_type
class-attribute
invocation_type: Optional[str] = Field(None, alias='invocationType', description="Choose from the following options.\n\n * RequestResponse (default) - Invoke the function synchronously. Keep\n the connection open until the function returns a response or times out.\n The API response includes the function response and additional data.\n\n * Event - Invoke the function asynchronously. Send events that fail multiple\n times to the function's dead-letter queue (if it's configured). The API\n response only includes a status code.\n\n * DryRun - Validate parameter values and verify that the user or role\n has permission to invoke the function.\n+optional")
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, title="Parameters is the list of key-value extracted from event's payload that are applied to\nthe trigger resource.\n+optional")
payload
class-attribute
payload: Optional[List[TriggerParameter]] = Field(None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
Amount
ArgoWorkflowTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
args
class-attribute
args: Optional[List[str]] = Field(None, title='Args is the list of arguments to pass to the argo CLI')
operation
class-attribute
operation: Optional[str] = Field(None, title='Operation refers to the type of operation performed on the argo workflow resource.\nDefault value is Submit.\n+optional')
ArtifactLocation
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
AzureEventHubsTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
fqdn
class-attribute
fqdn: Optional[str] = Field(None, title='FQDN refers to the namespace dns of Azure Event Hubs to be used i.e. <namespace>.servicebus.windows.net')
hub_name
class-attribute
hub_name: Optional[str] = Field(None, alias='hubName', title='HubName refers to the Azure Event Hub to send events to')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, title="Parameters is the list of key-value extracted from event's payload that are applied to\nthe trigger resource.\n+optional")
payload
class-attribute
payload: Optional[List[TriggerParameter]] = Field(None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
AzureEventsHubEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
fqdn
class-attribute
fqdn: Optional[str] = Field(None, title='FQDN of the EventHubs namespace you created\nMore info at https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string')
hub_name
class-attribute
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
Backoff
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
duration
class-attribute
duration: Optional[Int64OrString] = Field(None, title='The initial duration in nanoseconds or strings like "1s", "3m"\n+optional')
factor
class-attribute
factor: Optional[Amount] = Field(None, title='Duration is multiplied by factor each iteration\n+optional')
BasicAuth
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
BitbucketAuth
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
BitbucketBasicAuth
BitbucketEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth
class-attribute
auth: Optional[BitbucketAuth] = Field(None, description='Auth information required to connect to Bitbucket.')
delete_hook_on_finish
class-attribute
delete_hook_on_finish: Optional[bool] = Field(None, alias='deleteHookOnFinish', title='DeleteHookOnFinish determines whether to delete the defined Bitbucket hook once the event source is stopped.\n+optional')
events
class-attribute
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will be passed along the event payload.\n+optional')
owner
class-attribute
owner: Optional[str] = Field(None, title='DeprecatedOwner is the owner of the repository.\nDeprecated: use Repositories instead. Will be unsupported in v1.9\n+optional')
project_key
class-attribute
project_key: Optional[str] = Field(None, alias='projectKey', title='DeprecatedProjectKey is the key of the project to which the repository relates\nDeprecated: use Repositories instead. Will be unsupported in v1.9\n+optional')
repositories
class-attribute
repositories: Optional[List[BitbucketRepository]] = Field(None, title='Repositories holds a list of repositories for which integration needs to set up\n+optional')
repository_slug
class-attribute
repository_slug: Optional[str] = Field(None, alias='repositorySlug', title='DeprecatedRepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL\nDeprecated: use Repositories instead. Will be unsupported in v1.9\n+optional')
BitbucketRepository
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
owner
class-attribute
BitbucketServerEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_token
class-attribute
access_token: Optional[v1.SecretKeySelector] = Field(None, alias='accessToken', title='AccessToken is reference to K8s secret which holds the bitbucket api access information')
bitbucketserver_base_url
class-attribute
bitbucketserver_base_url: Optional[str] = Field(None, alias='bitbucketserverBaseURL', title='BitbucketServerBaseURL is the base URL for API requests to a custom endpoint')
delete_hook_on_finish
class-attribute
delete_hook_on_finish: Optional[bool] = Field(None, alias='deleteHookOnFinish', title='DeleteHookOnFinish determines whether to delete the Bitbucket Server hook for the project once the event source is stopped.\n+optional')
events
class-attribute
events: Optional[List[str]] = Field(None, title='Events are bitbucket event to listen to.\nRefer https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_key
class-attribute
project_key: Optional[str] = Field(None, alias='projectKey', title='DeprecatedProjectKey is the key of project for which integration needs to set up\nDeprecated: use Repositories instead. Will be unsupported in v1.8\n+optional')
repositories
class-attribute
repositories: Optional[List[BitbucketServerRepository]] = Field(None, title='Repositories holds a list of repositories for which integration needs to set up\n+optional')
repository_slug
class-attribute
repository_slug: Optional[str] = Field(None, alias='repositorySlug', title='DeprecatedRepositorySlug is the slug of the repository for which integration needs to set up\nDeprecated: use Repositories instead. Will be unsupported in v1.8\n+optional')
BitbucketServerRepository
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
CalendarEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
exclusion_dates
class-attribute
exclusion_dates: Optional[List[str]] = Field(None, alias='exclusionDates', description='ExclusionDates defines the list of DATE-TIME exceptions for recurring events.')
interval
class-attribute
interval: Optional[str] = Field(None, title='Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h...\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
persistence
class-attribute
persistence: Optional[EventPersistence] = Field(None, title='Persistence hold the configuration for event persistence')
CatchupConfiguration
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
Condition
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
last_transition_time
class-attribute
last_transition_time: Optional[v1_1.Time] = Field(None, alias='lastTransitionTime', title='Last time the condition transitioned from one status to another.\n+optional')
message
class-attribute
message: Optional[str] = Field(None, title='Human-readable message indicating details about last transition.\n+optional')
reason
class-attribute
reason: Optional[str] = Field(None, title='Unique, this should be a short, machine understandable string that gives the reason\nfor condition\'s last transition. For example, "ImageNotFound"\n+optional')
status
class-attribute
ConditionsResetByTime
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
ConditionsResetCriteria
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
ConfigMapPersistence
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
CustomTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
cert_secret
class-attribute
cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias='certSecret', description='CertSecret refers to the secret that contains cert for secure connection between sensor and custom trigger gRPC server.')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, description='Parameters is the list of parameters that is applied to resolved custom trigger trigger object.')
payload
class-attribute
payload: Optional[List[TriggerParameter]] = Field(None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
secure
class-attribute
secure: Optional[bool] = Field(None, title='Secure refers to type of the connection between sensor to custom trigger gRPC')
server_name_override
class-attribute
server_name_override: Optional[str] = Field(None, alias='serverNameOverride', description='ServerNameOverride for the secure connection between sensor and custom trigger gRPC server.')
DataFilter
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
comparator
class-attribute
comparator: Optional[str] = Field(None, description='Comparator compares the event data with a user given value.\nCan be ">=", ">", "=", "!=", "<", or "<=".\nIs optional, and if left blank treated as equality "=".')
path
class-attribute
path: Optional[str] = Field(None, description="Path is the JSONPath of the event's (JSON decoded) data key\nPath is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.")
template
class-attribute
template: Optional[str] = Field(None, title="Template is a go-template for extracting a string from the event's data.\nA Template is evaluated with provided path, type and value.\nThe templating follows the standard go-template syntax as well as sprig's extra functions.\nSee https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/")
type
class-attribute
EmitterEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
channel_key
class-attribute
channel_key: Optional[str] = Field(None, alias='channelKey', title='ChannelKey refers to the channel key')
channel_name
class-attribute
channel_name: Optional[str] = Field(None, alias='channelName', title='ChannelName refers to the channel name')
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
password
class-attribute
password: Optional[v1.SecretKeySelector] = Field(None, title='Password to use to connect to broker\n+optional')
EventContext
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
datacontenttype
class-attribute
datacontenttype: Optional[str] = Field(None, description='DataContentType - A MIME (RFC2046) string describing the media type of `data`.')
id
class-attribute
id: Optional[str] = Field(None, description='ID of the event; must be non-empty and unique within the scope of the producer.')
source
class-attribute
specversion
class-attribute
specversion: Optional[str] = Field(None, description='SpecVersion - The version of the CloudEvents specification used by the io.argoproj.workflow.v1alpha1.')
subject
class-attribute
subject: Optional[str] = Field(None, title='Subject - The subject of the event in the context of the event producer')
time
class-attribute
EventDependency
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
event_name
class-attribute
event_name: Optional[str] = Field(None, alias='eventName', title='EventName is the name of the event')
event_source_name
class-attribute
event_source_name: Optional[str] = Field(None, alias='eventSourceName', title='EventSourceName is the name of EventSource that Sensor depends on')
filters
class-attribute
filters: Optional[EventDependencyFilter] = Field(None, title='Filters and rules governing toleration of success and constraints on the context and data of an event')
filters_logical_operator
class-attribute
filters_logical_operator: Optional[str] = Field(None, alias='filtersLogicalOperator', description='FiltersLogicalOperator defines how different filters are evaluated together.\nAvailable values: and (&&), or (||)\nIs optional and if left blank treated as and (&&).')
name
class-attribute
EventDependencyFilter
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
context
class-attribute
data
class-attribute
data_logical_operator
class-attribute
data_logical_operator: Optional[str] = Field(None, alias='dataLogicalOperator', description='DataLogicalOperator defines how multiple Data filters (if defined) are evaluated together.\nAvailable values: and (&&), or (||)\nIs optional and if left blank treated as and (&&).')
expr_logical_operator
class-attribute
expr_logical_operator: Optional[str] = Field(None, alias='exprLogicalOperator', description='ExprLogicalOperator defines how multiple Exprs filters (if defined) are evaluated together.\nAvailable values: and (&&), or (||)\nIs optional and if left blank treated as and (&&).')
exprs
class-attribute
exprs: Optional[List[ExprFilter]] = Field(None, description='Exprs contains the list of expressions evaluated against the event payload.')
EventDependencyTransformer
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
EventPersistence
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
EventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
EventSourceFilter
EventSourceList
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
EventSourceSpec
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
amqp
class-attribute
azure_events_hub
class-attribute
azure_events_hub: Optional[Dict[str, AzureEventsHubEventSource]] = Field(None, alias='azureEventsHub', title='AzureEventsHub event sources')
bitbucket
class-attribute
bitbucketserver
class-attribute
bitbucketserver: Optional[Dict[str, BitbucketServerEventSource]] = Field(None, title='Bitbucket Server event sources')
calendar
class-attribute
emitter
class-attribute
event_bus_name
class-attribute
event_bus_name: Optional[str] = Field(None, alias='eventBusName', title='EventBusName references to a EventBus name. By default the value is "default"')
file
class-attribute
generic
class-attribute
github
class-attribute
gitlab
class-attribute
hdfs
class-attribute
kafka
class-attribute
minio
class-attribute
mqtt
class-attribute
nats
class-attribute
nsq
class-attribute
pub_sub
class-attribute
pub_sub: Optional[Dict[str, PubSubEventSource]] = Field(None, alias='pubSub', title='PubSub event sources')
pulsar
class-attribute
redis
class-attribute
redis_stream
class-attribute
redis_stream: Optional[Dict[str, RedisStreamEventSource]] = Field(None, alias='redisStream', title='Redis stream source')
replicas
class-attribute
resource
class-attribute
service
class-attribute
service: Optional[Service] = Field(None, title='Service is the specifications of the service to expose the event source\n+optional')
slack
class-attribute
sns
class-attribute
sqs
class-attribute
storage_grid
class-attribute
storage_grid: Optional[Dict[str, StorageGridEventSource]] = Field(None, alias='storageGrid', title='StorageGrid event sources')
stripe
class-attribute
EventSourceStatus
ExprFilter
FileArtifact
FileEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
event_type
class-attribute
event_type: Optional[str] = Field(None, alias='eventType', title='Type of file operations to watch\nRefer https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more information')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
polling
class-attribute
GenericEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth_secret
class-attribute
auth_secret: Optional[v1.SecretKeySelector] = Field(None, alias='authSecret', title='AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional')
config
class-attribute
insecure
class-attribute
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
GitArtifact
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
branch
class-attribute
clone_directory
class-attribute
clone_directory: Optional[str] = Field(None, alias='cloneDirectory', description="Directory to clone the repository. We clone complete directory because GitArtifact is not limited to any specific Git service providers.\nHence we don't use any specific git provider client.")
creds
class-attribute
creds: Optional[GitCreds] = Field(None, title='Creds contain reference to git username and password\n+optional')
file_path
class-attribute
file_path: Optional[str] = Field(None, alias='filePath', title='Path to file that contains trigger resource definition')
insecure_ignore_host_key
class-attribute
insecure_ignore_host_key: Optional[bool] = Field(None, alias='insecureIgnoreHostKey', title='Whether to ignore host key\n+optional')
ref
class-attribute
ref: Optional[str] = Field(None, title='Ref to use to pull trigger resource. Will result in a shallow clone and\nfetch.\n+optional')
remote
class-attribute
remote: Optional[GitRemoteConfig] = Field(None, title='Remote to manage set of tracked repositories. Defaults to "origin".\nRefer https://git-scm.com/docs/git-remote\n+optional')
ssh_key_secret
class-attribute
ssh_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='sshKeySecret', title='SSHKeySecret refers to the secret that contains SSH key')
tag
class-attribute
GitCreds
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
GitRemoteConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
name
class-attribute
GithubAppCreds
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
app_id
class-attribute
app_id: Optional[str] = Field(None, alias='appID', title='AppID refers to the GitHub App ID for the application you created')
GithubEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 |
|
active
class-attribute
active: Optional[bool] = Field(None, title='Active refers to status of the webhook for event deliveries.\nhttps://developer.github.com/webhooks/creating/#active\n+optional')
api_token
class-attribute
api_token: Optional[v1.SecretKeySelector] = Field(None, alias='apiToken', title='APIToken refers to a K8s secret containing github api token\n+optional')
content_type
class-attribute
content_type: Optional[str] = Field(None, alias='contentType', title='ContentType of the event delivery')
delete_hook_on_finish
class-attribute
delete_hook_on_finish: Optional[bool] = Field(None, alias='deleteHookOnFinish', title='DeleteHookOnFinish determines whether to delete the GitHub hook for the repository once the event source is stopped.\n+optional')
events
class-attribute
events: Optional[List[str]] = Field(None, title='Events refer to Github events to which the event source will subscribe')
github_app
class-attribute
github_app: Optional[GithubAppCreds] = Field(None, alias='githubApp', title='GitHubApp holds the GitHub app credentials\n+optional')
github_base_url
class-attribute
github_base_url: Optional[str] = Field(None, alias='githubBaseURL', title='GitHub base URL (for GitHub Enterprise)\n+optional')
github_upload_url
class-attribute
github_upload_url: Optional[str] = Field(None, alias='githubUploadURL', title='GitHub upload URL (for GitHub Enterprise)\n+optional')
id
class-attribute
id: Optional[str] = Field(None, title="Id is the webhook's id\nDeprecated: This is not used at all, will be removed in v1.6\n+optional")
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
organizations
class-attribute
organizations: Optional[List[str]] = Field(None, description='Organizations holds the names of organizations (used for organization level webhooks). Not required if Repositories is set.')
owner
class-attribute
owner: Optional[str] = Field(None, title='DeprecatedOwner refers to GitHub owner name i.e. argoproj\nDeprecated: use Repositories instead. Will be unsupported in v 1.6\n+optional')
repositories
class-attribute
repositories: Optional[List[OwnedRepositories]] = Field(None, description='Repositories holds the information of repositories, which uses repo owner as the key,\nand list of repo names as the value. Not required if Organizations is set.')
repository
class-attribute
repository: Optional[str] = Field(None, title='DeprecatedRepository refers to GitHub repo name i.e. argo-events\nDeprecated: use Repositories instead. Will be unsupported in v 1.6\n+optional')
GitlabEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_token
class-attribute
access_token: Optional[v1.SecretKeySelector] = Field(None, alias='accessToken', title='AccessToken references to k8 secret which holds the gitlab api access information')
delete_hook_on_finish
class-attribute
delete_hook_on_finish: Optional[bool] = Field(None, alias='deleteHookOnFinish', title='DeleteHookOnFinish determines whether to delete the GitLab hook for the project once the event source is stopped.\n+optional')
enable_ssl_verification
class-attribute
enable_ssl_verification: Optional[bool] = Field(None, alias='enableSSLVerification', title='EnableSSLVerification to enable ssl verification\n+optional')
events
class-attribute
events: Optional[List[str]] = Field(None, description='Events are gitlab event to listen to.\nRefer https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794.')
gitlab_base_url
class-attribute
gitlab_base_url: Optional[str] = Field(None, alias='gitlabBaseURL', title='GitlabBaseURL is the base URL for API requests to a custom endpoint')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_id
class-attribute
project_id: Optional[str] = Field(None, alias='projectID', title='DeprecatedProjectID is the id of project for which integration needs to setup\nDeprecated: use Projects instead. Will be unsupported in v 1.7\n+optional')
projects
class-attribute
projects: Optional[List[str]] = Field(None, title='List of project IDs or project namespace paths like "whynowy/test"')
HDFSEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
check_interval
class-attribute
check_interval: Optional[str] = Field(None, alias='checkInterval', title='CheckInterval is a string that describes an interval duration to check the directory state, e.g. 1s, 30m, 2h... (defaults to 1m)')
hdfs_user
class-attribute
hdfs_user: Optional[str] = Field(None, alias='hdfsUser', description='HDFSUser is the user to access HDFS file system.\nIt is ignored if either ccache or keytab is used.')
krb_c_cache_secret
class-attribute
krb_c_cache_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbCCacheSecret', description='KrbCCacheSecret is the secret selector for Kerberos ccache\nEither ccache or keytab can be set to use Kerberos.')
krb_config_config_map
class-attribute
krb_config_config_map: Optional[v1.ConfigMapKeySelector] = Field(None, alias='krbConfigConfigMap', description='KrbConfig is the configmap selector for Kerberos config as string\nIt must be set if either ccache or keytab is used.')
krb_keytab_secret
class-attribute
krb_keytab_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbKeytabSecret', description='KrbKeytabSecret is the secret selector for Kerberos keytab\nEither ccache or keytab can be set to use Kerberos.')
krb_realm
class-attribute
krb_realm: Optional[str] = Field(None, alias='krbRealm', description='KrbRealm is the Kerberos realm used with Kerberos keytab\nIt must be set if keytab is used.')
krb_service_principal_name
class-attribute
krb_service_principal_name: Optional[str] = Field(None, alias='krbServicePrincipalName', description='KrbServicePrincipalName is the principal name of Kerberos service\nIt must be set if either ccache or keytab is used.')
krb_username
class-attribute
krb_username: Optional[str] = Field(None, alias='krbUsername', description='KrbUsername is the Kerberos username used with Kerberos keytab\nIt must be set if keytab is used.')
HTTPTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
basic_auth
class-attribute
basic_auth: Optional[BasicAuth] = Field(None, alias='basicAuth', title='BasicAuth configuration for the http request.\n+optional')
headers
class-attribute
method
class-attribute
method: Optional[str] = Field(None, title='Method refers to the type of the HTTP request.\nRefer https://golang.org/src/net/http/method.go for more io.argoproj.workflow.v1alpha1.\nDefault value is POST.\n+optional')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, description="Parameters is the list of key-value extracted from event's payload that are applied to\nthe HTTP trigger resource.")
secure_headers
class-attribute
secure_headers: Optional[List[SecureHeader]] = Field(None, alias='secureHeaders', title='Secure Headers stored in Kubernetes Secrets for the HTTP requests.\n+optional')
timeout
class-attribute
timeout: Optional[str] = Field(None, title='Timeout refers to the HTTP request timeout in seconds.\nDefault value is 60 seconds.\n+optional')
tls
class-attribute
Int64OrString
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
K8SResourcePolicy
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
backoff
class-attribute
KafkaConsumerGroup
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
group_name
class-attribute
group_name: Optional[str] = Field(None, alias='groupName', title='The name for the consumer group to use')
KafkaEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
config
class-attribute
config: Optional[str] = Field(None, description='Yaml format Sarama config for Kafka connection.\nIt follows the struct of sarama.Config. See https://github.com/Shopify/sarama/blob/main/config.go\ne.g.\n\nconsumer:\n fetch:\n min: 1\nnet:\n MaxOpenRequests: 5\n\n+optional')
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', description='Backoff holds parameters applied to connection.')
consumer_group
class-attribute
consumer_group: Optional[KafkaConsumerGroup] = Field(None, alias='consumerGroup', title='Consumer group for kafka client\n+optional')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
limit_events_per_second
class-attribute
limit_events_per_second: Optional[str] = Field(None, alias='limitEventsPerSecond', title='Sets a limit on how many events get read from kafka per second.\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
sasl
class-attribute
sasl: Optional[SASLConfig] = Field(None, title='SASL configuration for the kafka client\n+optional')
tls
class-attribute
url
class-attribute
KafkaTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
compress
class-attribute
compress: Optional[bool] = Field(None, title='Compress determines whether to compress message or not.\nDefaults to false.\nIf set to true, compresses message using snappy compression.\n+optional')
flush_frequency
class-attribute
flush_frequency: Optional[int] = Field(None, alias='flushFrequency', title='FlushFrequency refers to the frequency in milliseconds to flush batches.\nDefaults to 500 milliseconds.\n+optional')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, description='Parameters is the list of parameters that is applied to resolved Kafka trigger object.')
partition
class-attribute
partitioning_key
class-attribute
partitioning_key: Optional[str] = Field(None, alias='partitioningKey', description='The partitioning key for the messages put on the Kafka topic.\nDefaults to broker url.\n+optional.')
payload
class-attribute
payload: Optional[List[TriggerParameter]] = Field(None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
required_acks
class-attribute
required_acks: Optional[int] = Field(None, alias='requiredAcks', description='RequiredAcks used in producer to tell the broker how many replica acknowledgements\nDefaults to 1 (Only wait for the leader to ack).\n+optional.')
sasl
class-attribute
sasl: Optional[SASLConfig] = Field(None, title='SASL configuration for the kafka client\n+optional')
tls
class-attribute
tls: Optional[TLSConfig] = Field(None, title='TLS configuration for the Kafka producer.\n+optional')
topic
class-attribute
topic: Optional[str] = Field(None, title='Name of the topic.\nMore info at https://kafka.apache.org/documentation/#intro_topics')
LogTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
MQTTEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
client_id
class-attribute
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', description='ConnectionBackoff holds backoff applied to connection.')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
Metadata
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
NATSAuth
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
NATSEventsSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', description='ConnectionBackoff holds backoff applied to connection.')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
subject
class-attribute
subject: Optional[str] = Field(None, title='Subject holds the name of the subject onto which messages are published')
tls
class-attribute
NATSTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
subject
class-attribute
tls
class-attribute
NSQEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
host_address
class-attribute
host_address: Optional[str] = Field(None, alias='hostAddress', title='HostAddress is the address of the host for NSQ lookup')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
OpenWhiskTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
action_name
class-attribute
action_name: Optional[str] = Field(None, alias='actionName', description='Name of the action/function.')
auth_token
class-attribute
auth_token: Optional[v1.SecretKeySelector] = Field(None, alias='authToken', title='AuthToken for authentication.\n+optional')
namespace
class-attribute
namespace: Optional[str] = Field(None, description='Namespace for the action.\nDefaults to "_".\n+optional.')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, title="Parameters is the list of key-value extracted from event's payload that are applied to\nthe trigger resource.\n+optional")
OwnedRepositories
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
PayloadField
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
name
class-attribute
path
class-attribute
path: Optional[str] = Field(None, description="Path is the JSONPath of the event's (JSON decoded) data key\nPath is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.")
PubSubEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
credential_secret
class-attribute
credential_secret: Optional[v1.SecretKeySelector] = Field(None, alias='credentialSecret', title='CredentialSecret references to the secret that contains JSON credentials to access GCP.\nIf it is missing, it implicitly uses Workload Identity to access.\nhttps://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity\n+optional')
delete_subscription_on_finish
class-attribute
delete_subscription_on_finish: Optional[bool] = Field(None, alias='deleteSubscriptionOnFinish', title='DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub subscription once the event source is stopped.\n+optional')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_id
class-attribute
project_id: Optional[str] = Field(None, alias='projectID', title='ProjectID is GCP project ID for the subscription.\nRequired if you run Argo Events outside of GKE/GCE.\n(otherwise, the default value is its project)\n+optional')
subscription_id
class-attribute
subscription_id: Optional[str] = Field(None, alias='subscriptionID', title='SubscriptionID is ID of subscription.\nRequired if you use existing subscription.\nThe default value will be auto generated hash based on this eventsource setting, so the subscription\nmight be recreated every time you update the setting, which has a possibility of event loss.\n+optional')
topic
class-attribute
topic: Optional[str] = Field(None, title='Topic to which the subscription should belongs.\nRequired if you want the eventsource to create a new subscription.\nIf you specify this field along with an existing subscription,\nit will be verified whether it actually belongs to the specified topic.\n+optional')
PulsarEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth_token_secret
class-attribute
auth_token_secret: Optional[v1.SecretKeySelector] = Field(None, alias='authTokenSecret', title='Authentication token for the pulsar client.\n+optional')
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
tls_allow_insecure_connection
class-attribute
tls_allow_insecure_connection: Optional[bool] = Field(None, alias='tlsAllowInsecureConnection', title='Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional')
tls_trust_certs_secret
class-attribute
tls_trust_certs_secret: Optional[v1.SecretKeySelector] = Field(None, alias='tlsTrustCertsSecret', title='Trusted TLS certificate secret.\n+optional')
tls_validate_hostname
class-attribute
tls_validate_hostname: Optional[bool] = Field(None, alias='tlsValidateHostname', title='Whether the Pulsar client verify the validity of the host name from broker.\n+optional')
topics
class-attribute
PulsarTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth_token_secret
class-attribute
auth_token_secret: Optional[v1.SecretKeySelector] = Field(None, alias='authTokenSecret', title='Authentication token for the pulsar client.\n+optional')
connection_backoff
class-attribute
connection_backoff: Optional[Backoff] = Field(None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, description='Parameters is the list of parameters that is applied to resolved Kafka trigger object.')
payload
class-attribute
payload: Optional[List[TriggerParameter]] = Field(None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
tls
class-attribute
tls_allow_insecure_connection
class-attribute
tls_allow_insecure_connection: Optional[bool] = Field(None, alias='tlsAllowInsecureConnection', title='Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional')
tls_trust_certs_secret
class-attribute
tls_trust_certs_secret: Optional[v1.SecretKeySelector] = Field(None, alias='tlsTrustCertsSecret', title='Trusted TLS certificate secret.\n+optional')
tls_validate_hostname
class-attribute
tls_validate_hostname: Optional[bool] = Field(None, alias='tlsValidateHostname', title='Whether the Pulsar client verify the validity of the host name from broker.\n+optional')
RateLimit
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
RedisEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
db
class-attribute
db: Optional[int] = Field(None, title='DB to use. If not specified, default DB 0 will be used.\n+optional')
host_address
class-attribute
host_address: Optional[str] = Field(None, alias='hostAddress', title='HostAddress refers to the address of the Redis host/server')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
namespace
class-attribute
namespace: Optional[str] = Field(None, title='Namespace to use to retrieve the password from. It should only be specified if password is declared\n+optional')
password
class-attribute
password: Optional[v1.SecretKeySelector] = Field(None, title='Password required for authentication if any.\n+optional')
tls
class-attribute
RedisStreamEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
consumer_group
class-attribute
consumer_group: Optional[str] = Field(None, alias='consumerGroup', title="ConsumerGroup refers to the Redis stream consumer group that will be\ncreated on all redis streams. Messages are read through this group. Defaults to 'argo-events-cg'\n+optional")
db
class-attribute
db: Optional[int] = Field(None, title='DB to use. If not specified, default DB 0 will be used.\n+optional')
host_address
class-attribute
host_address: Optional[str] = Field(None, alias='hostAddress', title='HostAddress refers to the address of the Redis host/server (master instance)')
max_msg_count_per_read
class-attribute
max_msg_count_per_read: Optional[int] = Field(None, alias='maxMsgCountPerRead', title='MaxMsgCountPerRead holds the maximum number of messages per stream that will be read in each XREADGROUP of all streams\nExample: if there are 2 streams and MaxMsgCountPerRead=10, then each XREADGROUP may read upto a total of 20 messages.\nSame as COUNT option in XREADGROUP(https://redis.io/topics/streams-intro). Defaults to 10\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
password
class-attribute
password: Optional[v1.SecretKeySelector] = Field(None, title='Password required for authentication if any.\n+optional')
streams
class-attribute
streams: Optional[List[str]] = Field(None, description='Streams to look for entries. XREADGROUP is used on all streams using a single consumer group.')
tls
class-attribute
Resource
ResourceEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
event_types
class-attribute
event_types: Optional[List[str]] = Field(None, alias='eventTypes', description='EventTypes is the list of event type to watch.\nPossible values are - ADD, UPDATE and DELETE.')
filter
class-attribute
filter: Optional[ResourceFilter] = Field(None, title='Filter is applied on the metadata of the resource\nIf you apply filter, then the internal event informer will only monitor objects that pass the filter.\n+optional')
group_version_resource
class-attribute
group_version_resource: Optional[v1_1.GroupVersionResource] = Field(None, alias='groupVersionResource', title='Group of the resource')
ResourceFilter
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
after_start
class-attribute
after_start: Optional[bool] = Field(None, alias='afterStart', title='If the resource is created after the start time then the event is treated as valid.\n+optional')
created_by
class-attribute
created_by: Optional[v1_1.Time] = Field(None, alias='createdBy', title='If resource is created before the specified time then the event is treated as valid.\n+optional')
fields
class-attribute
fields: Optional[List[Selector]] = Field(None, title='Fields provide field filters similar to K8s field selector\n(see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/).\nUnlike K8s field selector, it supports arbitrary fileds like "spec.serviceAccountName",\nand the value could be a string or a regex.\nSame as K8s field selector, operator "=", "==" and "!=" are supported.\n+optional')
S3Artifact
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
S3Bucket
S3Filter
SASLConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
mechanism
class-attribute
mechanism: Optional[str] = Field(None, title='SASLMechanism is the name of the enabled SASL mechanism.\nPossible values: OAUTHBEARER, PLAIN (defaults to PLAIN).\n+optional')
SNSEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
access_key: Optional[v1.SecretKeySelector] = Field(None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key')
endpoint
class-attribute
endpoint: Optional[str] = Field(None, title='Endpoint configures connection to a specific SNS endpoint instead of Amazons servers\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
role_arn
class-attribute
role_arn: Optional[str] = Field(None, alias='roleARN', title='RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional')
secret_key
class-attribute
secret_key: Optional[v1.SecretKeySelector] = Field(None, alias='secretKey', title='SecretKey refers K8s secret containing aws secret key')
topic_arn
class-attribute
SQSEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
access_key: Optional[v1.SecretKeySelector] = Field(None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key')
dlq
class-attribute
dlq: Optional[bool] = Field(None, title="DLQ specifies if a dead-letter queue is configured for messages that can't be processed successfully.\nIf set to true, messages with invalid payload won't be acknowledged to allow to forward them farther to the dead-letter queue.\nThe default value is false.\n+optional")
endpoint
class-attribute
endpoint: Optional[str] = Field(None, title='Endpoint configures connection to a specific SQS endpoint instead of Amazons servers\n+optional')
json_body
class-attribute
json_body: Optional[bool] = Field(None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
queue
class-attribute
queue_account_id
class-attribute
queue_account_id: Optional[str] = Field(None, alias='queueAccountId', title='QueueAccountID is the ID of the account that created the queue to monitor\n+optional')
role_arn
class-attribute
role_arn: Optional[str] = Field(None, alias='roleARN', title='RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional')
secret_key
class-attribute
secret_key: Optional[v1.SecretKeySelector] = Field(None, alias='secretKey', title='SecretKey refers K8s secret containing aws secret key')
SecureHeader
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
Selector
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
Sensor
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
SensorList
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
SensorSpec
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
dependencies
class-attribute
dependencies: Optional[List[EventDependency]] = Field(None, description='Dependencies is a list of the events that this sensor is dependent on.')
error_on_failed_round
class-attribute
error_on_failed_round: Optional[bool] = Field(None, alias='errorOnFailedRound', description='ErrorOnFailedRound if set to true, marks sensor state as `error` if the previous trigger round fails.\nOnce sensor state is set to `error`, no further triggers will be processed.')
event_bus_name
class-attribute
event_bus_name: Optional[str] = Field(None, alias='eventBusName', title='EventBusName references to a EventBus name. By default the value is "default"')
replicas
class-attribute
SensorStatus
Service
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
cluster_ip
class-attribute
cluster_ip: Optional[str] = Field(None, alias='clusterIP', title='clusterIP is the IP address of the service and is usually assigned\nrandomly by the master. If an address is specified manually and is not in\nuse by others, it will be allocated to the service; otherwise, creation\nof the service will fail. This field can not be changed through updates.\nValid values are "None", empty string (""), or a valid IP address. "None"\ncan be specified for headless services when proxying is not required.\nMore info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies\n+optional')
SlackEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
signing_secret
class-attribute
signing_secret: Optional[v1.SecretKeySelector] = Field(None, alias='signingSecret', title='Slack App signing secret')
token
class-attribute
SlackTrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
channel
class-attribute
channel: Optional[str] = Field(None, title='Channel refers to which Slack channel to send slack message.\n+optional')
message
class-attribute
message: Optional[str] = Field(None, title='Message refers to the message to send to the Slack channel.\n+optional')
StandardK8STrigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
live_object
class-attribute
live_object: Optional[bool] = Field(None, alias='liveObject', title='LiveObject specifies whether the resource should be directly fetched from K8s instead\nof being marshaled from the resource artifact. If set to true, the resource artifact\nmust contain the information required to uniquely identify the resource in the cluster,\nthat is, you must specify "apiVersion", "kind" as well as "name" and "namespace" meta\ndata.\nOnly valid for operation type `update`\n+optional')
operation
class-attribute
operation: Optional[str] = Field(None, title='Operation refers to the type of operation performed on the k8s resource.\nDefault value is Create.\n+optional')
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, description='Parameters is the list of parameters that is applied to resolved K8s trigger object.')
patch_strategy
class-attribute
patch_strategy: Optional[str] = Field(None, alias='patchStrategy', title='PatchStrategy controls the K8s object patching strategy when the trigger operation is specified as patch.\npossible values:\n"application/json-patch+json"\n"application/merge-patch+json"\n"application/strategic-merge-patch+json"\n"application/apply-patch+yaml".\nDefaults to "application/merge-patch+json"\n+optional')
Status
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
StatusPolicy
StorageGridEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
api_url
class-attribute
api_url: Optional[str] = Field(None, alias='apiURL', description='APIURL is the url of the storagegrid api.')
auth_token
class-attribute
auth_token: Optional[v1.SecretKeySelector] = Field(None, alias='authToken', title='Auth token for storagegrid api')
bucket
class-attribute
bucket: Optional[str] = Field(None, description='Name of the bucket to register notifications for.')
filter
class-attribute
filter: Optional[StorageGridFilter] = Field(None, description='Filter on object key which caused the notification.')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
region
class-attribute
topic_arn
class-attribute
StorageGridFilter
StripeEventSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
api_key
class-attribute
api_key: Optional[v1.SecretKeySelector] = Field(None, alias='apiKey', title='APIKey refers to K8s secret that holds Stripe API key. Used only if CreateWebhook is enabled.\n+optional')
create_webhook
class-attribute
create_webhook: Optional[bool] = Field(None, alias='createWebhook', title='CreateWebhook if specified creates a new webhook programmatically.\n+optional')
event_filter
class-attribute
event_filter: Optional[List[str]] = Field(None, alias='eventFilter', title='EventFilter describes the type of events to listen to. If not specified, all types of events will be processed.\nMore info at https://stripe.com/docs/api/events/list\n+optional')
TLSConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
ca_cert_secret
class-attribute
ca_cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias='caCertSecret', title='CACertSecret refers to the secret that contains the CA cert')
client_cert_secret
class-attribute
client_cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias='clientCertSecret', title='ClientCertSecret refers to the secret that contains the client cert')
Template
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 |
|
affinity
class-attribute
affinity: Optional[v1.Affinity] = Field(None, title="If specified, the pod's scheduling constraints\n+optional")
container
class-attribute
container: Optional[v1.Container] = Field(None, title='Container is the main container image to run in the sensor pod\n+optional')
image_pull_secrets
class-attribute
image_pull_secrets: Optional[List[v1.LocalObjectReference]] = Field(None, alias='imagePullSecrets', title='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.\nIf specified, these secrets will be passed to individual puller implementations for them to use. For example,\nin the case of docker, only DockerConfig type secrets are honored.\nMore info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod\n+optional\n+patchMergeKey=name\n+patchStrategy=merge')
metadata
class-attribute
metadata: Optional[Metadata] = Field(None, title="Metadata sets the pods's metadata, i.e. annotations and labels")
node_selector
class-attribute
node_selector: Optional[Dict[str, str]] = Field(None, alias='nodeSelector', title="NodeSelector is a selector which must be true for the pod to fit on a node.\nSelector which must match a node's labels for the pod to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n+optional")
priority
class-attribute
priority: Optional[int] = Field(None, title='The priority value. Various system components use this field to find the\npriority of the EventSource pod. When Priority Admission Controller is enabled,\nit prevents users from setting this field. The admission controller populates\nthis field from PriorityClassName.\nThe higher the value, the higher the priority.\nMore info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/\n+optional')
priority_class_name
class-attribute
priority_class_name: Optional[str] = Field(None, alias='priorityClassName', title='If specified, indicates the EventSource pod\'s priority. "system-node-critical"\nand "system-cluster-critical" are two special keywords which indicate the\nhighest priorities with the former being the highest priority. Any other\nname must be defined by creating a PriorityClass object with that name.\nIf not specified, the pod priority will be default or zero if there is no\ndefault.\nMore info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/\n+optional')
security_context
class-attribute
security_context: Optional[v1.PodSecurityContext] = Field(None, alias='securityContext', title='SecurityContext holds pod-level security attributes and common container settings.\nOptional: Defaults to empty. See type description for default values of each field.\n+optional')
service_account_name
class-attribute
service_account_name: Optional[str] = Field(None, alias='serviceAccountName', title='ServiceAccountName is the name of the ServiceAccount to use to run sensor pod.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional')
TimeFilter
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
start
class-attribute
start: Optional[str] = Field(None, description='Start is the beginning of a time window in UTC.\nBefore this time, events for this dependency are ignored.\nFormat is hh:mm:ss.')
stop
class-attribute
stop: Optional[str] = Field(None, description='Stop is the end of a time window in UTC.\nAfter or equal to this time, events for this dependency are ignored and\nFormat is hh:mm:ss.\nIf it is smaller than Start, it is treated as next day of Start\n(e.g.: 22:00:00-01:00:00 means 22:00:00-25:00:00).')
Trigger
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
parameters
class-attribute
parameters: Optional[List[TriggerParameter]] = Field(None, title='Parameters is the list of parameters applied to the trigger template definition')
policy
class-attribute
policy: Optional[TriggerPolicy] = Field(None, title='Policy to configure backoff and execution criteria for the trigger\n+optional')
rate_limit
class-attribute
rate_limit: Optional[RateLimit] = Field(None, alias='rateLimit', title='Rate limit, default unit is Second\n+optional')
TriggerParameter
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
dest
class-attribute
dest: Optional[str] = Field(None, description="Dest is the JSONPath of a resource key.\nA path is a series of keys separated by a dot. The colon character can be escaped with '.'\nThe -1 key can be used to append a value to an existing array.\nSee https://github.com/tidwall/sjson#path-syntax for more information about how this is used.")
TriggerParameterSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
context_key
class-attribute
context_key: Optional[str] = Field(None, alias='contextKey', description="ContextKey is the JSONPath of the event's (JSON decoded) context key\nContextKey is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.")
context_template
class-attribute
context_template: Optional[str] = Field(None, alias='contextTemplate', title="ContextTemplate is a go-template for extracting a string from the event's context.\nIf a ContextTemplate is provided with a ContextKey, the template will be evaluated first and fallback to the ContextKey.\nThe templating follows the standard go-template syntax as well as sprig's extra functions.\nSee https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/")
data_key
class-attribute
data_key: Optional[str] = Field(None, alias='dataKey', description="DataKey is the JSONPath of the event's (JSON decoded) data key\nDataKey is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.")
data_template
class-attribute
data_template: Optional[str] = Field(None, alias='dataTemplate', title="DataTemplate is a go-template for extracting a string from the event's data.\nIf a DataTemplate is provided with a DataKey, the template will be evaluated first and fallback to the DataKey.\nThe templating follows the standard go-template syntax as well as sprig's extra functions.\nSee https://pkg.go.dev/text/template and https://masterminds.github.io/sprig/")
dependency_name
class-attribute
dependency_name: Optional[str] = Field(None, alias='dependencyName', description='DependencyName refers to the name of the dependency. The event which is stored for this dependency is used as payload\nfor the parameterization. Make sure to refer to one of the dependencies you have defined under Dependencies list.')
TriggerPolicy
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
TriggerTemplate
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 |
|
argo_workflow
class-attribute
argo_workflow: Optional[ArgoWorkflowTrigger] = Field(None, alias='argoWorkflow', title='ArgoWorkflow refers to the trigger that can perform various operations on an Argo io.argoproj.workflow.v1alpha1.\n+optional')
aws_lambda
class-attribute
aws_lambda: Optional[AWSLambdaTrigger] = Field(None, alias='awsLambda', title='AWSLambda refers to the trigger designed to invoke AWS Lambda function with with on-the-fly constructable payload.\n+optional')
azure_event_hubs
class-attribute
azure_event_hubs: Optional[AzureEventHubsTrigger] = Field(None, alias='azureEventHubs', title='AzureEventHubs refers to the trigger send an event to an Azure Event Hub.\n+optional')
conditions
class-attribute
conditions: Optional[str] = Field(None, title='Conditions is the conditions to execute the trigger.\nFor example: "(dep01 || dep02) && dep04"\n+optional')
conditions_reset
class-attribute
conditions_reset: Optional[List[ConditionsResetCriteria]] = Field(None, alias='conditionsReset', title='Criteria to reset the conditons\n+optional')
custom
class-attribute
custom: Optional[CustomTrigger] = Field(None, title='CustomTrigger refers to the trigger designed to connect to a gRPC trigger server and execute a custom trigger.\n+optional')
http
class-attribute
http: Optional[HTTPTrigger] = Field(None, title='HTTP refers to the trigger designed to dispatch a HTTP request with on-the-fly constructable payload.\n+optional')
k8s
class-attribute
k8s: Optional[StandardK8STrigger] = Field(None, title='StandardK8STrigger refers to the trigger designed to create or update a generic Kubernetes resource.\n+optional')
kafka
class-attribute
kafka: Optional[KafkaTrigger] = Field(None, description='Kafka refers to the trigger designed to place messages on Kafka topic.\n+optional.')
log
class-attribute
log: Optional[LogTrigger] = Field(None, title='Log refers to the trigger designed to invoke log the io.argoproj.workflow.v1alpha1.\n+optional')
name
class-attribute
nats
class-attribute
nats: Optional[NATSTrigger] = Field(None, description='NATS refers to the trigger designed to place message on NATS subject.\n+optional.')
open_whisk
class-attribute
open_whisk: Optional[OpenWhiskTrigger] = Field(None, alias='openWhisk', title='OpenWhisk refers to the trigger designed to invoke OpenWhisk action.\n+optional')
URLArtifact
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
ValueFromSource
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
WatchPathConfig
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
WebhookContext
Source code in hera/events/models/io/argoproj/events/v1alpha1.py
auth_secret
class-attribute
auth_secret: Optional[v1.SecretKeySelector] = Field(None, alias='authSecret', title='AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional')
max_payload_size
class-attribute
max_payload_size: Optional[str] = Field(None, alias='maxPayloadSize', title='MaxPayloadSize is the maximum webhook payload size that the server will accept.\nRequests exceeding that limit will be rejected with "request too large" response.\nDefault value: 1048576 (1MB).\n+optional')
metadata
class-attribute
metadata: Optional[Dict[str, str]] = Field(None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
method
class-attribute
method: Optional[str] = Field(None, title='Method is HTTP request method that indicates the desired action to be performed for a given resource.\nSee RFC7231 Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content')
port
class-attribute
port: Optional[str] = Field(None, description='Port on which HTTP server is listening for incoming events.')
server_cert_secret
class-attribute
server_cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias='serverCertSecret', description='ServerCertPath refers the file that contains the cert.')