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')
no_local
class-attribute
instance-attribute
no_local = Field(default=None, alias='noLocal', title='NoLocal flag is not supported by RabbitMQ\n+optional')
no_wait
class-attribute
instance-attribute
no_wait = Field(default=None, alias='noWait', title='NowWait when true, do not wait for the server to confirm the request and immediately begin deliveries\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
AMQPEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 |
|
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
url_secret
class-attribute
instance-attribute
url_secret = Field(default=None, alias='urlSecret', title='URLSecret is secret reference for rabbitmq service URL')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
no_wait
class-attribute
instance-attribute
no_wait = Field(default=None, alias='noWait', title='NowWait when true does not wait for a confirmation from the server\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
AMQPQueueBindConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
no_wait
class-attribute
instance-attribute
no_wait = Field(default=None, alias='noWait', title='NowWait false and the queue could not be bound, the channel will be closed with an error\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
name
class-attribute
instance-attribute
name = Field(default=None, title='Name of the queue. If empty the server auto-generates a unique name for this queue\n+optional')
no_wait
class-attribute
instance-attribute
no_wait = Field(default=None, alias='noWait', title='NowWait when true, the queue assumes to be declared on the server\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
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\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Amount
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
parameters
class-attribute
instance-attribute
parameters = Field(default=None, title='Parameters is the list of parameters to pass to resolved Argo Workflow object')
source
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.')
shared_access_key
class-attribute
instance-attribute
shared_access_key = Field(default=None, alias='sharedAccessKey', title='SharedAccessKey refers to a K8s secret containing the primary key for the')
shared_access_key_name
class-attribute
instance-attribute
shared_access_key_name = Field(default=None, alias='sharedAccessKeyName', title='SharedAccessKeyName refers to the name of the Shared Access Key')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
shared_access_key
class-attribute
instance-attribute
shared_access_key = Field(default=None, alias='sharedAccessKey', title='SharedAccessKey is the generated value of the key')
shared_access_key_name
class-attribute
instance-attribute
shared_access_key_name = Field(default=None, alias='sharedAccessKeyName', title="SharedAccessKeyName is the name you chose for your application's SAS keys")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Backoff
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
duration
class-attribute
instance-attribute
duration = Field(default=None, title='The initial duration in nanoseconds or strings like "1s", "3m"\n+optional')
factor
class-attribute
instance-attribute
jitter
class-attribute
instance-attribute
steps
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BasicAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
password
class-attribute
instance-attribute
password = Field(default=None, description='Password refers to the Kubernetes secret that holds the password required for basic auth.')
username
class-attribute
instance-attribute
username = Field(default=None, description='Username refers to the Kubernetes secret that holds the username required for basic auth.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BitbucketAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
basic
class-attribute
instance-attribute
oauth_token
class-attribute
instance-attribute
oauth_token = Field(default=None, alias='oauthToken', title='OAuthToken refers to the K8s secret that holds the OAuth Bearer token.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BitbucketBasicAuth
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
password
class-attribute
instance-attribute
password = Field(default=None, description='Password refers to the K8s secret that holds the password.')
username
class-attribute
instance-attribute
username = Field(default=None, description='Username refers to the K8s secret that holds the username.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
webhook
class-attribute
instance-attribute
webhook = Field(default=None, title='Webhook refers to the configuration required to run an http server')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BitbucketRepository
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
owner
class-attribute
instance-attribute
repository_slug
class-attribute
instance-attribute
repository_slug = Field(default=None, alias='repositorySlug', title='RepositorySlug is a URL-friendly version of a repository name, automatically generated by Bitbucket for use in the URL')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BitbucketServerEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
1331 1332 1333 1334 1335 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 |
|
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
webhook_secret
class-attribute
instance-attribute
webhook_secret = Field(default=None, alias='webhookSecret', title='WebhookSecret is reference to K8s secret which holds the bitbucket webhook secret (for HMAC validation)')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
BitbucketServerRepository
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
project_key
class-attribute
instance-attribute
project_key = Field(default=None, alias='projectKey', title='ProjectKey is the key of project for which integration needs to set up')
repository_slug
class-attribute
instance-attribute
repository_slug = Field(default=None, alias='repositorySlug', title='RepositorySlug is the slug of the repository for which integration needs to set up')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
schedule
class-attribute
instance-attribute
schedule = Field(default=None, title='Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron\n+optional')
timezone
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
CatchupConfiguration
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
enabled
class-attribute
instance-attribute
enabled = Field(default=None, title='Enabled enables to triggered the missed schedule when eventsource restarts')
max_duration
class-attribute
instance-attribute
max_duration = Field(default=None, alias='maxDuration', title='MaxDuration holds max catchup duration')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
type
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ConditionsResetByTime
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
cron
class-attribute
instance-attribute
cron = Field(default=None, title='Cron is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ConditionsResetCriteria
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
by_time
class-attribute
instance-attribute
by_time = Field(default=None, alias='byTime', title='Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ConfigMapPersistence
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
create_if_not_exist
class-attribute
instance-attribute
create_if_not_exist = Field(default=None, alias='createIfNotExist', title="CreateIfNotExist will create configmap if it doesn't exists")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.')
server_url
class-attribute
instance-attribute
server_url = Field(default=None, alias='serverURL', title='ServerURL is the url of the gRPC server that executes custom trigger')
spec
class-attribute
instance-attribute
spec = Field(default=None, description='Spec is the custom trigger resource specification that custom trigger gRPC server knows how to interpret.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
value
class-attribute
instance-attribute
value = Field(default=None, title='Value is the allowed string values for this key\nBooleans are passed using strconv.ParseBool()\nNumbers are parsed using as float64 using strconv.ParseFloat()\nStrings are taken as is\nNils this value is ignored')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
username
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
type
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
transform
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.')
script
class-attribute
instance-attribute
script = Field(default=None, description='Script refers to a Lua script evaluated to determine the validity of an io.argoproj.workflow.v1alpha1.')
time
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventDependencyTransformer
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
jq
class-attribute
instance-attribute
script
class-attribute
instance-attribute
script = Field(default=None, title='Script refers to a Lua script used to transform the event\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventPersistence
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
catchup
class-attribute
instance-attribute
catchup = Field(default=None, title='Catchup enables to triggered the missed schedule when eventsource restarts')
config_map
class-attribute
instance-attribute
config_map = Field(default=None, alias='configMap', title='ConfigMap holds configmap details for persistence')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventSourceFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventSourceList
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
template
class-attribute
instance-attribute
template = Field(default=None, title='Template is the pod specification for the event source\n+optional')
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
EventSourceStatus
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ExprFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
expr
class-attribute
instance-attribute
expr = Field(default=None, description='Expr refers to the expression that determines the outcome of the filter.')
fields
class-attribute
instance-attribute
fields = Field(default=None, description='Fields refers to set of keys that refer to the paths within event payload.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
FileArtifact
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
watch_path_config
class-attribute
instance-attribute
watch_path_config = Field(default=None, alias='watchPathConfig', title='WatchPathConfig contains configuration about the file path to watch')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
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')
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GitCreds
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GitRemoteConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
name
class-attribute
instance-attribute
urls
class-attribute
instance-attribute
urls = Field(default=None, description='URLs the URLs of a remote repository. It must be non-empty. Fetch will\nalways use the first URL, while push will use all of them.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
installation_id
class-attribute
instance-attribute
installation_id = Field(default=None, alias='installationID', title='InstallationID refers to the Installation ID of the GitHub app you created and installed')
private_key
class-attribute
instance-attribute
private_key = Field(default=None, alias='privateKey', title='PrivateKey refers to a K8s secret containing the GitHub app private key')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
GithubEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 |
|
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')
webhook
class-attribute
instance-attribute
webhook = Field(default=None, title='Webhook refers to the configuration required to run a http server')
webhook_secret
class-attribute
instance-attribute
webhook_secret = Field(default=None, alias='webhookSecret', title='WebhookSecret refers to K8s secret containing GitHub webhook secret\nhttps://developer.github.com/webhooks/securing/\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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"')
secret_token
class-attribute
instance-attribute
secret_token = Field(default=None, alias='secretToken', title='SecretToken references to k8 secret which holds the Secret Token used by webhook config')
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
watch_path_config
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Int64OrString
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
K8SResourcePolicy
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
backoff
class-attribute
instance-attribute
error_on_backoff_timeout
class-attribute
instance-attribute
error_on_backoff_timeout = Field(default=None, alias='errorOnBackoffTimeout', title='ErrorOnBackoffTimeout determines whether sensor should transition to error state if the trigger policy is unable to determine\nthe state of the resource')
labels
class-attribute
instance-attribute
labels = Field(default=None, title='Labels required to identify whether a resource is in success state')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
KafkaConsumerGroup
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
group_name
class-attribute
instance-attribute
oldest
class-attribute
instance-attribute
oldest = Field(default=None, title='When starting up a new group do we want to start from the oldest event (true) or the newest event (false), defaults to false\n+optional')
rebalance_strategy
class-attribute
instance-attribute
rebalance_strategy = Field(default=None, alias='rebalanceStrategy', title='Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
version
class-attribute
instance-attribute
version = Field(default=None, title='Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
KafkaTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
|
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
version
class-attribute
instance-attribute
version = Field(default=None, title='Specify what kafka version is being connected to enables certain features in sarama, defaults to 1.0.0\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
LogTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
interval_seconds
class-attribute
instance-attribute
interval_seconds = Field(default=None, alias='intervalSeconds', title='Only print messages every interval. Useful to prevent logging too much data for busy events.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Metadata
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
token
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
NATSTrigger
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
subject
class-attribute
instance-attribute
tls
class-attribute
instance-attribute
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
topic
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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")
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.')
version
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
OwnedRepositories
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
owner
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
topic_project_id
class-attribute
instance-attribute
topic_project_id = Field(default=None, alias='topicProjectID', title='TopicProjectID is GCP project ID for the topic.\nBy default, it is same as ProjectID.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
type
class-attribute
instance-attribute
type = Field(default=None, title='Type of the subscription.\nOnly "exclusive" and "shared" is supported.\nDefaults to exclusive.\n+optional')
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
topic
class-attribute
instance-attribute
topic = Field(default=None, title='Name of the topic.\nSee https://pulsar.apache.org/docs/en/concepts-messaging/')
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
RateLimit
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
requests_per_unit
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
username
class-attribute
instance-attribute
username = Field(default=None, title='Username required for ACL style authentication if any.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
username
class-attribute
instance-attribute
username = Field(default=None, title='Username required for ACL style authentication if any.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Resource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
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
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
labels
class-attribute
instance-attribute
labels = Field(default=None, title='Labels provide listing options to K8s API to watch resource/s.\nRefer https://kubernetes.io/docs/concepts/overview/working-with-objects/label-selectors/ for more io.argoproj.workflow.v1alpha1.\n+optional')
prefix
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
S3Artifact
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
S3Bucket
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
S3Filter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
SASLConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
mechanism
class-attribute
instance-attribute
mechanism = Field(default=None, title='SASLMechanism is the name of the enabled SASL mechanism.\nPossible values: OAUTHBEARER, PLAIN (defaults to PLAIN).\n+optional')
password
class-attribute
instance-attribute
user
class-attribute
instance-attribute
user = Field(default=None, title='User is the authentication identity (authcid) to present for\nSASL/PLAIN or SASL/SCRAM authentication')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
validate_signature
class-attribute
instance-attribute
validate_signature = Field(default=None, alias='validateSignature', title='ValidateSignature is boolean that can be set to true for SNS signature verification\n+optional')
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
session_token
class-attribute
instance-attribute
session_token = Field(default=None, alias='sessionToken', title='SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token\n+optional')
wait_time_seconds
class-attribute
instance-attribute
wait_time_seconds = Field(default=None, alias='waitTimeSeconds', description='WaitTimeSeconds is The duration (in seconds) for which the call waits for a message to arrive\nin the queue before returning.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
SecureHeader
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
value_from
class-attribute
instance-attribute
value_from = Field(default=None, alias='valueFrom', title='Values can be read from either secrets or configmaps')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Selector
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
operation
class-attribute
instance-attribute
operation = Field(default=None, title='Supported operations like ==, !=, <=, >= etc.\nDefaults to ==.\nRefer https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors for more io.argoproj.workflow.v1alpha1.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Sensor
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
SensorList
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
triggers
class-attribute
instance-attribute
triggers = Field(default=None, description='Triggers is a list of the things that this sensor evokes. These are the outputs from this sensor.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
SensorStatus
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
ports
class-attribute
instance-attribute
ports = Field(default=None, title='The list of ports that are exposed by this ClusterIP service.\n+patchMergeKey=port\n+patchStrategy=merge\n+listType=map\n+listMapKey=port\n+listMapKey=protocol')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
SlackEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
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')
signing_secret
class-attribute
instance-attribute
token
class-attribute
instance-attribute
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
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")
slack_token
class-attribute
instance-attribute
slack_token = Field(default=None, alias='slackToken', description='SlackToken refers to the Kubernetes secret that holds the slack token required to send messages.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
source
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Status
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
conditions
class-attribute
instance-attribute
conditions = Field(default=None, title="Conditions are the latest available observations of a resource's current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge")
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
StatusPolicy
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
StorageGridFilter
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
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')
webhook
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
client_key_secret
class-attribute
instance-attribute
client_key_secret = Field(default=None, alias='clientKeySecret', title='ClientKeySecret refers to the secret that contains the client key')
insecure_skip_verify
class-attribute
instance-attribute
insecure_skip_verify = Field(default=None, alias='insecureSkipVerify', title='If true, skips creation of TLSConfig with certs and creates an empty TLSConfig. (Defaults to false)\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
Template
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 |
|
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
volumes
class-attribute
instance-attribute
volumes = Field(default=None, title='Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1.\n+patchStrategy=merge\n+patchMergeKey=name\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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).')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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')
retry_strategy
class-attribute
instance-attribute
retry_strategy = Field(default=None, alias='retryStrategy', title='Retry strategy, defaults to no retry\n+optional')
template
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.")
operation
class-attribute
instance-attribute
operation = Field(default=None, description="Operation is what to do with the existing value at Dest, whether to\n'prepend', 'overwrite', or 'append' it.")
src
class-attribute
instance-attribute
src = Field(default=None, title='Src contains a source reference to the value of the parameter from a dependency')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.')
value
class-attribute
instance-attribute
value = Field(default=None, description='Value is the default literal value to use for this parameter source\nThis is only used if the DataKey is invalid.\nIf the DataKey is invalid and this is not defined, this param source will produce an error.')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
TriggerPolicy
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
k8s
class-attribute
instance-attribute
k8s = Field(default=None, title='K8SResourcePolicy refers to the policy used to check the state of K8s based triggers using using labels')
status
class-attribute
instance-attribute
status = Field(default=None, title='Status refers to the policy used to check the state of the trigger using response status')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
TriggerTemplate
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 |
|
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')
pulsar
class-attribute
instance-attribute
pulsar = Field(default=None, title='Pulsar refers to the trigger designed to place messages on Pulsar topic.\n+optional')
slack
class-attribute
instance-attribute
slack = Field(default=None, title='Slack refers to the trigger designed to send slack notification message.\n+optional')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
URLArtifact
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
path
class-attribute
instance-attribute
verify_cert
class-attribute
instance-attribute
verify_cert = Field(default=None, alias='verifyCert', title='VerifyCert decides whether the connection is secure or not')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
ValueFromSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
config_map_key_ref
class-attribute
instance-attribute
secret_key_ref
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
WatchPathConfig
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
directory
class-attribute
instance-attribute
path
class-attribute
instance-attribute
path = Field(default=None, title='Path is relative path of object to watch with respect to the directory')
path_regexp
class-attribute
instance-attribute
path_regexp = Field(default=None, alias='pathRegexp', title='PathRegexp is regexp of relative path of object to watch with respect to the directory')
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
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.')
server_key_secret
class-attribute
instance-attribute
server_key_secret = Field(default=None, alias='serverKeySecret', title='ServerKeyPath refers the file that contains private key')
url
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.
WebhookEventSource
Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py
webhook_context
class-attribute
instance-attribute
Config
Config class dictates the behavior of the underlying Pydantic model.
See Pydantic documentation for more info.
Source code in src/hera/shared/_base_model.py
allow_mutation
class-attribute
instance-attribute
supports mutating Hera objects post instantiation.
allow_population_by_field_name
class-attribute
instance-attribute
support populating Hera object fields via keyed dictionaries.
arbitrary_types_allowed
class-attribute
instance-attribute
supports specifying arbitrary types for any field to support Hera object fields processing.
extra
class-attribute
instance-attribute
forbids extra fields from being added to Hera objects. This protects users from using the wrong kwargs.
smart_union
class-attribute
instance-attribute
uses smart union for matching a field’s specified value to the underlying type that’s part of a union.