Hera Events Auto-generated Models
hera.events.models
AMQPConsumeConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auto_ack
class-attribute
instance-attribute
auto_ack = Field(default=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
instance-attribute
consumer_tag = Field(default=None, alias='consumerTag', title='ConsumerTag is the identity of the consumer included in every delivery\n+optional')
exclusive
class-attribute
instance-attribute
exclusive = Field(default=None, title='Exclusive when true, the server will ensure that this is the sole consumer from this queue\n+optional')
AMQPEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 |
|
auth
class-attribute
instance-attribute
auth = Field(default=None, title='Auth hosts secret selectors for username and password\n+optional')
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
consume
class-attribute
instance-attribute
consume = Field(default=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
instance-attribute
exchange_declare = Field(default=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
instance-attribute
exchange_name = Field(default=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
instance-attribute
exchange_type = Field(default=None, alias='exchangeType', title='ExchangeType is rabbitmq exchange type')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
queue_bind
class-attribute
instance-attribute
queue_bind = Field(default=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
instance-attribute
queue_declare = Field(default=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
instance-attribute
tls
class-attribute
instance-attribute
AMQPExchangeDeclareConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auto_delete
class-attribute
instance-attribute
auto_delete = Field(default=None, alias='autoDelete', title='AutoDelete removes the exchange when no bindings are active\n+optional')
durable
class-attribute
instance-attribute
durable = Field(default=None, title='Durable keeps the exchange also after the server restarts\n+optional')
internal
class-attribute
instance-attribute
AMQPQueueBindConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
AMQPQueueDeclareConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
arguments
class-attribute
instance-attribute
arguments = Field(default=None, title='Arguments of a queue (also known as "x-arguments") used for optional features and plugins\n+optional')
auto_delete
class-attribute
instance-attribute
auto_delete = Field(default=None, alias='autoDelete', title='AutoDelete removes the queue when no consumers are active\n+optional')
durable
class-attribute
instance-attribute
durable = Field(default=None, title='Durable keeps the queue also after the server restarts\n+optional')
exclusive
class-attribute
instance-attribute
exclusive = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
instance-attribute
access_key = Field(default=None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key\n+optional')
function_name
class-attribute
instance-attribute
function_name = Field(default=None, alias='functionName', description='FunctionName refers to the name of the function to invoke.')
invocation_type
class-attribute
instance-attribute
invocation_type = Field(default=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
instance-attribute
parameters = Field(default=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
instance-attribute
payload = Field(default=None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
region
class-attribute
instance-attribute
Amount
ArgoWorkflowTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
args
class-attribute
instance-attribute
operation
class-attribute
instance-attribute
operation = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
configmap
class-attribute
instance-attribute
file
class-attribute
instance-attribute
git
class-attribute
instance-attribute
inline
class-attribute
instance-attribute
resource
class-attribute
instance-attribute
AzureEventHubsTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
fqdn
class-attribute
instance-attribute
fqdn = Field(default=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
instance-attribute
hub_name = Field(default=None, alias='hubName', title='HubName refers to the Azure Event Hub to send events to')
parameters
class-attribute
instance-attribute
parameters = Field(default=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
instance-attribute
payload = Field(default=None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
AzureEventsHubEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
fqdn
class-attribute
instance-attribute
fqdn = Field(default=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
instance-attribute
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
Backoff
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
BasicAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
BitbucketAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
basic
class-attribute
instance-attribute
BitbucketBasicAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
BitbucketEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auth
class-attribute
instance-attribute
delete_hook_on_finish
class-attribute
instance-attribute
delete_hook_on_finish = Field(default=None, alias='deleteHookOnFinish', title='DeleteHookOnFinish determines whether to delete the defined Bitbucket hook once the event source is stopped.\n+optional')
events
class-attribute
instance-attribute
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will be passed along the event payload.\n+optional')
owner
class-attribute
instance-attribute
owner = Field(default=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
instance-attribute
project_key = Field(default=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
instance-attribute
repositories = Field(default=None, title='Repositories holds a list of repositories for which integration needs to set up\n+optional')
repository_slug
class-attribute
instance-attribute
repository_slug = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
owner
class-attribute
instance-attribute
BitbucketServerEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
access_token
class-attribute
instance-attribute
access_token = Field(default=None, alias='accessToken', title='AccessToken is reference to K8s secret which holds the bitbucket api access information')
bitbucketserver_base_url
class-attribute
instance-attribute
bitbucketserver_base_url = Field(default=None, alias='bitbucketserverBaseURL', title='BitbucketServerBaseURL is the base URL for API requests to a custom endpoint')
delete_hook_on_finish
class-attribute
instance-attribute
delete_hook_on_finish = Field(default=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
instance-attribute
events = Field(default=None, title='Events are bitbucket event to listen to.\nRefer https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_key
class-attribute
instance-attribute
project_key = Field(default=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
instance-attribute
repositories = Field(default=None, title='Repositories holds a list of repositories for which integration needs to set up\n+optional')
repository_slug
class-attribute
instance-attribute
repository_slug = Field(default=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')
webhook
class-attribute
instance-attribute
BitbucketServerRepository
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
CalendarEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
exclusion_dates
class-attribute
instance-attribute
exclusion_dates = Field(default=None, alias='exclusionDates', description='ExclusionDates defines the list of DATE-TIME exceptions for recurring events.')
interval
class-attribute
instance-attribute
interval = Field(default=None, title='Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h...\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
persistence
class-attribute
instance-attribute
CatchupConfiguration
Condition
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
last_transition_time
class-attribute
instance-attribute
last_transition_time = Field(default=None, alias='lastTransitionTime', title='Last time the condition transitioned from one status to another.\n+optional')
message
class-attribute
instance-attribute
message = Field(default=None, title='Human-readable message indicating details about last transition.\n+optional')
reason
class-attribute
instance-attribute
reason = Field(default=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
instance-attribute
ConditionsResetByTime
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
ConditionsResetCriteria
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
ConfigMapPersistence
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
CustomTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
cert_secret
class-attribute
instance-attribute
cert_secret = Field(default=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
instance-attribute
parameters = Field(default=None, description='Parameters is the list of parameters that is applied to resolved custom trigger trigger object.')
payload
class-attribute
instance-attribute
payload = Field(default=None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
secure
class-attribute
instance-attribute
secure = Field(default=None, title='Secure refers to type of the connection between sensor to custom trigger gRPC')
server_name_override
class-attribute
instance-attribute
server_name_override = Field(default=None, alias='serverNameOverride', description='ServerNameOverride for the secure connection between sensor and custom trigger gRPC server.')
DataFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
comparator
class-attribute
instance-attribute
comparator = Field(default=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
instance-attribute
path = Field(default=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
instance-attribute
template = Field(default=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
instance-attribute
EmitterEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
broker
class-attribute
instance-attribute
channel_key
class-attribute
instance-attribute
channel_name
class-attribute
instance-attribute
channel_name = Field(default=None, alias='channelName', title='ChannelName refers to the channel name')
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
password
class-attribute
instance-attribute
tls
class-attribute
instance-attribute
EventContext
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
datacontenttype
class-attribute
instance-attribute
datacontenttype = Field(default=None, description='DataContentType - A MIME (RFC2046) string describing the media type of `data`.')
id
class-attribute
instance-attribute
id = Field(default=None, description='ID of the event; must be non-empty and unique within the scope of the producer.')
source
class-attribute
instance-attribute
specversion
class-attribute
instance-attribute
specversion = Field(default=None, description='SpecVersion - The version of the CloudEvents specification used by the io.argoproj.workflow.v1alpha1.')
subject
class-attribute
instance-attribute
subject = Field(default=None, title='Subject - The subject of the event in the context of the event producer')
time
class-attribute
instance-attribute
EventDependency
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
event_name
class-attribute
instance-attribute
event_source_name
class-attribute
instance-attribute
event_source_name = Field(default=None, alias='eventSourceName', title='EventSourceName is the name of EventSource that Sensor depends on')
filters
class-attribute
instance-attribute
filters = Field(default=None, title='Filters and rules governing toleration of success and constraints on the context and data of an event')
filters_logical_operator
class-attribute
instance-attribute
filters_logical_operator = Field(default=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
instance-attribute
EventDependencyFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
context
class-attribute
instance-attribute
data
class-attribute
instance-attribute
data_logical_operator
class-attribute
instance-attribute
data_logical_operator = Field(default=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
instance-attribute
expr_logical_operator = Field(default=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
instance-attribute
exprs = Field(default=None, description='Exprs contains the list of expressions evaluated against the event payload.')
EventDependencyTransformer
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
EventPersistence
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
EventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
EventSourceFilter
EventSourceList
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
EventSourceSpec
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
azure_events_hub
class-attribute
instance-attribute
azure_events_hub = Field(default=None, alias='azureEventsHub', title='AzureEventsHub event sources')
bitbucket
class-attribute
instance-attribute
bitbucketserver
class-attribute
instance-attribute
calendar
class-attribute
instance-attribute
emitter
class-attribute
instance-attribute
event_bus_name
class-attribute
instance-attribute
event_bus_name = Field(default=None, alias='eventBusName', title='EventBusName references to a EventBus name. By default the value is "default"')
generic
class-attribute
instance-attribute
github
class-attribute
instance-attribute
gitlab
class-attribute
instance-attribute
pub_sub
class-attribute
instance-attribute
redis_stream
class-attribute
instance-attribute
replicas
class-attribute
instance-attribute
resource
class-attribute
instance-attribute
service
class-attribute
instance-attribute
service = Field(default=None, title='Service is the specifications of the service to expose the event source\n+optional')
storage_grid
class-attribute
instance-attribute
stripe
class-attribute
instance-attribute
EventSourceStatus
ExprFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
FileArtifact
FileEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
event_type
class-attribute
instance-attribute
event_type = Field(default=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
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
polling
class-attribute
instance-attribute
GenericEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auth_secret
class-attribute
instance-attribute
auth_secret = Field(default=None, alias='authSecret', title='AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional')
config
class-attribute
instance-attribute
insecure
class-attribute
instance-attribute
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
GitArtifact
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
branch
class-attribute
instance-attribute
clone_directory
class-attribute
instance-attribute
clone_directory = Field(default=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
instance-attribute
creds = Field(default=None, title='Creds contain reference to git username and password\n+optional')
file_path
class-attribute
instance-attribute
file_path = Field(default=None, alias='filePath', title='Path to file that contains trigger resource definition')
insecure_ignore_host_key
class-attribute
instance-attribute
insecure_ignore_host_key = Field(default=None, alias='insecureIgnoreHostKey', title='Whether to ignore host key\n+optional')
ref
class-attribute
instance-attribute
ref = Field(default=None, title='Ref to use to pull trigger resource. Will result in a shallow clone and\nfetch.\n+optional')
remote
class-attribute
instance-attribute
remote = Field(default=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
instance-attribute
ssh_key_secret = Field(default=None, alias='sshKeySecret', title='SSHKeySecret refers to the secret that contains SSH key')
tag
class-attribute
instance-attribute
GitCreds
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
GitRemoteConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
name
class-attribute
instance-attribute
GithubAppCreds
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
app_id
class-attribute
instance-attribute
app_id = Field(default=None, alias='appID', title='AppID refers to the GitHub App ID for the application you created')
GithubEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 |
|
active
class-attribute
instance-attribute
active = Field(default=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
instance-attribute
api_token = Field(default=None, alias='apiToken', title='APIToken refers to a K8s secret containing github api token\n+optional')
content_type
class-attribute
instance-attribute
delete_hook_on_finish
class-attribute
instance-attribute
delete_hook_on_finish = Field(default=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
instance-attribute
events = Field(default=None, title='Events refer to Github events to which the event source will subscribe')
github_app
class-attribute
instance-attribute
github_app = Field(default=None, alias='githubApp', title='GitHubApp holds the GitHub app credentials\n+optional')
github_base_url
class-attribute
instance-attribute
github_base_url = Field(default=None, alias='githubBaseURL', title='GitHub base URL (for GitHub Enterprise)\n+optional')
github_upload_url
class-attribute
instance-attribute
github_upload_url = Field(default=None, alias='githubUploadURL', title='GitHub upload URL (for GitHub Enterprise)\n+optional')
id
class-attribute
instance-attribute
id = Field(default=None, title="Id is the webhook's id\nDeprecated: This is not used at all, will be removed in v1.6\n+optional")
insecure
class-attribute
instance-attribute
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
organizations
class-attribute
instance-attribute
organizations = Field(default=None, description='Organizations holds the names of organizations (used for organization level webhooks). Not required if Repositories is set.')
owner
class-attribute
instance-attribute
owner = Field(default=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
instance-attribute
repositories = Field(default=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
instance-attribute
repository = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
access_token
class-attribute
instance-attribute
access_token = Field(default=None, alias='accessToken', title='AccessToken references to k8 secret which holds the gitlab api access information')
delete_hook_on_finish
class-attribute
instance-attribute
delete_hook_on_finish = Field(default=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
instance-attribute
enable_ssl_verification = Field(default=None, alias='enableSSLVerification', title='EnableSSLVerification to enable ssl verification\n+optional')
events
class-attribute
instance-attribute
events = Field(default=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
instance-attribute
gitlab_base_url = Field(default=None, alias='gitlabBaseURL', title='GitlabBaseURL is the base URL for API requests to a custom endpoint')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_id
class-attribute
instance-attribute
project_id = Field(default=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
instance-attribute
projects = Field(default=None, title='List of project IDs or project namespace paths like "whynowy/test"')
HDFSEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
check_interval
class-attribute
instance-attribute
check_interval = Field(default=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
instance-attribute
hdfs_user = Field(default=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
instance-attribute
krb_c_cache_secret = Field(default=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
instance-attribute
krb_config_config_map = Field(default=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
instance-attribute
krb_keytab_secret = Field(default=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
instance-attribute
krb_realm = Field(default=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
instance-attribute
krb_service_principal_name = Field(default=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
instance-attribute
krb_username = Field(default=None, alias='krbUsername', description='KrbUsername is the Kerberos username used with Kerberos keytab\nIt must be set if keytab is used.')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
type
class-attribute
instance-attribute
HTTPTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
basic_auth
class-attribute
instance-attribute
basic_auth = Field(default=None, alias='basicAuth', title='BasicAuth configuration for the http request.\n+optional')
headers
class-attribute
instance-attribute
method
class-attribute
instance-attribute
method = Field(default=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
instance-attribute
parameters = Field(default=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
instance-attribute
secure_headers = Field(default=None, alias='secureHeaders', title='Secure Headers stored in Kubernetes Secrets for the HTTP requests.\n+optional')
timeout
class-attribute
instance-attribute
timeout = Field(default=None, title='Timeout refers to the HTTP request timeout in seconds.\nDefault value is 60 seconds.\n+optional')
tls
class-attribute
instance-attribute
Int64OrString
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
K8SResourcePolicy
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
backoff
class-attribute
instance-attribute
KafkaConsumerGroup
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
KafkaEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
config
class-attribute
instance-attribute
config = Field(default=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
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', description='Backoff holds parameters applied to connection.')
consumer_group
class-attribute
instance-attribute
consumer_group = Field(default=None, alias='consumerGroup', title='Consumer group for kafka client\n+optional')
json_body
class-attribute
instance-attribute
json_body = Field(default=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
instance-attribute
limit_events_per_second = Field(default=None, alias='limitEventsPerSecond', title='Sets a limit on how many events get read from kafka per second.\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
partition
class-attribute
instance-attribute
sasl
class-attribute
instance-attribute
tls
class-attribute
instance-attribute
url
class-attribute
instance-attribute
KafkaTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
compress
class-attribute
instance-attribute
compress = Field(default=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
instance-attribute
flush_frequency = Field(default=None, alias='flushFrequency', title='FlushFrequency refers to the frequency in milliseconds to flush batches.\nDefaults to 500 milliseconds.\n+optional')
parameters
class-attribute
instance-attribute
parameters = Field(default=None, description='Parameters is the list of parameters that is applied to resolved Kafka trigger object.')
partition
class-attribute
instance-attribute
partitioning_key
class-attribute
instance-attribute
partitioning_key = Field(default=None, alias='partitioningKey', description='The partitioning key for the messages put on the Kafka topic.\nDefaults to broker url.\n+optional.')
payload
class-attribute
instance-attribute
payload = Field(default=None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
required_acks
class-attribute
instance-attribute
required_acks = Field(default=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
instance-attribute
tls
class-attribute
instance-attribute
topic
class-attribute
instance-attribute
topic = Field(default=None, title='Name of the topic.\nMore info at https://kafka.apache.org/documentation/#intro_topics')
url
class-attribute
instance-attribute
LogTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
MQTTEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
client_id
class-attribute
instance-attribute
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', description='ConnectionBackoff holds backoff applied to connection.')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
instance-attribute
Metadata
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
NATSAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
basic
class-attribute
instance-attribute
credential
class-attribute
instance-attribute
nkey
class-attribute
instance-attribute
NATSEventsSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auth
class-attribute
instance-attribute
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', description='ConnectionBackoff holds backoff applied to connection.')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
subject
class-attribute
instance-attribute
subject = Field(default=None, title='Subject holds the name of the subject onto which messages are published')
tls
class-attribute
instance-attribute
NATSTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
subject
class-attribute
instance-attribute
tls
class-attribute
instance-attribute
NSQEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
channel
class-attribute
instance-attribute
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
host_address
class-attribute
instance-attribute
host_address = Field(default=None, alias='hostAddress', title='HostAddress is the address of the host for NSQ lookup')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
instance-attribute
OpenWhiskTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
action_name
class-attribute
instance-attribute
auth_token
class-attribute
instance-attribute
auth_token = Field(default=None, alias='authToken', title='AuthToken for authentication.\n+optional')
host
class-attribute
instance-attribute
namespace
class-attribute
instance-attribute
namespace = Field(default=None, description='Namespace for the action.\nDefaults to "_".\n+optional.')
parameters
class-attribute
instance-attribute
parameters = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
PayloadField
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
name
class-attribute
instance-attribute
path
class-attribute
instance-attribute
path = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
credential_secret
class-attribute
instance-attribute
credential_secret = Field(default=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
instance-attribute
delete_subscription_on_finish = Field(default=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
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
project_id
class-attribute
instance-attribute
project_id = Field(default=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
instance-attribute
subscription_id = Field(default=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
instance-attribute
topic = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
auth_token_secret
class-attribute
instance-attribute
auth_token_secret = Field(default=None, alias='authTokenSecret', title='Authentication token for the pulsar client.\n+optional')
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
tls
class-attribute
instance-attribute
tls_allow_insecure_connection
class-attribute
instance-attribute
tls_allow_insecure_connection = Field(default=None, alias='tlsAllowInsecureConnection', title='Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional')
tls_trust_certs_secret
class-attribute
instance-attribute
tls_trust_certs_secret = Field(default=None, alias='tlsTrustCertsSecret', title='Trusted TLS certificate secret.\n+optional')
tls_validate_hostname
class-attribute
instance-attribute
tls_validate_hostname = Field(default=None, alias='tlsValidateHostname', title='Whether the Pulsar client verify the validity of the host name from broker.\n+optional')
topics
class-attribute
instance-attribute
PulsarTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auth_token_secret
class-attribute
instance-attribute
auth_token_secret = Field(default=None, alias='authTokenSecret', title='Authentication token for the pulsar client.\n+optional')
connection_backoff
class-attribute
instance-attribute
connection_backoff = Field(default=None, alias='connectionBackoff', title='Backoff holds parameters applied to connection.\n+optional')
parameters
class-attribute
instance-attribute
parameters = Field(default=None, description='Parameters is the list of parameters that is applied to resolved Kafka trigger object.')
payload
class-attribute
instance-attribute
payload = Field(default=None, description='Payload is the list of key-value extracted from an event payload to construct the request payload.')
tls
class-attribute
instance-attribute
tls_allow_insecure_connection
class-attribute
instance-attribute
tls_allow_insecure_connection = Field(default=None, alias='tlsAllowInsecureConnection', title='Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional')
tls_trust_certs_secret
class-attribute
instance-attribute
tls_trust_certs_secret = Field(default=None, alias='tlsTrustCertsSecret', title='Trusted TLS certificate secret.\n+optional')
tls_validate_hostname
class-attribute
instance-attribute
tls_validate_hostname = Field(default=None, alias='tlsValidateHostname', title='Whether the Pulsar client verify the validity of the host name from broker.\n+optional')
RateLimit
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
RedisEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
db
class-attribute
instance-attribute
db = Field(default=None, title='DB to use. If not specified, default DB 0 will be used.\n+optional')
host_address
class-attribute
instance-attribute
host_address = Field(default=None, alias='hostAddress', title='HostAddress refers to the address of the Redis host/server')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
namespace
class-attribute
instance-attribute
namespace = Field(default=None, title='Namespace to use to retrieve the password from. It should only be specified if password is declared\n+optional')
password
class-attribute
instance-attribute
tls
class-attribute
instance-attribute
RedisStreamEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
consumer_group
class-attribute
instance-attribute
consumer_group = Field(default=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
instance-attribute
db = Field(default=None, title='DB to use. If not specified, default DB 0 will be used.\n+optional')
host_address
class-attribute
instance-attribute
host_address = Field(default=None, alias='hostAddress', title='HostAddress refers to the address of the Redis host/server (master instance)')
max_msg_count_per_read
class-attribute
instance-attribute
max_msg_count_per_read = Field(default=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
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
password
class-attribute
instance-attribute
streams
class-attribute
instance-attribute
streams = Field(default=None, description='Streams to look for entries. XREADGROUP is used on all streams using a single consumer group.')
tls
class-attribute
instance-attribute
Resource
ResourceEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
event_types
class-attribute
instance-attribute
event_types = Field(default=None, alias='eventTypes', description='EventTypes is the list of event type to watch.\nPossible values are - ADD, UPDATE and DELETE.')
filter
class-attribute
instance-attribute
filter = Field(default=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
instance-attribute
group_version_resource = Field(default=None, alias='groupVersionResource', title='Group of the resource')
ResourceFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
after_start
class-attribute
instance-attribute
after_start = Field(default=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
instance-attribute
created_by = Field(default=None, alias='createdBy', title='If resource is created before the specified time then the event is treated as valid.\n+optional')
fields
class-attribute
instance-attribute
fields = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
S3Bucket
S3Filter
SASLConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
SNSEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
instance-attribute
access_key = Field(default=None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key')
endpoint
class-attribute
instance-attribute
endpoint = Field(default=None, title='Endpoint configures connection to a specific SNS endpoint instead of Amazons servers\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
region
class-attribute
instance-attribute
role_arn
class-attribute
instance-attribute
role_arn = Field(default=None, alias='roleARN', title='RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional')
secret_key
class-attribute
instance-attribute
secret_key = Field(default=None, alias='secretKey', title='SecretKey refers K8s secret containing aws secret key')
topic_arn
class-attribute
instance-attribute
SQSEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
access_key
class-attribute
instance-attribute
access_key = Field(default=None, alias='accessKey', title='AccessKey refers K8s secret containing aws access key')
dlq
class-attribute
instance-attribute
dlq = Field(default=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
instance-attribute
endpoint = Field(default=None, title='Endpoint configures connection to a specific SQS endpoint instead of Amazons servers\n+optional')
json_body
class-attribute
instance-attribute
json_body = Field(default=None, alias='jsonBody', title='JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional')
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
queue
class-attribute
instance-attribute
queue_account_id
class-attribute
instance-attribute
queue_account_id = Field(default=None, alias='queueAccountId', title='QueueAccountID is the ID of the account that created the queue to monitor\n+optional')
region
class-attribute
instance-attribute
role_arn
class-attribute
instance-attribute
role_arn = Field(default=None, alias='roleARN', title='RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional')
secret_key
class-attribute
instance-attribute
secret_key = Field(default=None, alias='secretKey', title='SecretKey refers K8s secret containing aws secret key')
SecureHeader
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Selector
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Sensor
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
SensorList
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
SensorSpec
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
dependencies
class-attribute
instance-attribute
dependencies = Field(default=None, description='Dependencies is a list of the events that this sensor is dependent on.')
error_on_failed_round
class-attribute
instance-attribute
error_on_failed_round = Field(default=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
instance-attribute
event_bus_name = Field(default=None, alias='eventBusName', title='EventBusName references to a EventBus name. By default the value is "default"')
replicas
class-attribute
instance-attribute
template
class-attribute
instance-attribute
SensorStatus
Service
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
cluster_ip
class-attribute
instance-attribute
cluster_ip = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
SlackTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
channel
class-attribute
instance-attribute
channel = Field(default=None, title='Channel refers to which Slack channel to send slack message.\n+optional')
message
class-attribute
instance-attribute
message = Field(default=None, title='Message refers to the message to send to the Slack channel.\n+optional')
StandardK8STrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
live_object
class-attribute
instance-attribute
live_object = Field(default=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
instance-attribute
operation = Field(default=None, title='Operation refers to the type of operation performed on the k8s resource.\nDefault value is Create.\n+optional')
parameters
class-attribute
instance-attribute
parameters = Field(default=None, description='Parameters is the list of parameters that is applied to resolved K8s trigger object.')
patch_strategy
class-attribute
instance-attribute
patch_strategy = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
StatusPolicy
StorageGridEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
api_url
class-attribute
instance-attribute
api_url = Field(default=None, alias='apiURL', description='APIURL is the url of the storagegrid api.')
auth_token
class-attribute
instance-attribute
bucket
class-attribute
instance-attribute
filter
class-attribute
instance-attribute
metadata
class-attribute
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
region
class-attribute
instance-attribute
topic_arn
class-attribute
instance-attribute
StorageGridFilter
StripeEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
api_key
class-attribute
instance-attribute
api_key = Field(default=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
instance-attribute
create_webhook = Field(default=None, alias='createWebhook', title='CreateWebhook if specified creates a new webhook programmatically.\n+optional')
event_filter
class-attribute
instance-attribute
event_filter = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
ca_cert_secret
class-attribute
instance-attribute
ca_cert_secret = Field(default=None, alias='caCertSecret', title='CACertSecret refers to the secret that contains the CA cert')
client_cert_secret
class-attribute
instance-attribute
client_cert_secret = Field(default=None, alias='clientCertSecret', title='ClientCertSecret refers to the secret that contains the client cert')
Template
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 |
|
affinity
class-attribute
instance-attribute
container
class-attribute
instance-attribute
container = Field(default=None, title='Container is the main container image to run in the sensor pod\n+optional')
image_pull_secrets
class-attribute
instance-attribute
image_pull_secrets = Field(default=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
instance-attribute
metadata = Field(default=None, title="Metadata sets the pods's metadata, i.e. annotations and labels")
node_selector
class-attribute
instance-attribute
node_selector = Field(default=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
instance-attribute
priority = Field(default=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
instance-attribute
priority_class_name = Field(default=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
instance-attribute
security_context = Field(default=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
instance-attribute
service_account_name = Field(default=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')
tolerations
class-attribute
instance-attribute
TimeFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
start
class-attribute
instance-attribute
start = Field(default=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
instance-attribute
stop = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
parameters
class-attribute
instance-attribute
parameters = Field(default=None, title='Parameters is the list of parameters applied to the trigger template definition')
policy
class-attribute
instance-attribute
policy = Field(default=None, title='Policy to configure backoff and execution criteria for the trigger\n+optional')
rate_limit
class-attribute
instance-attribute
rate_limit = Field(default=None, alias='rateLimit', title='Rate limit, default unit is Second\n+optional')
TriggerParameter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
dest
class-attribute
instance-attribute
dest = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
context_key
class-attribute
instance-attribute
context_key = Field(default=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
instance-attribute
context_template = Field(default=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
instance-attribute
data_key = Field(default=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
instance-attribute
data_template = Field(default=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
instance-attribute
dependency_name = Field(default=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 src/hera/events/models/io/argoproj/events/v1alpha1.py
TriggerTemplate
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
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 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 |
|
argo_workflow
class-attribute
instance-attribute
argo_workflow = Field(default=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
instance-attribute
aws_lambda = Field(default=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
instance-attribute
azure_event_hubs = Field(default=None, alias='azureEventHubs', title='AzureEventHubs refers to the trigger send an event to an Azure Event Hub.\n+optional')
conditions
class-attribute
instance-attribute
conditions = Field(default=None, title='Conditions is the conditions to execute the trigger.\nFor example: "(dep01 || dep02) && dep04"\n+optional')
conditions_reset
class-attribute
instance-attribute
conditions_reset = Field(default=None, alias='conditionsReset', title='Criteria to reset the conditons\n+optional')
custom
class-attribute
instance-attribute
custom = Field(default=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
instance-attribute
http = Field(default=None, title='HTTP refers to the trigger designed to dispatch a HTTP request with on-the-fly constructable payload.\n+optional')
k8s
class-attribute
instance-attribute
k8s = Field(default=None, title='StandardK8STrigger refers to the trigger designed to create or update a generic Kubernetes resource.\n+optional')
kafka
class-attribute
instance-attribute
kafka = Field(default=None, description='Kafka refers to the trigger designed to place messages on Kafka topic.\n+optional.')
log
class-attribute
instance-attribute
log = Field(default=None, title='Log refers to the trigger designed to invoke log the io.argoproj.workflow.v1alpha1.\n+optional')
name
class-attribute
instance-attribute
nats
class-attribute
instance-attribute
nats = Field(default=None, description='NATS refers to the trigger designed to place message on NATS subject.\n+optional.')
open_whisk
class-attribute
instance-attribute
open_whisk = Field(default=None, alias='openWhisk', title='OpenWhisk refers to the trigger designed to invoke OpenWhisk action.\n+optional')
URLArtifact
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
ValueFromSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
WatchPathConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
WebhookContext
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
auth_secret
class-attribute
instance-attribute
auth_secret = Field(default=None, alias='authSecret', title='AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional')
endpoint
class-attribute
instance-attribute
max_payload_size
class-attribute
instance-attribute
max_payload_size = Field(default=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
instance-attribute
metadata = Field(default=None, title='Metadata holds the user defined metadata which will passed along the event payload.\n+optional')
method
class-attribute
instance-attribute
method = Field(default=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
instance-attribute
port = Field(default=None, description='Port on which HTTP server is listening for incoming events.')
server_cert_secret
class-attribute
instance-attribute
server_cert_secret = Field(default=None, alias='serverCertSecret', description='ServerCertPath refers the file that contains the cert.')