Skip to content

Hera Events Auto-generated Models

hera.events.models

AMQPConsumeConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class AMQPConsumeConfig(BaseModel):
    auto_ack: Annotated[
        Optional[bool],
        Field(
            alias="autoAck",
            title=(
                "AutoAck when true, the server will acknowledge deliveries to this"
                " consumer prior to writing\nthe delivery to the network\n+optional"
            ),
        ),
    ] = None
    consumer_tag: Annotated[
        Optional[str],
        Field(
            alias="consumerTag",
            title=("ConsumerTag is the identity of the consumer included in every delivery\n+optional"),
        ),
    ] = None
    exclusive: Annotated[
        Optional[bool],
        Field(
            title=(
                "Exclusive when true, the server will ensure that this is the sole consumer from this queue\n+optional"
            )
        ),
    ] = None
    no_local: Annotated[
        Optional[bool],
        Field(
            alias="noLocal",
            title="NoLocal flag is not supported by RabbitMQ\n+optional",
        ),
    ] = None
    no_wait: Annotated[
        Optional[bool],
        Field(
            alias="noWait",
            title=(
                "NowWait when true, do not wait for the server to confirm the request"
                " and immediately begin deliveries\n+optional"
            ),
        ),
    ] = None

auto_ack class-attribute instance-attribute 

auto_ack = None

consumer_tag class-attribute instance-attribute 

consumer_tag = None

exclusive class-attribute instance-attribute 

exclusive = None

no_local class-attribute instance-attribute 

no_local = None

no_wait class-attribute instance-attribute 

no_wait = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AMQPEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
class AMQPEventSource(BaseModel):
    auth: Annotated[
        Optional[BasicAuth],
        Field(title="Auth hosts secret selectors for username and password\n+optional"),
    ] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            title="Backoff holds parameters applied to connection.\n+optional",
        ),
    ] = None
    consume: Annotated[
        Optional[AMQPConsumeConfig],
        Field(
            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"
            )
        ),
    ] = None
    exchange_declare: Annotated[
        Optional[AMQPExchangeDeclareConfig],
        Field(
            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"
            ),
        ),
    ] = None
    exchange_name: Annotated[
        Optional[str],
        Field(
            alias="exchangeName",
            title=(
                "ExchangeName is the exchange name\nFor more information, visit"
                " https://www.rabbitmq.com/tutorials/amqp-concepts.html"
            ),
        ),
    ] = None
    exchange_type: Annotated[
        Optional[str],
        Field(alias="exchangeType", title="ExchangeType is rabbitmq exchange type"),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    queue_bind: Annotated[
        Optional[AMQPQueueBindConfig],
        Field(
            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"
            ),
        ),
    ] = None
    queue_declare: Annotated[
        Optional[AMQPQueueDeclareConfig],
        Field(
            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"
            ),
        ),
    ] = None
    routing_key: Annotated[Optional[str], Field(alias="routingKey", title="Routing key for bindings")] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the amqp client.\n+optional"),
    ] = None
    url: Annotated[Optional[str], Field(title="URL for rabbitmq service")] = None
    url_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="urlSecret",
            title="URLSecret is secret reference for rabbitmq service URL",
        ),
    ] = None

auth class-attribute instance-attribute 

auth = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

consume class-attribute instance-attribute 

consume = None

exchange_declare class-attribute instance-attribute 

exchange_declare = None

exchange_name class-attribute instance-attribute 

exchange_name = None

exchange_type class-attribute instance-attribute 

exchange_type = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

queue_bind class-attribute instance-attribute 

queue_bind = None

queue_declare class-attribute instance-attribute 

queue_declare = None

routing_key class-attribute instance-attribute 

routing_key = None

tls class-attribute instance-attribute 

tls = None

url class-attribute instance-attribute 

url = None

url_secret class-attribute instance-attribute 

url_secret = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AMQPExchangeDeclareConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
class AMQPExchangeDeclareConfig(BaseModel):
    auto_delete: Annotated[
        Optional[bool],
        Field(
            alias="autoDelete",
            title=("AutoDelete removes the exchange when no bindings are active\n+optional"),
        ),
    ] = None
    durable: Annotated[
        Optional[bool],
        Field(title="Durable keeps the exchange also after the server restarts\n+optional"),
    ] = None
    internal: Annotated[
        Optional[bool],
        Field(title="Internal when true does not accept publishings\n+optional"),
    ] = None
    no_wait: Annotated[
        Optional[bool],
        Field(
            alias="noWait",
            title=("NowWait when true does not wait for a confirmation from the server\n+optional"),
        ),
    ] = None

auto_delete class-attribute instance-attribute 

auto_delete = None

durable class-attribute instance-attribute 

durable = None

internal class-attribute instance-attribute 

internal = None

no_wait class-attribute instance-attribute 

no_wait = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AMQPQueueBindConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
88
89
90
91
92
93
94
95
96
97
class AMQPQueueBindConfig(BaseModel):
    no_wait: Annotated[
        Optional[bool],
        Field(
            alias="noWait",
            title=(
                "NowWait false and the queue could not be bound, the channel will be closed with an error\n+optional"
            ),
        ),
    ] = None

no_wait class-attribute instance-attribute 

no_wait = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AMQPQueueDeclareConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
class AMQPQueueDeclareConfig(BaseModel):
    arguments: Annotated[
        Optional[str],
        Field(
            title=(
                'Arguments of a queue (also known as "x-arguments") used for optional features and plugins\n+optional'
            )
        ),
    ] = None
    auto_delete: Annotated[
        Optional[bool],
        Field(
            alias="autoDelete",
            title=("AutoDelete removes the queue when no consumers are active\n+optional"),
        ),
    ] = None
    durable: Annotated[
        Optional[bool],
        Field(title="Durable keeps the queue also after the server restarts\n+optional"),
    ] = None
    exclusive: Annotated[
        Optional[bool],
        Field(
            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"
            )
        ),
    ] = None
    name: Annotated[
        Optional[str],
        Field(title=("Name of the queue. If empty the server auto-generates a unique name for this queue\n+optional")),
    ] = None
    no_wait: Annotated[
        Optional[bool],
        Field(
            alias="noWait",
            title=("NowWait when true, the queue assumes to be declared on the server\n+optional"),
        ),
    ] = None

arguments class-attribute instance-attribute 

arguments = None

auto_delete class-attribute instance-attribute 

auto_delete = None

durable class-attribute instance-attribute 

durable = None

exclusive class-attribute instance-attribute 

exclusive = None

name class-attribute instance-attribute 

name = None

no_wait class-attribute instance-attribute 

no_wait = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AWSLambdaTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
class AWSLambdaTrigger(BaseModel):
    access_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="accessKey",
            title="AccessKey refers K8s secret containing aws access key\n+optional",
        ),
    ] = None
    function_name: Annotated[
        Optional[str],
        Field(
            alias="functionName",
            description="FunctionName refers to the name of the function to invoke.",
        ),
    ] = None
    invocation_type: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    region: Annotated[Optional[str], Field(title="Region is AWS region")] = None
    role_arn: Annotated[
        Optional[str],
        Field(
            alias="roleARN",
            title=("RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional"),
        ),
    ] = None
    secret_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="secretKey",
            title="SecretKey refers K8s secret containing aws secret key\n+optional",
        ),
    ] = None

access_key class-attribute instance-attribute 

access_key = None

function_name class-attribute instance-attribute 

function_name = None

invocation_type class-attribute instance-attribute 

invocation_type = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

region class-attribute instance-attribute 

region = None

role_arn class-attribute instance-attribute 

role_arn = None

secret_key class-attribute instance-attribute 

secret_key = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Amount

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
143
144
class Amount(BaseModel):
    value: Optional[str] = None

value class-attribute instance-attribute 

value = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ArgoWorkflowTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
class ArgoWorkflowTrigger(BaseModel):
    args: Annotated[
        Optional[List[str]],
        Field(title="Args is the list of arguments to pass to the argo CLI"),
    ] = None
    operation: Annotated[
        Optional[str],
        Field(
            title=(
                "Operation refers to the type of operation performed on the argo"
                " workflow resource.\nDefault value is Submit.\n+optional"
            )
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(title=("Parameters is the list of parameters to pass to resolved Argo Workflow object")),
    ] = None
    source: Annotated[Optional[ArtifactLocation], Field(title="Source of the K8s resource file(s)")] = None

args class-attribute instance-attribute 

args = None

operation class-attribute instance-attribute 

operation = None

parameters class-attribute instance-attribute 

parameters = None

source class-attribute instance-attribute 

source = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ArtifactLocation

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
class ArtifactLocation(BaseModel):
    configmap: Annotated[
        Optional[v1_1.ConfigMapKeySelector],
        Field(title="Configmap that stores the artifact"),
    ] = None
    file: Annotated[
        Optional[FileArtifact],
        Field(title="File artifact is artifact stored in a file"),
    ] = None
    git: Annotated[Optional[GitArtifact], Field(title="Git repository hosting the artifact")] = None
    inline: Annotated[
        Optional[str],
        Field(title="Inline artifact is embedded in sensor spec as a string"),
    ] = None
    resource: Annotated[Optional[Resource], Field(title="Resource is generic template for K8s resource")] = None
    s3: Annotated[Optional[S3Artifact], Field(title="S3 compliant artifact")] = None
    url: Annotated[Optional[URLArtifact], Field(title="URL to fetch the artifact from")] = None

configmap class-attribute instance-attribute 

configmap = None

file class-attribute instance-attribute 

file = None

git class-attribute instance-attribute 

git = None

inline class-attribute instance-attribute 

inline = None

resource class-attribute instance-attribute 

resource = None

s3 class-attribute instance-attribute 

s3 = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AzureEventHubsTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
class AzureEventHubsTrigger(BaseModel):
    fqdn: Annotated[
        Optional[str],
        Field(
            title=(
                "FQDN refers to the namespace dns of Azure Event Hubs to be used i.e."
                " <namespace>.servicebus.windows.net"
            )
        ),
    ] = None
    hub_name: Annotated[
        Optional[str],
        Field(
            alias="hubName",
            title="HubName refers to the Azure Event Hub to send events to",
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    shared_access_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sharedAccessKey",
            title=("SharedAccessKey refers to a K8s secret containing the primary key for the"),
        ),
    ] = None
    shared_access_key_name: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sharedAccessKeyName",
            title="SharedAccessKeyName refers to the name of the Shared Access Key",
        ),
    ] = None

fqdn class-attribute instance-attribute 

fqdn = None

hub_name class-attribute instance-attribute 

hub_name = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

shared_access_key class-attribute instance-attribute 

shared_access_key = None

shared_access_key_name class-attribute instance-attribute 

shared_access_key_name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AzureEventsHubEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
class AzureEventsHubEventSource(BaseModel):
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    fqdn: Annotated[
        Optional[str],
        Field(
            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"
            )
        ),
    ] = None
    hub_name: Annotated[Optional[str], Field(alias="hubName", title="Event Hub path/name")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    shared_access_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sharedAccessKey",
            title="SharedAccessKey is the generated value of the key",
        ),
    ] = None
    shared_access_key_name: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sharedAccessKeyName",
            title=("SharedAccessKeyName is the name you chose for your application's SAS keys"),
        ),
    ] = None

filter class-attribute instance-attribute 

filter = None

fqdn class-attribute instance-attribute 

fqdn = None

hub_name class-attribute instance-attribute 

hub_name = None

metadata class-attribute instance-attribute 

metadata = None

shared_access_key class-attribute instance-attribute 

shared_access_key = None

shared_access_key_name class-attribute instance-attribute 

shared_access_key_name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AzureQueueStorageEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
class AzureQueueStorageEventSource(BaseModel):
    connection_string: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="connectionString",
            title=(
                "ConnectionString is the connection string to access Azure Queue"
                " Storage. If this fields is not provided\nit will try to access via"
                " Azure AD with StorageAccountName.\n+optional"
            ),
        ),
    ] = None
    decode_message: Annotated[
        Optional[bool],
        Field(
            alias="decodeMessage",
            title=(
                "DecodeMessage specifies if all the messages should be base64"
                " decoded.\nIf set to true the decoding is done before the evaluation"
                " of JSONBody\n+optional"
            ),
        ),
    ] = None
    dlq: Annotated[
        Optional[bool],
        Field(
            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"
            )
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    queue_name: Annotated[
        Optional[str],
        Field(alias="queueName", title="QueueName is the name of the queue"),
    ] = None
    storage_account_name: Annotated[
        Optional[str],
        Field(
            alias="storageAccountName",
            title=(
                "StorageAccountName is the name of the storage account where the queue"
                " is. This field is necessary to\naccess via Azure AD (managed"
                " identity) and it is ignored if ConnectionString is set.\n+optional"
            ),
        ),
    ] = None
    wait_time_in_seconds: Annotated[
        Optional[int],
        Field(
            alias="waitTimeInSeconds",
            title=(
                "WaitTimeInSeconds is the duration (in seconds) for which the event"
                " source waits between empty results from the queue.\nThe default value"
                " is 3 seconds.\n+optional"
            ),
        ),
    ] = None

connection_string class-attribute instance-attribute 

connection_string = None

decode_message class-attribute instance-attribute 

decode_message = None

dlq class-attribute instance-attribute 

dlq = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

queue_name class-attribute instance-attribute 

queue_name = None

storage_account_name class-attribute instance-attribute 

storage_account_name = None

wait_time_in_seconds class-attribute instance-attribute 

wait_time_in_seconds = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AzureServiceBusEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
class AzureServiceBusEventSource(BaseModel):
    connection_string: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="connectionString",
            title=(
                "ConnectionString is the connection string for the Azure Service Bus."
                " If this fields is not provided\nit will try to access via Azure AD"
                " with DefaultAzureCredential and FullyQualifiedNamespace.\n+optional"
            ),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    fully_qualified_namespace: Annotated[
        Optional[str],
        Field(
            alias="fullyQualifiedNamespace",
            title=(
                "FullyQualifiedNamespace is the Service Bus namespace name (ex:"
                " myservicebus.servicebus.windows.net). This field is necessary"
                " to\naccess via Azure AD (managed identity) and it is ignored if"
                " ConnectionString is set.\n+optional"
            ),
        ),
    ] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    queue_name: Annotated[
        Optional[str],
        Field(
            alias="queueName",
            title="QueueName is the name of the Azure Service Bus Queue",
        ),
    ] = None
    subscription_name: Annotated[
        Optional[str],
        Field(
            alias="subscriptionName",
            title=("SubscriptionName is the name of the Azure Service Bus Topic Subscription"),
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the service bus client\n+optional"),
    ] = None
    topic_name: Annotated[
        Optional[str],
        Field(
            alias="topicName",
            title="TopicName is the name of the Azure Service Bus Topic",
        ),
    ] = None

connection_string class-attribute instance-attribute 

connection_string = None

filter class-attribute instance-attribute 

filter = None

fully_qualified_namespace class-attribute instance-attribute 

fully_qualified_namespace = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

queue_name class-attribute instance-attribute 

queue_name = None

subscription_name class-attribute instance-attribute 

subscription_name = None

tls class-attribute instance-attribute 

tls = None

topic_name class-attribute instance-attribute 

topic_name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

AzureServiceBusTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
class AzureServiceBusTrigger(BaseModel):
    connection_string: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="connectionString",
            title="ConnectionString is the connection string for the Azure Service Bus",
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    queue_name: Annotated[
        Optional[str],
        Field(
            alias="queueName",
            title="QueueName is the name of the Azure Service Bus Queue",
        ),
    ] = None
    subscription_name: Annotated[
        Optional[str],
        Field(
            alias="subscriptionName",
            title=("SubscriptionName is the name of the Azure Service Bus Topic Subscription"),
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the service bus client\n+optional"),
    ] = None
    topic_name: Annotated[
        Optional[str],
        Field(
            alias="topicName",
            title="TopicName is the name of the Azure Service Bus Topic",
        ),
    ] = None

connection_string class-attribute instance-attribute 

connection_string = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

queue_name class-attribute instance-attribute 

queue_name = None

subscription_name class-attribute instance-attribute 

subscription_name = None

tls class-attribute instance-attribute 

tls = None

topic_name class-attribute instance-attribute 

topic_name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Backoff

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
class Backoff(BaseModel):
    duration: Annotated[
        Optional[Int64OrString],
        Field(title=('The initial duration in nanoseconds or strings like "1s", "3m"\n+optional')),
    ] = None
    factor: Annotated[
        Optional[Amount],
        Field(title="Duration is multiplied by factor each iteration\n+optional"),
    ] = None
    jitter: Annotated[
        Optional[Amount],
        Field(title="The amount of jitter applied each iteration\n+optional"),
    ] = None
    steps: Annotated[Optional[int], Field(title="Exit with error after this many steps\n+optional")] = None

duration class-attribute instance-attribute 

duration = None

factor class-attribute instance-attribute 

factor = None

jitter class-attribute instance-attribute 

jitter = None

steps class-attribute instance-attribute 

steps = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BasicAuth

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
809
810
811
812
813
814
815
816
817
818
819
820
821
class BasicAuth(BaseModel):
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            description=("Password refers to the Kubernetes secret that holds the password required for basic auth.")
        ),
    ] = None
    username: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            description=("Username refers to the Kubernetes secret that holds the username required for basic auth.")
        ),
    ] = None

password class-attribute instance-attribute 

password = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketAuth

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
class BitbucketAuth(BaseModel):
    basic: Annotated[
        Optional[BitbucketBasicAuth],
        Field(title="Basic is BasicAuth auth strategy.\n+optional"),
    ] = None
    oauth_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="oauthToken",
            title=("OAuthToken refers to the K8s secret that holds the OAuth Bearer token.\n+optional"),
        ),
    ] = None

basic class-attribute instance-attribute 

basic = None

oauth_token class-attribute instance-attribute 

oauth_token = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketBasicAuth

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
824
825
826
827
828
829
830
831
832
class BitbucketBasicAuth(BaseModel):
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(description="Password refers to the K8s secret that holds the password."),
    ] = None
    username: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(description="Username refers to the K8s secret that holds the username."),
    ] = None

password class-attribute instance-attribute 

password = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
class BitbucketEventSource(BaseModel):
    auth: Annotated[
        Optional[BitbucketAuth],
        Field(description="Auth information required to connect to Bitbucket."),
    ] = None
    delete_hook_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteHookOnFinish",
            title=(
                "DeleteHookOnFinish determines whether to delete the defined Bitbucket"
                " hook once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    events: Annotated[Optional[List[str]], Field(description="Events this webhook is subscribed to.")] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will be passed along the event payload.\n+optional")
        ),
    ] = None
    owner: Annotated[
        Optional[str],
        Field(
            title=(
                "DeprecatedOwner is the owner of the repository.\nDeprecated: use"
                " Repositories instead. Will be unsupported in v1.9\n+optional"
            )
        ),
    ] = None
    project_key: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    repositories: Annotated[
        Optional[List[BitbucketRepository]],
        Field(title=("Repositories holds a list of repositories for which integration needs to set up\n+optional")),
    ] = None
    repository_slug: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook refers to the configuration required to run an http server"),
    ] = None

auth class-attribute instance-attribute 

auth = None

delete_hook_on_finish class-attribute instance-attribute 

delete_hook_on_finish = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

owner class-attribute instance-attribute 

owner = None

project_key class-attribute instance-attribute 

project_key = None

repositories class-attribute instance-attribute 

repositories = None

repository_slug class-attribute instance-attribute 

repository_slug = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketRepository

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
172
173
174
175
176
177
178
179
180
181
182
183
class BitbucketRepository(BaseModel):
    owner: Annotated[Optional[str], Field(title="Owner is the owner of the repository")] = None
    repository_slug: Annotated[
        Optional[str],
        Field(
            alias="repositorySlug",
            title=(
                "RepositorySlug is a URL-friendly version of a repository name,"
                " automatically generated by Bitbucket for use in the URL"
            ),
        ),
    ] = None

owner class-attribute instance-attribute 

owner = None

repository_slug class-attribute instance-attribute 

repository_slug = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketServerEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
class BitbucketServerEventSource(BaseModel):
    access_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="accessToken",
            title=("AccessToken is reference to K8s secret which holds the bitbucket api access information"),
        ),
    ] = None
    bitbucketserver_base_url: Annotated[
        Optional[str],
        Field(
            alias="bitbucketserverBaseURL",
            title=("BitbucketServerBaseURL is the base URL for API requests to a custom endpoint"),
        ),
    ] = None
    delete_hook_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteHookOnFinish",
            title=(
                "DeleteHookOnFinish determines whether to delete the Bitbucket Server"
                " hook for the project once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    events: Annotated[
        Optional[List[str]],
        Field(
            title=(
                "Events are bitbucket event to listen to.\nRefer"
                " https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html"
            )
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    project_key: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    repositories: Annotated[
        Optional[List[BitbucketServerRepository]],
        Field(title=("Repositories holds a list of repositories for which integration needs to set up\n+optional")),
    ] = None
    repository_slug: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the bitbucketserver client.\n+optional"),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration to run a http server"),
    ] = None
    webhook_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="webhookSecret",
            title=(
                "WebhookSecret is reference to K8s secret which holds the bitbucket"
                " webhook secret (for HMAC validation)"
            ),
        ),
    ] = None

access_token class-attribute instance-attribute 

access_token = None

bitbucketserver_base_url class-attribute instance-attribute 

bitbucketserver_base_url = None

delete_hook_on_finish class-attribute instance-attribute 

delete_hook_on_finish = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

project_key class-attribute instance-attribute 

project_key = None

repositories class-attribute instance-attribute 

repositories = None

repository_slug class-attribute instance-attribute 

repository_slug = None

tls class-attribute instance-attribute 

tls = None

webhook class-attribute instance-attribute 

webhook = None

webhook_secret class-attribute instance-attribute 

webhook_secret = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

BitbucketServerRepository

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
class BitbucketServerRepository(BaseModel):
    project_key: Annotated[
        Optional[str],
        Field(
            alias="projectKey",
            title=("ProjectKey is the key of project for which integration needs to set up"),
        ),
    ] = None
    repository_slug: Annotated[
        Optional[str],
        Field(
            alias="repositorySlug",
            title=("RepositorySlug is the slug of the repository for which integration needs to set up"),
        ),
    ] = None

project_key class-attribute instance-attribute 

project_key = None

repository_slug class-attribute instance-attribute 

repository_slug = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

CalendarEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
class CalendarEventSource(BaseModel):
    exclusion_dates: Annotated[
        Optional[List[str]],
        Field(
            alias="exclusionDates",
            description=("ExclusionDates defines the list of DATE-TIME exceptions for recurring events."),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    interval: Annotated[
        Optional[str],
        Field(title=("Interval is a string that describes an interval duration, e.g. 1s, 30m, 2h...\n+optional")),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    persistence: Annotated[
        Optional[EventPersistence],
        Field(title="Persistence hold the configuration for event persistence"),
    ] = None
    schedule: Annotated[
        Optional[str],
        Field(
            title=(
                "Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron\n+optional"
            )
        ),
    ] = None
    timezone: Annotated[Optional[str], Field(title="Timezone in which to run the schedule\n+optional")] = None

exclusion_dates class-attribute instance-attribute 

exclusion_dates = None

filter class-attribute instance-attribute 

filter = None

interval class-attribute instance-attribute 

interval = None

metadata class-attribute instance-attribute 

metadata = None

persistence class-attribute instance-attribute 

persistence = None

schedule class-attribute instance-attribute 

schedule = None

timezone class-attribute instance-attribute 

timezone = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

CatchupConfiguration

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
203
204
205
206
207
208
209
210
211
class CatchupConfiguration(BaseModel):
    enabled: Annotated[
        Optional[bool],
        Field(title=("Enabled enables to triggered the missed schedule when eventsource restarts")),
    ] = None
    max_duration: Annotated[
        Optional[str],
        Field(alias="maxDuration", title="MaxDuration holds max catchup duration"),
    ] = None

enabled class-attribute instance-attribute 

enabled = None

max_duration class-attribute instance-attribute 

max_duration = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Condition

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
class Condition(BaseModel):
    last_transition_time: Annotated[
        Optional[v1.Time],
        Field(
            alias="lastTransitionTime",
            title=("Last time the condition transitioned from one status to another.\n+optional"),
        ),
    ] = None
    message: Annotated[
        Optional[str],
        Field(title=("Human-readable message indicating details about last transition.\n+optional")),
    ] = None
    reason: Annotated[
        Optional[str],
        Field(
            title=(
                "Unique, this should be a short, machine understandable string that"
                " gives the reason\nfor condition's last transition. For example,"
                ' "ImageNotFound"\n+optional'
            )
        ),
    ] = None
    status: Annotated[
        Optional[str],
        Field(title="Condition status, True, False or Unknown.\n+required"),
    ] = None
    type: Annotated[Optional[str], Field(title="Condition type.\n+required")] = None

last_transition_time class-attribute instance-attribute 

last_transition_time = None

message class-attribute instance-attribute 

message = None

reason class-attribute instance-attribute 

reason = None

status class-attribute instance-attribute 

status = None

type class-attribute instance-attribute 

type = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ConditionsResetByTime

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
214
215
216
217
218
219
class ConditionsResetByTime(BaseModel):
    cron: Annotated[
        Optional[str],
        Field(title=("Cron is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron")),
    ] = None
    timezone: Annotated[Optional[str], Field(title="+optional")] = None

cron class-attribute instance-attribute 

cron = None

timezone class-attribute instance-attribute 

timezone = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ConditionsResetCriteria

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1197
1198
1199
1200
1201
1202
1203
1204
class ConditionsResetCriteria(BaseModel):
    by_time: Annotated[
        Optional[ConditionsResetByTime],
        Field(
            alias="byTime",
            title=("Schedule is a cron-like expression. For reference, see: https://en.wikipedia.org/wiki/Cron"),
        ),
    ] = None

by_time class-attribute instance-attribute 

by_time = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ConfigMapPersistence

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
222
223
224
225
226
227
228
229
230
class ConfigMapPersistence(BaseModel):
    create_if_not_exist: Annotated[
        Optional[bool],
        Field(
            alias="createIfNotExist",
            title="CreateIfNotExist will create configmap if it doesn't exists",
        ),
    ] = None
    name: Annotated[Optional[str], Field(title="Name of the configmap")] = None

create_if_not_exist class-attribute instance-attribute 

create_if_not_exist = None

name class-attribute instance-attribute 

name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

CustomTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
class CustomTrigger(BaseModel):
    cert_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="certSecret",
            description=(
                "CertSecret refers to the secret that contains cert for secure"
                " connection between sensor and custom trigger gRPC server."
            ),
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Parameters is the list of parameters that is applied to resolved custom trigger trigger object."
            )
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    secure: Annotated[
        Optional[bool],
        Field(title=("Secure refers to type of the connection between sensor to custom trigger gRPC")),
    ] = None
    server_name_override: Annotated[
        Optional[str],
        Field(
            alias="serverNameOverride",
            description=(
                "ServerNameOverride for the secure connection between sensor and custom trigger gRPC server."
            ),
        ),
    ] = None
    server_url: Annotated[
        Optional[str],
        Field(
            alias="serverURL",
            title=("ServerURL is the url of the gRPC server that executes custom trigger"),
        ),
    ] = None
    spec: Annotated[
        Optional[Dict[str, str]],
        Field(
            description=(
                "Spec is the custom trigger resource specification that custom trigger"
                " gRPC server knows how to interpret."
            )
        ),
    ] = None

cert_secret class-attribute instance-attribute 

cert_secret = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

secure class-attribute instance-attribute 

secure = None

server_name_override class-attribute instance-attribute 

server_name_override = None

server_url class-attribute instance-attribute 

server_url = None

spec class-attribute instance-attribute 

spec = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

DataFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
class DataFilter(BaseModel):
    comparator: Annotated[
        Optional[str],
        Field(
            description=(
                "Comparator compares the event data with a user given value.\nCan be"
                ' ">=", ">", "=", "!=", "<", or "<=".\nIs optional, and if left blank'
                ' treated as equality "=".'
            )
        ),
    ] = None
    path: Annotated[
        Optional[str],
        Field(
            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."
            )
        ),
    ] = None
    template: Annotated[
        Optional[str],
        Field(
            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/"
            )
        ),
    ] = None
    type: Annotated[Optional[str], Field(title="Type contains the JSON type of the data")] = None
    value: Annotated[
        Optional[List[str]],
        Field(
            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"
            )
        ),
    ] = None

comparator class-attribute instance-attribute 

comparator = None

path class-attribute instance-attribute 

path = None

template class-attribute instance-attribute 

template = None

type class-attribute instance-attribute 

type = None

value class-attribute instance-attribute 

value = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EmailTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
class EmailTrigger(BaseModel):
    body: Annotated[
        Optional[str],
        Field(title="Body refers to the body/content of the email send.\n+optional"),
    ] = None
    from_: Annotated[
        Optional[str],
        Field(
            alias="from",
            title=("From refers to the address from which the email is send from.\n+optional"),
        ),
    ] = None
    host: Annotated[
        Optional[str],
        Field(description="Host refers to the smtp host url to which email is send."),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    port: Annotated[
        Optional[int],
        Field(title=("Port refers to the smtp server port to which email is send.\nDefaults to 0.\n+optional")),
    ] = None
    smtp_password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="smtpPassword",
            title=(
                "SMTPPassword refers to the Kubernetes secret that holds the smtp"
                " password used to connect to smtp server.\n+optional"
            ),
        ),
    ] = None
    subject: Annotated[
        Optional[str],
        Field(title="Subject refers to the subject line for the email send.\n+optional"),
    ] = None
    to: Annotated[
        Optional[List[str]],
        Field(title=("To refers to the email addresses to which the emails are send.\n+optional")),
    ] = None
    username: Annotated[
        Optional[str],
        Field(title=("Username refers to the username used to connect to the smtp server.\n+optional")),
    ] = None

body class-attribute instance-attribute 

body = None

from_ class-attribute instance-attribute 

from_ = None

host class-attribute instance-attribute 

host = None

parameters class-attribute instance-attribute 

parameters = None

port class-attribute instance-attribute 

port = None

smtp_password class-attribute instance-attribute 

smtp_password = None

subject class-attribute instance-attribute 

subject = None

to class-attribute instance-attribute 

to = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EmitterEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
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
class EmitterEventSource(BaseModel):
    broker: Annotated[Optional[str], Field(description="Broker URI to connect to.")] = None
    channel_key: Annotated[
        Optional[str],
        Field(alias="channelKey", title="ChannelKey refers to the channel key"),
    ] = None
    channel_name: Annotated[
        Optional[str],
        Field(alias="channelName", title="ChannelName refers to the channel name"),
    ] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            title="Backoff holds parameters applied to connection.\n+optional",
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Password to use to connect to broker\n+optional"),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the emitter client.\n+optional"),
    ] = None
    username: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Username to use to connect to broker\n+optional"),
    ] = None

broker class-attribute instance-attribute 

broker = None

channel_key class-attribute instance-attribute 

channel_key = None

channel_name class-attribute instance-attribute 

channel_name = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

password class-attribute instance-attribute 

password = None

tls class-attribute instance-attribute 

tls = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventContext

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
class EventContext(BaseModel):
    datacontenttype: Annotated[
        Optional[str],
        Field(description=("DataContentType - A MIME (RFC2046) string describing the media type of `data`.")),
    ] = None
    id: Annotated[
        Optional[str],
        Field(description=("ID of the event; must be non-empty and unique within the scope of the producer.")),
    ] = None
    source: Annotated[
        Optional[str],
        Field(description="Source - A URI describing the event producer."),
    ] = None
    specversion: Annotated[
        Optional[str],
        Field(
            description=(
                "SpecVersion - The version of the CloudEvents specification used by the io.argoproj.workflow.v1alpha1."
            )
        ),
    ] = None
    subject: Annotated[
        Optional[str],
        Field(title=("Subject - The subject of the event in the context of the event producer")),
    ] = None
    time: Annotated[
        Optional[v1.Time],
        Field(description="Time - A Timestamp when the event happened."),
    ] = None
    type: Annotated[
        Optional[str],
        Field(description="Type - The type of the occurrence which has happened."),
    ] = None

datacontenttype class-attribute instance-attribute 

datacontenttype = None

id class-attribute instance-attribute 

id = None

source class-attribute instance-attribute 

source = None

specversion class-attribute instance-attribute 

specversion = None

subject class-attribute instance-attribute 

subject = None

time class-attribute instance-attribute 

time = None

type class-attribute instance-attribute 

type = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventDependency

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
class EventDependency(BaseModel):
    event_name: Annotated[
        Optional[str],
        Field(alias="eventName", title="EventName is the name of the event"),
    ] = None
    event_source_name: Annotated[
        Optional[str],
        Field(
            alias="eventSourceName",
            title="EventSourceName is the name of EventSource that Sensor depends on",
        ),
    ] = None
    filters: Annotated[
        Optional[EventDependencyFilter],
        Field(
            title=(
                "Filters and rules governing toleration of success and constraints on the context and data of an event"
            )
        ),
    ] = None
    filters_logical_operator: Annotated[
        Optional[str],
        Field(
            alias="filtersLogicalOperator",
            description=(
                "FiltersLogicalOperator defines how different filters are evaluated"
                " together.\nAvailable values: and (&&), or (||)\nIs optional and if"
                " left blank treated as and (&&)."
            ),
        ),
    ] = None
    name: Annotated[Optional[str], Field(title="Name is a unique name of this dependency")] = None
    transform: Annotated[
        Optional[EventDependencyTransformer],
        Field(title="Transform transforms the event data"),
    ] = None

event_name class-attribute instance-attribute 

event_name = None

event_source_name class-attribute instance-attribute 

event_source_name = None

filters class-attribute instance-attribute 

filters = None

filters_logical_operator class-attribute instance-attribute 

filters_logical_operator = None

name class-attribute instance-attribute 

name = None

transform class-attribute instance-attribute 

transform = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventDependencyFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
class EventDependencyFilter(BaseModel):
    context: Annotated[Optional[EventContext], Field(title="Context filter constraints")] = None
    data: Annotated[
        Optional[List[DataFilter]],
        Field(title="Data filter constraints with escalation"),
    ] = None
    data_logical_operator: Annotated[
        Optional[str],
        Field(
            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 (&&)."
            ),
        ),
    ] = None
    expr_logical_operator: Annotated[
        Optional[str],
        Field(
            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 (&&)."
            ),
        ),
    ] = None
    exprs: Annotated[
        Optional[List[ExprFilter]],
        Field(description=("Exprs contains the list of expressions evaluated against the event payload.")),
    ] = None
    script: Annotated[
        Optional[str],
        Field(
            description=(
                "Script refers to a Lua script evaluated to determine the validity of"
                " an io.argoproj.workflow.v1alpha1."
            )
        ),
    ] = None
    time: Annotated[Optional[TimeFilter], Field(title="Time filter on the event with escalation")] = None

context class-attribute instance-attribute 

context = None

data class-attribute instance-attribute 

data = None

data_logical_operator class-attribute instance-attribute 

data_logical_operator = None

expr_logical_operator class-attribute instance-attribute 

expr_logical_operator = None

exprs class-attribute instance-attribute 

exprs = None

script class-attribute instance-attribute 

script = None

time class-attribute instance-attribute 

time = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventDependencyTransformer

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
284
285
286
287
288
289
290
291
292
class EventDependencyTransformer(BaseModel):
    jq: Annotated[
        Optional[str],
        Field(title="JQ holds the jq command applied for transformation\n+optional"),
    ] = None
    script: Annotated[
        Optional[str],
        Field(title="Script refers to a Lua script used to transform the event\n+optional"),
    ] = None

jq class-attribute instance-attribute 

jq = None

script class-attribute instance-attribute 

script = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventPersistence

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1207
1208
1209
1210
1211
1212
1213
1214
1215
class EventPersistence(BaseModel):
    catchup: Annotated[
        Optional[CatchupConfiguration],
        Field(title=("Catchup enables to triggered the missed schedule when eventsource restarts")),
    ] = None
    config_map: Annotated[
        Optional[ConfigMapPersistence],
        Field(alias="configMap", title="ConfigMap holds configmap details for persistence"),
    ] = None

catchup class-attribute instance-attribute 

catchup = None

config_map class-attribute instance-attribute 

config_map = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
4023
4024
4025
4026
class EventSource(BaseModel):
    metadata: Optional[v1.ObjectMeta] = None
    spec: Optional[EventSourceSpec] = None
    status: Annotated[Optional[EventSourceStatus], Field(title="+optional")] = None

metadata class-attribute instance-attribute 

metadata = None

spec class-attribute instance-attribute 

spec = None

status class-attribute instance-attribute 

status = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventSourceFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
84
85
class EventSourceFilter(BaseModel):
    expression: Optional[str] = None

expression class-attribute instance-attribute 

expression = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventSourceList

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
4035
4036
4037
class EventSourceList(BaseModel):
    items: Optional[List[EventSource]] = None
    metadata: Optional[v1.ListMeta] = None

items class-attribute instance-attribute 

items = None

metadata class-attribute instance-attribute 

metadata = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventSourceSpec

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
class EventSourceSpec(BaseModel):
    amqp: Annotated[Optional[Dict[str, AMQPEventSource]], Field(title="AMQP event sources")] = None
    azure_events_hub: Annotated[
        Optional[Dict[str, AzureEventsHubEventSource]],
        Field(alias="azureEventsHub", title="AzureEventsHub event sources"),
    ] = None
    azure_queue_storage: Annotated[
        Optional[Dict[str, AzureQueueStorageEventSource]],
        Field(alias="azureQueueStorage", title="AzureQueueStorage event source"),
    ] = None
    azure_service_bus: Annotated[
        Optional[Dict[str, AzureServiceBusEventSource]],
        Field(alias="azureServiceBus", title="Azure Service Bus event source"),
    ] = None
    bitbucket: Annotated[
        Optional[Dict[str, BitbucketEventSource]],
        Field(title="Bitbucket event sources"),
    ] = None
    bitbucketserver: Annotated[
        Optional[Dict[str, BitbucketServerEventSource]],
        Field(title="Bitbucket Server event sources"),
    ] = None
    calendar: Annotated[Optional[Dict[str, CalendarEventSource]], Field(title="Calendar event sources")] = None
    emitter: Annotated[Optional[Dict[str, EmitterEventSource]], Field(title="Emitter event source")] = None
    event_bus_name: Annotated[
        Optional[str],
        Field(
            alias="eventBusName",
            title=('EventBusName references to a EventBus name. By default the value is "default"'),
        ),
    ] = None
    file: Annotated[Optional[Dict[str, FileEventSource]], Field(title="File event sources")] = None
    generic: Annotated[Optional[Dict[str, GenericEventSource]], Field(title="Generic event source")] = None
    gerrit: Annotated[Optional[Dict[str, GerritEventSource]], Field(title="Gerrit event source")] = None
    github: Annotated[Optional[Dict[str, GithubEventSource]], Field(title="Github event sources")] = None
    gitlab: Annotated[Optional[Dict[str, GitlabEventSource]], Field(title="Gitlab event sources")] = None
    hdfs: Annotated[Optional[Dict[str, HDFSEventSource]], Field(title="HDFS event sources")] = None
    kafka: Annotated[Optional[Dict[str, KafkaEventSource]], Field(title="Kafka event sources")] = None
    minio: Annotated[Optional[Dict[str, S3Artifact]], Field(title="Minio event sources")] = None
    mqtt: Annotated[Optional[Dict[str, MQTTEventSource]], Field(title="MQTT event sources")] = None
    nats: Annotated[Optional[Dict[str, NATSEventsSource]], Field(title="NATS event sources")] = None
    nsq: Annotated[Optional[Dict[str, NSQEventSource]], Field(title="NSQ event source")] = None
    pub_sub: Annotated[
        Optional[Dict[str, PubSubEventSource]],
        Field(alias="pubSub", title="PubSub event sources"),
    ] = None
    pulsar: Annotated[Optional[Dict[str, PulsarEventSource]], Field(title="Pulsar event source")] = None
    redis: Annotated[Optional[Dict[str, RedisEventSource]], Field(title="Redis event source")] = None
    redis_stream: Annotated[
        Optional[Dict[str, RedisStreamEventSource]],
        Field(alias="redisStream", title="Redis stream source"),
    ] = None
    replicas: Annotated[Optional[int], Field(title="Replicas is the event source deployment replicas")] = None
    resource: Annotated[Optional[Dict[str, ResourceEventSource]], Field(title="Resource event sources")] = None
    service: Annotated[
        Optional[Service],
        Field(title=("Service is the specifications of the service to expose the event source\n+optional")),
    ] = None
    sftp: Annotated[Optional[Dict[str, SFTPEventSource]], Field(title="SFTP event sources")] = None
    slack: Annotated[Optional[Dict[str, SlackEventSource]], Field(title="Slack event sources")] = None
    sns: Annotated[Optional[Dict[str, SNSEventSource]], Field(title="SNS event sources")] = None
    sqs: Annotated[Optional[Dict[str, SQSEventSource]], Field(title="SQS event sources")] = None
    storage_grid: Annotated[
        Optional[Dict[str, StorageGridEventSource]],
        Field(alias="storageGrid", title="StorageGrid event sources"),
    ] = None
    stripe: Annotated[Optional[Dict[str, StripeEventSource]], Field(title="Stripe event sources")] = None
    template: Annotated[
        Optional[Template],
        Field(title="Template is the pod specification for the event source\n+optional"),
    ] = None
    webhook: Annotated[Optional[Dict[str, WebhookEventSource]], Field(title="Webhook event sources")] = None

amqp class-attribute instance-attribute 

amqp = None

azure_events_hub class-attribute instance-attribute 

azure_events_hub = None

azure_queue_storage class-attribute instance-attribute 

azure_queue_storage = None

azure_service_bus class-attribute instance-attribute 

azure_service_bus = None

bitbucket class-attribute instance-attribute 

bitbucket = None

bitbucketserver class-attribute instance-attribute 

bitbucketserver = None

calendar class-attribute instance-attribute 

calendar = None

emitter class-attribute instance-attribute 

emitter = None

event_bus_name class-attribute instance-attribute 

event_bus_name = None

file class-attribute instance-attribute 

file = None

generic class-attribute instance-attribute 

generic = None

gerrit class-attribute instance-attribute 

gerrit = None

github class-attribute instance-attribute 

github = None

gitlab class-attribute instance-attribute 

gitlab = None

hdfs class-attribute instance-attribute 

hdfs = None

kafka class-attribute instance-attribute 

kafka = None

minio class-attribute instance-attribute 

minio = None

mqtt class-attribute instance-attribute 

mqtt = None

nats class-attribute instance-attribute 

nats = None

nsq class-attribute instance-attribute 

nsq = None

pub_sub class-attribute instance-attribute 

pub_sub = None

pulsar class-attribute instance-attribute 

pulsar = None

redis class-attribute instance-attribute 

redis = None

redis_stream class-attribute instance-attribute 

redis_stream = None

replicas class-attribute instance-attribute 

replicas = None

resource class-attribute instance-attribute 

resource = None

service class-attribute instance-attribute 

service = None

sftp class-attribute instance-attribute 

sftp = None

slack class-attribute instance-attribute 

slack = None

sns class-attribute instance-attribute 

sns = None

sqs class-attribute instance-attribute 

sqs = None

storage_grid class-attribute instance-attribute 

storage_grid = None

stripe class-attribute instance-attribute 

stripe = None

template class-attribute instance-attribute 

template = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

EventSourceStatus

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3437
3438
class EventSourceStatus(BaseModel):
    status: Optional[Status] = None

status class-attribute instance-attribute 

status = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ExprFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3165
3166
3167
3168
3169
3170
3171
3172
3173
class ExprFilter(BaseModel):
    expr: Annotated[
        Optional[str],
        Field(description=("Expr refers to the expression that determines the outcome of the filter.")),
    ] = None
    fields: Annotated[
        Optional[List[PayloadField]],
        Field(description=("Fields refers to set of keys that refer to the paths within event payload.")),
    ] = None

expr class-attribute instance-attribute 

expr = None

fields class-attribute instance-attribute 

fields = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

FileArtifact

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
147
148
class FileArtifact(BaseModel):
    path: Optional[str] = None

path class-attribute instance-attribute 

path = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

FileEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
class FileEventSource(BaseModel):
    event_type: Annotated[
        Optional[str],
        Field(
            alias="eventType",
            title=(
                "Type of file operations to watch\nRefer"
                " https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more"
                " information"
            ),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    polling: Annotated[Optional[bool], Field(title="Use polling instead of inotify")] = None
    watch_path_config: Annotated[
        Optional[WatchPathConfig],
        Field(
            alias="watchPathConfig",
            title="WatchPathConfig contains configuration about the file path to watch",
        ),
    ] = None

event_type class-attribute instance-attribute 

event_type = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

polling class-attribute instance-attribute 

polling = None

watch_path_config class-attribute instance-attribute 

watch_path_config = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GenericEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
class GenericEventSource(BaseModel):
    auth_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authSecret",
            title=("AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional"),
        ),
    ] = None
    config: Annotated[Optional[str], Field(title="Config is the event source configuration")] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    insecure: Annotated[Optional[bool], Field(description="Insecure determines the type of connection.")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    url: Annotated[
        Optional[str],
        Field(description="URL of the gRPC server that implements the event source."),
    ] = None

auth_secret class-attribute instance-attribute 

auth_secret = None

config class-attribute instance-attribute 

config = None

filter class-attribute instance-attribute 

filter = None

insecure class-attribute instance-attribute 

insecure = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GerritEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
class GerritEventSource(BaseModel):
    auth: Annotated[
        Optional[BasicAuth],
        Field(title="Auth hosts secret selectors for username and password\n+optional"),
    ] = None
    delete_hook_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteHookOnFinish",
            title=(
                "DeleteHookOnFinish determines whether to delete the Gerrit hook for"
                " the project once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    events: Annotated[
        Optional[List[str]],
        Field(
            title=(
                "Events are gerrit event to listen to.\nRefer"
                " https://gerrit-review.googlesource.com/Documentation/cmd-stream-events.html#events"
            )
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    gerrit_base_url: Annotated[
        Optional[str],
        Field(
            alias="gerritBaseURL",
            title="GerritBaseURL is the base URL for API requests to a custom endpoint",
        ),
    ] = None
    hook_name: Annotated[
        Optional[str],
        Field(alias="hookName", title="HookName is the name of the webhook"),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    projects: Annotated[
        Optional[List[str]],
        Field(description='List of project namespace paths like "whynowy/test".'),
    ] = None
    ssl_verify: Annotated[
        Optional[bool],
        Field(alias="sslVerify", title="SslVerify to enable ssl verification\n+optional"),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration to run a http server"),
    ] = None

auth class-attribute instance-attribute 

auth = None

delete_hook_on_finish class-attribute instance-attribute 

delete_hook_on_finish = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

gerrit_base_url class-attribute instance-attribute 

gerrit_base_url = None

hook_name class-attribute instance-attribute 

hook_name = None

metadata class-attribute instance-attribute 

metadata = None

projects class-attribute instance-attribute 

projects = None

ssl_verify class-attribute instance-attribute 

ssl_verify = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GitArtifact

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
class GitArtifact(BaseModel):
    branch: Annotated[Optional[str], Field(title="Branch to use to pull trigger resource\n+optional")] = None
    clone_directory: Annotated[
        Optional[str],
        Field(
            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."
            ),
        ),
    ] = None
    creds: Annotated[
        Optional[GitCreds],
        Field(title="Creds contain reference to git username and password\n+optional"),
    ] = None
    file_path: Annotated[
        Optional[str],
        Field(
            alias="filePath",
            title="Path to file that contains trigger resource definition",
        ),
    ] = None
    insecure_ignore_host_key: Annotated[
        Optional[bool],
        Field(alias="insecureIgnoreHostKey", title="Whether to ignore host key\n+optional"),
    ] = None
    ref: Annotated[
        Optional[str],
        Field(title=("Ref to use to pull trigger resource. Will result in a shallow clone and\nfetch.\n+optional")),
    ] = None
    remote: Annotated[
        Optional[GitRemoteConfig],
        Field(
            title=(
                "Remote to manage set of tracked repositories. Defaults to"
                ' "origin".\nRefer https://git-scm.com/docs/git-remote\n+optional'
            )
        ),
    ] = None
    ssh_key_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sshKeySecret",
            title="SSHKeySecret refers to the secret that contains SSH key",
        ),
    ] = None
    tag: Annotated[Optional[str], Field(title="Tag to use to pull trigger resource\n+optional")] = None
    url: Annotated[Optional[str], Field(title="Git URL")] = None

branch class-attribute instance-attribute 

branch = None

clone_directory class-attribute instance-attribute 

clone_directory = None

creds class-attribute instance-attribute 

creds = None

file_path class-attribute instance-attribute 

file_path = None

insecure_ignore_host_key class-attribute instance-attribute 

insecure_ignore_host_key = None

ref class-attribute instance-attribute 

ref = None

remote class-attribute instance-attribute 

remote = None

ssh_key_secret class-attribute instance-attribute 

ssh_key_secret = None

tag class-attribute instance-attribute 

tag = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GitCreds

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
865
866
867
class GitCreds(BaseModel):
    password: Optional[v1_1.SecretKeySelector] = None
    username: Optional[v1_1.SecretKeySelector] = None

password class-attribute instance-attribute 

password = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GitRemoteConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
333
334
335
336
337
338
339
340
341
342
343
class GitRemoteConfig(BaseModel):
    name: Annotated[Optional[str], Field(description="Name of the remote to fetch from.")] = None
    urls: Annotated[
        Optional[List[str]],
        Field(
            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."
            )
        ),
    ] = None

name class-attribute instance-attribute 

name = None

urls class-attribute instance-attribute 

urls = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GithubAppCreds

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
class GithubAppCreds(BaseModel):
    app_id: Annotated[
        Optional[str],
        Field(
            alias="appID",
            title="AppID refers to the GitHub App ID for the application you created",
        ),
    ] = None
    installation_id: Annotated[
        Optional[str],
        Field(
            alias="installationID",
            title=("InstallationID refers to the Installation ID of the GitHub app you created and installed"),
        ),
    ] = None
    private_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="privateKey",
            title=("PrivateKey refers to a K8s secret containing the GitHub app private key"),
        ),
    ] = None

app_id class-attribute instance-attribute 

app_id = None

installation_id class-attribute instance-attribute 

installation_id = None

private_key class-attribute instance-attribute 

private_key = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GithubEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
class GithubEventSource(BaseModel):
    active: Annotated[
        Optional[bool],
        Field(
            title=(
                "Active refers to status of the webhook for event"
                " deliveries.\nhttps://developer.github.com/webhooks/creating/#active\n+optional"
            )
        ),
    ] = None
    api_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="apiToken",
            title=("APIToken refers to a K8s secret containing github api token\n+optional"),
        ),
    ] = None
    content_type: Annotated[
        Optional[str],
        Field(alias="contentType", title="ContentType of the event delivery"),
    ] = None
    delete_hook_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteHookOnFinish",
            title=(
                "DeleteHookOnFinish determines whether to delete the GitHub hook for"
                " the repository once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    events: Annotated[
        Optional[List[str]],
        Field(title=("Events refer to Github events to which the event source will subscribe")),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    github_app: Annotated[
        Optional[GithubAppCreds],
        Field(
            alias="githubApp",
            title="GitHubApp holds the GitHub app credentials\n+optional",
        ),
    ] = None
    github_base_url: Annotated[
        Optional[str],
        Field(
            alias="githubBaseURL",
            title="GitHub base URL (for GitHub Enterprise)\n+optional",
        ),
    ] = None
    github_upload_url: Annotated[
        Optional[str],
        Field(
            alias="githubUploadURL",
            title="GitHub upload URL (for GitHub Enterprise)\n+optional",
        ),
    ] = None
    id: Annotated[
        Optional[str],
        Field(
            title=("Id is the webhook's id\nDeprecated: This is not used at all, will be removed in v1.6\n+optional")
        ),
    ] = None
    insecure: Annotated[Optional[bool], Field(title="Insecure tls verification")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    organizations: Annotated[
        Optional[List[str]],
        Field(
            description=(
                "Organizations holds the names of organizations (used for organization"
                " level webhooks). Not required if Repositories is set."
            )
        ),
    ] = None
    owner: Annotated[
        Optional[str],
        Field(
            title=(
                "DeprecatedOwner refers to GitHub owner name i.e. argoproj\nDeprecated:"
                " use Repositories instead. Will be unsupported in v 1.6\n+optional"
            )
        ),
    ] = None
    repositories: Annotated[
        Optional[List[OwnedRepositories]],
        Field(
            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."
            )
        ),
    ] = None
    repository: Annotated[
        Optional[str],
        Field(
            title=(
                "DeprecatedRepository refers to GitHub repo name i.e."
                " argo-events\nDeprecated: use Repositories instead. Will be"
                " unsupported in v 1.6\n+optional"
            )
        ),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook refers to the configuration required to run a http server"),
    ] = None
    webhook_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="webhookSecret",
            title=(
                "WebhookSecret refers to K8s secret containing GitHub webhook"
                " secret\nhttps://developer.github.com/webhooks/securing/\n+optional"
            ),
        ),
    ] = None

active class-attribute instance-attribute 

active = None

api_token class-attribute instance-attribute 

api_token = None

content_type class-attribute instance-attribute 

content_type = None

delete_hook_on_finish class-attribute instance-attribute 

delete_hook_on_finish = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

github_app class-attribute instance-attribute 

github_app = None

github_base_url class-attribute instance-attribute 

github_base_url = None

github_upload_url class-attribute instance-attribute 

github_upload_url = None

id class-attribute instance-attribute 

id = None

insecure class-attribute instance-attribute 

insecure = None

metadata class-attribute instance-attribute 

metadata = None

organizations class-attribute instance-attribute 

organizations = None

owner class-attribute instance-attribute 

owner = None

repositories class-attribute instance-attribute 

repositories = None

repository class-attribute instance-attribute 

repository = None

webhook class-attribute instance-attribute 

webhook = None

webhook_secret class-attribute instance-attribute 

webhook_secret = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

GitlabEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
class GitlabEventSource(BaseModel):
    access_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="accessToken",
            title=("AccessToken references to k8 secret which holds the gitlab api access information"),
        ),
    ] = None
    delete_hook_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteHookOnFinish",
            title=(
                "DeleteHookOnFinish determines whether to delete the GitLab hook for"
                " the project once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    enable_ssl_verification: Annotated[
        Optional[bool],
        Field(
            alias="enableSSLVerification",
            title="EnableSSLVerification to enable ssl verification\n+optional",
        ),
    ] = None
    events: Annotated[
        Optional[List[str]],
        Field(
            description=(
                "Events are gitlab event to listen to.\nRefer"
                " https://github.com/xanzy/go-gitlab/blob/bf34eca5d13a9f4c3f501d8a97b8ac226d55e4d9/projects.go#L794."
            )
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    gitlab_base_url: Annotated[
        Optional[str],
        Field(
            alias="gitlabBaseURL",
            title="GitlabBaseURL is the base URL for API requests to a custom endpoint",
        ),
    ] = None
    groups: Annotated[
        Optional[List[str]],
        Field(
            title=(
                'List of group IDs or group name like "test".\nGroup level hook'
                " available in Premium and Ultimate Gitlab.\n+optional"
            )
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    project_id: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    projects: Annotated[
        Optional[List[str]],
        Field(
            title=(
                'List of project IDs or project namespace paths like "whynowy/test".'
                " Projects and groups cannot be empty at the same time.\n+optional"
            )
        ),
    ] = None
    secret_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="secretToken",
            title=("SecretToken references to k8 secret which holds the Secret Token used by webhook config"),
        ),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration to run a http server"),
    ] = None

access_token class-attribute instance-attribute 

access_token = None

delete_hook_on_finish class-attribute instance-attribute 

delete_hook_on_finish = None

enable_ssl_verification class-attribute instance-attribute 

enable_ssl_verification = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

gitlab_base_url class-attribute instance-attribute 

gitlab_base_url = None

groups class-attribute instance-attribute 

groups = None

metadata class-attribute instance-attribute 

metadata = None

project_id class-attribute instance-attribute 

project_id = None

projects class-attribute instance-attribute 

projects = None

secret_token class-attribute instance-attribute 

secret_token = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

HDFSEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
class HDFSEventSource(BaseModel):
    addresses: Optional[List[str]] = None
    check_interval: Annotated[
        Optional[str],
        Field(
            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)"
            ),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    hdfs_user: Annotated[
        Optional[str],
        Field(
            alias="hdfsUser",
            description=(
                "HDFSUser is the user to access HDFS file system.\nIt is ignored if either ccache or keytab is used."
            ),
        ),
    ] = None
    krb_c_cache_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="krbCCacheSecret",
            description=(
                "KrbCCacheSecret is the secret selector for Kerberos ccache\nEither"
                " ccache or keytab can be set to use Kerberos."
            ),
        ),
    ] = None
    krb_config_config_map: Annotated[
        Optional[v1_1.ConfigMapKeySelector],
        Field(
            alias="krbConfigConfigMap",
            description=(
                "KrbConfig is the configmap selector for Kerberos config as string\nIt"
                " must be set if either ccache or keytab is used."
            ),
        ),
    ] = None
    krb_keytab_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="krbKeytabSecret",
            description=(
                "KrbKeytabSecret is the secret selector for Kerberos keytab\nEither"
                " ccache or keytab can be set to use Kerberos."
            ),
        ),
    ] = None
    krb_realm: Annotated[
        Optional[str],
        Field(
            alias="krbRealm",
            description=(
                "KrbRealm is the Kerberos realm used with Kerberos keytab\nIt must be set if keytab is used."
            ),
        ),
    ] = None
    krb_service_principal_name: Annotated[
        Optional[str],
        Field(
            alias="krbServicePrincipalName",
            description=(
                "KrbServicePrincipalName is the principal name of Kerberos service\nIt"
                " must be set if either ccache or keytab is used."
            ),
        ),
    ] = None
    krb_username: Annotated[
        Optional[str],
        Field(
            alias="krbUsername",
            description=(
                "KrbUsername is the Kerberos username used with Kerberos keytab\nIt must be set if keytab is used."
            ),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    type: Annotated[Optional[str], Field(title="Type of file operations to watch")] = None
    watch_path_config: Annotated[Optional[WatchPathConfig], Field(alias="watchPathConfig")] = None

addresses class-attribute instance-attribute 

addresses = None

check_interval class-attribute instance-attribute 

check_interval = None

filter class-attribute instance-attribute 

filter = None

hdfs_user class-attribute instance-attribute 

hdfs_user = None

krb_c_cache_secret class-attribute instance-attribute 

krb_c_cache_secret = None

krb_config_config_map class-attribute instance-attribute 

krb_config_config_map = None

krb_keytab_secret class-attribute instance-attribute 

krb_keytab_secret = None

krb_realm class-attribute instance-attribute 

krb_realm = None

krb_service_principal_name class-attribute instance-attribute 

krb_service_principal_name = None

krb_username class-attribute instance-attribute 

krb_username = None

metadata class-attribute instance-attribute 

metadata = None

type class-attribute instance-attribute 

type = None

watch_path_config class-attribute instance-attribute 

watch_path_config = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

HTTPTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
class HTTPTrigger(BaseModel):
    basic_auth: Annotated[
        Optional[BasicAuth],
        Field(
            alias="basicAuth",
            title="BasicAuth configuration for the http request.\n+optional",
        ),
    ] = None
    headers: Annotated[
        Optional[Dict[str, str]],
        Field(title="Headers for the HTTP request.\n+optional"),
    ] = None
    method: Annotated[
        Optional[str],
        Field(
            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"
            )
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe HTTP trigger resource."
            )
        ),
    ] = None
    payload: Optional[List[TriggerParameter]] = None
    secure_headers: Annotated[
        Optional[List[SecureHeader]],
        Field(
            alias="secureHeaders",
            title=("Secure Headers stored in Kubernetes Secrets for the HTTP requests.\n+optional"),
        ),
    ] = None
    timeout: Annotated[
        Optional[str],
        Field(
            title=("Timeout refers to the HTTP request timeout in seconds.\nDefault value is 60 seconds.\n+optional")
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the HTTP client.\n+optional"),
    ] = None
    url: Annotated[
        Optional[str],
        Field(description="URL refers to the URL to send HTTP request to."),
    ] = None

basic_auth class-attribute instance-attribute 

basic_auth = None

headers class-attribute instance-attribute 

headers = None

method class-attribute instance-attribute 

method = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

secure_headers class-attribute instance-attribute 

secure_headers = None

timeout class-attribute instance-attribute 

timeout = None

tls class-attribute instance-attribute 

tls = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Int64OrString

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
166
167
168
169
class Int64OrString(BaseModel):
    int64_val: Annotated[Optional[str], Field(alias="int64Val")] = None
    str_val: Annotated[Optional[str], Field(alias="strVal")] = None
    type: Optional[str] = None

int64_val class-attribute instance-attribute 

int64_val = None

str_val class-attribute instance-attribute 

str_val = None

type class-attribute instance-attribute 

type = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

K8SResourcePolicy

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
class K8SResourcePolicy(BaseModel):
    backoff: Annotated[Optional[Backoff], Field(title="Backoff before checking resource state")] = None
    error_on_backoff_timeout: Annotated[
        Optional[bool],
        Field(
            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"
            ),
        ),
    ] = None
    labels: Annotated[
        Optional[Dict[str, str]],
        Field(title="Labels required to identify whether a resource is in success state"),
    ] = None

backoff class-attribute instance-attribute 

backoff = None

error_on_backoff_timeout class-attribute instance-attribute 

error_on_backoff_timeout = None

labels class-attribute instance-attribute 

labels = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

KafkaConsumerGroup

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
class KafkaConsumerGroup(BaseModel):
    group_name: Annotated[
        Optional[str],
        Field(alias="groupName", title="The name for the consumer group to use"),
    ] = None
    oldest: Annotated[
        Optional[bool],
        Field(
            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"
            )
        ),
    ] = None
    rebalance_strategy: Annotated[
        Optional[str],
        Field(
            alias="rebalanceStrategy",
            title=("Rebalance strategy can be one of: sticky, roundrobin, range. Range is the default.\n+optional"),
        ),
    ] = None

group_name class-attribute instance-attribute 

group_name = None

oldest class-attribute instance-attribute 

oldest = None

rebalance_strategy class-attribute instance-attribute 

rebalance_strategy = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

KafkaEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
2510
2511
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
class KafkaEventSource(BaseModel):
    config: Annotated[
        Optional[str],
        Field(
            description=(
                "Yaml format Sarama config for Kafka connection.\nIt follows the struct"
                " of sarama.Config. See"
                " https://github.com/IBM/sarama/blob/main/config.go\ne.g.\n\nconsumer:\n"
                "  fetch:\n    min: 1\nnet:\n  MaxOpenRequests: 5\n\n+optional"
            )
        ),
    ] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            description="Backoff holds parameters applied to connection.",
        ),
    ] = None
    consumer_group: Annotated[
        Optional[KafkaConsumerGroup],
        Field(alias="consumerGroup", title="Consumer group for kafka client\n+optional"),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    limit_events_per_second: Annotated[
        Optional[str],
        Field(
            alias="limitEventsPerSecond",
            title=("Sets a limit on how many events get read from kafka per second.\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    partition: Annotated[Optional[str], Field(title="Partition name\n+optional")] = None
    sasl: Annotated[
        Optional[SASLConfig],
        Field(title="SASL configuration for the kafka client\n+optional"),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the kafka client.\n+optional"),
    ] = None
    topic: Annotated[Optional[str], Field(title="Topic name")] = None
    url: Annotated[
        Optional[str],
        Field(title="URL to kafka cluster, multiple URLs separated by comma"),
    ] = None
    version: Annotated[
        Optional[str],
        Field(
            title=(
                "Specify what kafka version is being connected to enables certain"
                " features in sarama, defaults to 1.0.0\n+optional"
            )
        ),
    ] = None

config class-attribute instance-attribute 

config = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

consumer_group class-attribute instance-attribute 

consumer_group = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

limit_events_per_second class-attribute instance-attribute 

limit_events_per_second = None

metadata class-attribute instance-attribute 

metadata = None

partition class-attribute instance-attribute 

partition = None

sasl class-attribute instance-attribute 

sasl = None

tls class-attribute instance-attribute 

tls = None

topic class-attribute instance-attribute 

topic = None

url class-attribute instance-attribute 

url = None

version class-attribute instance-attribute 

version = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

KafkaTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
class KafkaTrigger(BaseModel):
    compress: Annotated[
        Optional[bool],
        Field(
            title=(
                "Compress determines whether to compress message or not.\nDefaults to"
                " false.\nIf set to true, compresses message using snappy"
                " compression.\n+optional"
            )
        ),
    ] = None
    flush_frequency: Annotated[
        Optional[int],
        Field(
            alias="flushFrequency",
            title=(
                "FlushFrequency refers to the frequency in milliseconds to flush"
                " batches.\nDefaults to 500 milliseconds.\n+optional"
            ),
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(description=("Parameters is the list of parameters that is applied to resolved Kafka trigger object.")),
    ] = None
    partition: Annotated[Optional[int], Field(title="+optional\nDEPRECATED")] = None
    partitioning_key: Annotated[
        Optional[str],
        Field(
            alias="partitioningKey",
            description=("The partitioning key for the messages put on the Kafka topic.\n+optional."),
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    required_acks: Annotated[
        Optional[int],
        Field(
            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."
            ),
        ),
    ] = None
    sasl: Annotated[
        Optional[SASLConfig],
        Field(title="SASL configuration for the kafka client\n+optional"),
    ] = None
    schema_registry: Annotated[
        Optional[SchemaRegistryConfig],
        Field(
            alias="schemaRegistry",
            title=("Schema Registry configuration to producer message with avro format\n+optional"),
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the Kafka producer.\n+optional"),
    ] = None
    topic: Annotated[
        Optional[str],
        Field(title=("Name of the topic.\nMore info at https://kafka.apache.org/documentation/#intro_topics")),
    ] = None
    url: Annotated[
        Optional[str],
        Field(description="URL of the Kafka broker, multiple URLs separated by comma."),
    ] = None
    version: Annotated[
        Optional[str],
        Field(
            title=(
                "Specify what kafka version is being connected to enables certain"
                " features in sarama, defaults to 1.0.0\n+optional"
            )
        ),
    ] = None

compress class-attribute instance-attribute 

compress = None

flush_frequency class-attribute instance-attribute 

flush_frequency = None

parameters class-attribute instance-attribute 

parameters = None

partition class-attribute instance-attribute 

partition = None

partitioning_key class-attribute instance-attribute 

partitioning_key = None

payload class-attribute instance-attribute 

payload = None

required_acks class-attribute instance-attribute 

required_acks = None

sasl class-attribute instance-attribute 

sasl = None

schema_registry class-attribute instance-attribute 

schema_registry = None

tls class-attribute instance-attribute 

tls = None

topic class-attribute instance-attribute 

topic = None

url class-attribute instance-attribute 

url = None

version class-attribute instance-attribute 

version = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

LogTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
369
370
371
372
373
374
375
376
377
378
379
class LogTrigger(BaseModel):
    interval_seconds: Annotated[
        Optional[str],
        Field(
            alias="intervalSeconds",
            title=(
                "Only print messages every interval. Useful to prevent logging too much"
                " data for busy events.\n+optional"
            ),
        ),
    ] = None

interval_seconds class-attribute instance-attribute 

interval_seconds = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

MQTTEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
class MQTTEventSource(BaseModel):
    auth: Annotated[
        Optional[BasicAuth],
        Field(title="Auth hosts secret selectors for username and password\n+optional"),
    ] = None
    client_id: Annotated[Optional[str], Field(alias="clientId", title="ClientID is the id of the client")] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            description="ConnectionBackoff holds backoff applied to connection.",
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the mqtt client.\n+optional"),
    ] = None
    topic: Annotated[Optional[str], Field(title="Topic name")] = None
    url: Annotated[Optional[str], Field(title="URL to connect to broker")] = None

auth class-attribute instance-attribute 

auth = None

client_id class-attribute instance-attribute 

client_id = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

tls class-attribute instance-attribute 

tls = None

topic class-attribute instance-attribute 

topic = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Metadata

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
382
383
384
class Metadata(BaseModel):
    annotations: Optional[Dict[str, str]] = None
    labels: Optional[Dict[str, str]] = None

annotations class-attribute instance-attribute 

annotations = None

labels class-attribute instance-attribute 

labels = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

NATSAuth

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
class NATSAuth(BaseModel):
    basic: Annotated[
        Optional[BasicAuth],
        Field(title="Baisc auth with username and password\n+optional"),
    ] = None
    credential: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="credential used to connect\n+optional"),
    ] = None
    nkey: Annotated[Optional[v1_1.SecretKeySelector], Field(title="NKey used to connect\n+optional")] = None
    token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Token used to connect\n+optional"),
    ] = None

basic class-attribute instance-attribute 

basic = None

credential class-attribute instance-attribute 

credential = None

nkey class-attribute instance-attribute 

nkey = None

token class-attribute instance-attribute 

token = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

NATSEventsSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
class NATSEventsSource(BaseModel):
    auth: Annotated[Optional[NATSAuth], Field(title="Auth information\n+optional")] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            description="ConnectionBackoff holds backoff applied to connection.",
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    subject: Annotated[
        Optional[str],
        Field(title=("Subject holds the name of the subject onto which messages are published")),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the nats client.\n+optional"),
    ] = None
    url: Annotated[Optional[str], Field(title="URL to connect to NATS cluster")] = None

auth class-attribute instance-attribute 

auth = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

subject class-attribute instance-attribute 

subject = None

tls class-attribute instance-attribute 

tls = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

NATSTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1672
1673
1674
1675
1676
1677
1678
1679
1680
class NATSTrigger(BaseModel):
    parameters: Optional[List[TriggerParameter]] = None
    payload: Optional[List[TriggerParameter]] = None
    subject: Annotated[Optional[str], Field(description="Name of the subject to put message on.")] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the NATS producer.\n+optional"),
    ] = None
    url: Annotated[Optional[str], Field(description="URL of the NATS cluster.")] = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

subject class-attribute instance-attribute 

subject = None

tls class-attribute instance-attribute 

tls = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

NSQEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
class NSQEventSource(BaseModel):
    channel: Annotated[Optional[str], Field(title="Channel used for subscription")] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            title="Backoff holds parameters applied to connection.\n+optional",
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    host_address: Annotated[
        Optional[str],
        Field(
            alias="hostAddress",
            title="HostAddress is the address of the host for NSQ lookup",
        ),
    ] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the nsq client.\n+optional"),
    ] = None
    topic: Annotated[Optional[str], Field(description="Topic to subscribe to.")] = None

channel class-attribute instance-attribute 

channel = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

filter class-attribute instance-attribute 

filter = None

host_address class-attribute instance-attribute 

host_address = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

tls class-attribute instance-attribute 

tls = None

topic class-attribute instance-attribute 

topic = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

OpenWhiskTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
class OpenWhiskTrigger(BaseModel):
    action_name: Annotated[
        Optional[str],
        Field(alias="actionName", description="Name of the action/function."),
    ] = None
    auth_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(alias="authToken", title="AuthToken for authentication.\n+optional"),
    ] = None
    host: Annotated[Optional[str], Field(description="Host URL of the OpenWhisk.")] = None
    namespace: Annotated[
        Optional[str],
        Field(description='Namespace for the action.\nDefaults to "_".\n+optional.'),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    version: Annotated[Optional[str], Field(title="Version for the API.\nDefaults to v1.\n+optional")] = None

action_name class-attribute instance-attribute 

action_name = None

auth_token class-attribute instance-attribute 

auth_token = None

host class-attribute instance-attribute 

host = None

namespace class-attribute instance-attribute 

namespace = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

version class-attribute instance-attribute 

version = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

OwnedRepositories

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
387
388
389
class OwnedRepositories(BaseModel):
    names: Annotated[Optional[List[str]], Field(title="Repository names")] = None
    owner: Annotated[Optional[str], Field(title="Organization or user name")] = None

names class-attribute instance-attribute 

names = None

owner class-attribute instance-attribute 

owner = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

PayloadField

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
class PayloadField(BaseModel):
    name: Annotated[
        Optional[str],
        Field(description="Name acts as key that holds the value at the path."),
    ] = None
    path: Annotated[
        Optional[str],
        Field(
            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."
            )
        ),
    ] = None

name class-attribute instance-attribute 

name = None

path class-attribute instance-attribute 

path = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

PubSubEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
class PubSubEventSource(BaseModel):
    credential_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            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"
            ),
        ),
    ] = None
    delete_subscription_on_finish: Annotated[
        Optional[bool],
        Field(
            alias="deleteSubscriptionOnFinish",
            title=(
                "DeleteSubscriptionOnFinish determines whether to delete the GCP PubSub"
                " subscription once the event source is stopped.\n+optional"
            ),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    project_id: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    subscription_id: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    topic: Annotated[
        Optional[str],
        Field(
            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"
            )
        ),
    ] = None
    topic_project_id: Annotated[
        Optional[str],
        Field(
            alias="topicProjectID",
            title=("TopicProjectID is GCP project ID for the topic.\nBy default, it is same as ProjectID.\n+optional"),
        ),
    ] = None

credential_secret class-attribute instance-attribute 

credential_secret = None

delete_subscription_on_finish class-attribute instance-attribute 

delete_subscription_on_finish = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

project_id class-attribute instance-attribute 

project_id = None

subscription_id class-attribute instance-attribute 

subscription_id = None

topic class-attribute instance-attribute 

topic = None

topic_project_id class-attribute instance-attribute 

topic_project_id = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

PulsarEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
class PulsarEventSource(BaseModel):
    auth_athenz_params: Annotated[
        Optional[Dict[str, str]],
        Field(
            alias="authAthenzParams",
            title=(
                "Authentication athenz parameters for the pulsar client.\nRefer"
                " https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go\nEither"
                " token or athenz can be set to use auth.\n+optional"
            ),
        ),
    ] = None
    auth_athenz_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authAthenzSecret",
            title=(
                "Authentication athenz privateKey secret for the pulsar"
                " client.\nAuthAthenzSecret must be set if AuthAthenzParams is"
                " used.\n+optional"
            ),
        ),
    ] = None
    auth_token_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authTokenSecret",
            title=(
                "Authentication token for the pulsar client.\nEither token or athenz"
                " can be set to use auth.\n+optional"
            ),
        ),
    ] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            title="Backoff holds parameters applied to connection.\n+optional",
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the pulsar client.\n+optional"),
    ] = None
    tls_allow_insecure_connection: Annotated[
        Optional[bool],
        Field(
            alias="tlsAllowInsecureConnection",
            title=("Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional"),
        ),
    ] = None
    tls_trust_certs_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="tlsTrustCertsSecret",
            title="Trusted TLS certificate secret.\n+optional",
        ),
    ] = None
    tls_validate_hostname: Annotated[
        Optional[bool],
        Field(
            alias="tlsValidateHostname",
            title=("Whether the Pulsar client verify the validity of the host name from broker.\n+optional"),
        ),
    ] = None
    topics: Annotated[
        Optional[List[str]],
        Field(title="Name of the topics to subscribe to.\n+required"),
    ] = None
    type: Annotated[
        Optional[str],
        Field(
            title=(
                'Type of the subscription.\nOnly "exclusive" and "shared" is'
                " supported.\nDefaults to exclusive.\n+optional"
            )
        ),
    ] = None
    url: Annotated[
        Optional[str],
        Field(title="Configure the service URL for the Pulsar service.\n+required"),
    ] = None

auth_athenz_params class-attribute instance-attribute 

auth_athenz_params = None

auth_athenz_secret class-attribute instance-attribute 

auth_athenz_secret = None

auth_token_secret class-attribute instance-attribute 

auth_token_secret = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

tls class-attribute instance-attribute 

tls = None

tls_allow_insecure_connection class-attribute instance-attribute 

tls_allow_insecure_connection = None

tls_trust_certs_secret class-attribute instance-attribute 

tls_trust_certs_secret = None

tls_validate_hostname class-attribute instance-attribute 

tls_validate_hostname = None

topics class-attribute instance-attribute 

topics = None

type class-attribute instance-attribute 

type = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

PulsarTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
class PulsarTrigger(BaseModel):
    auth_athenz_params: Annotated[
        Optional[Dict[str, str]],
        Field(
            alias="authAthenzParams",
            title=(
                "Authentication athenz parameters for the pulsar client.\nRefer"
                " https://github.com/apache/pulsar-client-go/blob/master/pulsar/auth/athenz.go\nEither"
                " token or athenz can be set to use auth.\n+optional"
            ),
        ),
    ] = None
    auth_athenz_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authAthenzSecret",
            title=(
                "Authentication athenz privateKey secret for the pulsar"
                " client.\nAuthAthenzSecret must be set if AuthAthenzParams is"
                " used.\n+optional"
            ),
        ),
    ] = None
    auth_token_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authTokenSecret",
            title=(
                "Authentication token for the pulsar client.\nEither token or athenz"
                " can be set to use auth.\n+optional"
            ),
        ),
    ] = None
    connection_backoff: Annotated[
        Optional[Backoff],
        Field(
            alias="connectionBackoff",
            title="Backoff holds parameters applied to connection.\n+optional",
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(description=("Parameters is the list of parameters that is applied to resolved Kafka trigger object.")),
    ] = None
    payload: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            description=(
                "Payload is the list of key-value extracted from an event payload to construct the request payload."
            )
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the pulsar client.\n+optional"),
    ] = None
    tls_allow_insecure_connection: Annotated[
        Optional[bool],
        Field(
            alias="tlsAllowInsecureConnection",
            title=("Whether the Pulsar client accept untrusted TLS certificate from broker.\n+optional"),
        ),
    ] = None
    tls_trust_certs_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="tlsTrustCertsSecret",
            title="Trusted TLS certificate secret.\n+optional",
        ),
    ] = None
    tls_validate_hostname: Annotated[
        Optional[bool],
        Field(
            alias="tlsValidateHostname",
            title=("Whether the Pulsar client verify the validity of the host name from broker.\n+optional"),
        ),
    ] = None
    topic: Annotated[
        Optional[str],
        Field(title=("Name of the topic.\nSee https://pulsar.apache.org/docs/en/concepts-messaging/")),
    ] = None
    url: Annotated[
        Optional[str],
        Field(title="Configure the service URL for the Pulsar service.\n+required"),
    ] = None

auth_athenz_params class-attribute instance-attribute 

auth_athenz_params = None

auth_athenz_secret class-attribute instance-attribute 

auth_athenz_secret = None

auth_token_secret class-attribute instance-attribute 

auth_token_secret = None

connection_backoff class-attribute instance-attribute 

connection_backoff = None

parameters class-attribute instance-attribute 

parameters = None

payload class-attribute instance-attribute 

payload = None

tls class-attribute instance-attribute 

tls = None

tls_allow_insecure_connection class-attribute instance-attribute 

tls_allow_insecure_connection = None

tls_trust_certs_secret class-attribute instance-attribute 

tls_trust_certs_secret = None

tls_validate_hostname class-attribute instance-attribute 

tls_validate_hostname = None

topic class-attribute instance-attribute 

topic = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

RateLimit

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
412
413
414
class RateLimit(BaseModel):
    requests_per_unit: Annotated[Optional[int], Field(alias="requestsPerUnit")] = None
    unit: Annotated[Optional[str], Field(title="Defaults to Second")] = None

requests_per_unit class-attribute instance-attribute 

requests_per_unit = None

unit class-attribute instance-attribute 

unit = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

RedisEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
class RedisEventSource(BaseModel):
    channels: Optional[List[str]] = None
    db: Annotated[
        Optional[int],
        Field(title="DB to use. If not specified, default DB 0 will be used.\n+optional"),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    host_address: Annotated[
        Optional[str],
        Field(
            alias="hostAddress",
            title="HostAddress refers to the address of the Redis host/server",
        ),
    ] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    namespace: Annotated[
        Optional[str],
        Field(
            title=(
                "Namespace to use to retrieve the password from. It should only be"
                " specified if password is declared\n+optional"
            )
        ),
    ] = None
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Password required for authentication if any.\n+optional"),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the redis client.\n+optional"),
    ] = None
    username: Annotated[
        Optional[str],
        Field(title="Username required for ACL style authentication if any.\n+optional"),
    ] = None

channels class-attribute instance-attribute 

channels = None

db class-attribute instance-attribute 

db = None

filter class-attribute instance-attribute 

filter = None

host_address class-attribute instance-attribute 

host_address = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

namespace class-attribute instance-attribute 

namespace = None

password class-attribute instance-attribute 

password = None

tls class-attribute instance-attribute 

tls = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

RedisStreamEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
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
class RedisStreamEventSource(BaseModel):
    consumer_group: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    db: Annotated[
        Optional[int],
        Field(title="DB to use. If not specified, default DB 0 will be used.\n+optional"),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    host_address: Annotated[
        Optional[str],
        Field(
            alias="hostAddress",
            title=("HostAddress refers to the address of the Redis host/server (master instance)"),
        ),
    ] = None
    max_msg_count_per_read: Annotated[
        Optional[int],
        Field(
            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"
            ),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Password required for authentication if any.\n+optional"),
    ] = None
    streams: Annotated[
        Optional[List[str]],
        Field(
            description=(
                "Streams to look for entries. XREADGROUP is used on all streams using a single consumer group."
            )
        ),
    ] = None
    tls: Annotated[
        Optional[TLSConfig],
        Field(title="TLS configuration for the redis client.\n+optional"),
    ] = None
    username: Annotated[
        Optional[str],
        Field(title="Username required for ACL style authentication if any.\n+optional"),
    ] = None

consumer_group class-attribute instance-attribute 

consumer_group = None

db class-attribute instance-attribute 

db = None

filter class-attribute instance-attribute 

filter = None

host_address class-attribute instance-attribute 

host_address = None

max_msg_count_per_read class-attribute instance-attribute 

max_msg_count_per_read = None

metadata class-attribute instance-attribute 

metadata = None

password class-attribute instance-attribute 

password = None

streams class-attribute instance-attribute 

streams = None

tls class-attribute instance-attribute 

tls = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Resource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
151
152
class Resource(BaseModel):
    value: Optional[str] = None

value class-attribute instance-attribute 

value = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ResourceEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
class ResourceEventSource(BaseModel):
    event_types: Annotated[
        Optional[List[str]],
        Field(
            alias="eventTypes",
            description=(
                "EventTypes is the list of event type to watch.\nPossible values are - ADD, UPDATE and DELETE."
            ),
        ),
    ] = None
    filter: Annotated[
        Optional[ResourceFilter],
        Field(
            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"
            )
        ),
    ] = None
    group_version_resource: Annotated[
        Optional[v1.GroupVersionResource],
        Field(alias="groupVersionResource", title="Group of the resource"),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    namespace: Annotated[Optional[str], Field(title="Namespace where resource is deployed")] = None

event_types class-attribute instance-attribute 

event_types = None

filter class-attribute instance-attribute 

filter = None

group_version_resource class-attribute instance-attribute 

group_version_resource = None

metadata class-attribute instance-attribute 

metadata = None

namespace class-attribute instance-attribute 

namespace = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ResourceFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
class ResourceFilter(BaseModel):
    after_start: Annotated[
        Optional[bool],
        Field(
            alias="afterStart",
            title=("If the resource is created after the start time then the event is treated as valid.\n+optional"),
        ),
    ] = None
    created_by: Annotated[
        Optional[v1.Time],
        Field(
            alias="createdBy",
            title=("If resource is created before the specified time then the event is treated as valid.\n+optional"),
        ),
    ] = None
    fields: Annotated[
        Optional[List[Selector]],
        Field(
            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"
            )
        ),
    ] = None
    labels: Annotated[
        Optional[List[Selector]],
        Field(
            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.\nUnlike K8s field selector,"
                " multiple values are passed as comma separated values instead of list"
                " of values.\nEg: value: value1,value2.\nSame as K8s label selector,"
                ' operator "=", "==", "!=", "exists", "!", "notin", "in", "gt" and'
                ' "lt"\nare supported\n+optional'
            )
        ),
    ] = None
    prefix: Annotated[
        Optional[str],
        Field(title="Prefix filter is applied on the resource name.\n+optional"),
    ] = None

after_start class-attribute instance-attribute 

after_start = None

created_by class-attribute instance-attribute 

created_by = None

fields class-attribute instance-attribute 

fields = None

labels class-attribute instance-attribute 

labels = None

prefix class-attribute instance-attribute 

prefix = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

S3Artifact

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
class S3Artifact(BaseModel):
    access_key: Annotated[Optional[v1_1.SecretKeySelector], Field(alias="accessKey")] = None
    bucket: Optional[S3Bucket] = None
    ca_certificate: Annotated[Optional[v1_1.SecretKeySelector], Field(alias="caCertificate")] = None
    endpoint: Optional[str] = None
    events: Optional[List[str]] = None
    filter: Optional[S3Filter] = None
    insecure: Optional[bool] = None
    metadata: Optional[Dict[str, str]] = None
    region: Optional[str] = None
    secret_key: Annotated[Optional[v1_1.SecretKeySelector], Field(alias="secretKey")] = None

access_key class-attribute instance-attribute 

access_key = None

bucket class-attribute instance-attribute 

bucket = None

ca_certificate class-attribute instance-attribute 

ca_certificate = None

endpoint class-attribute instance-attribute 

endpoint = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

insecure class-attribute instance-attribute 

insecure = None

metadata class-attribute instance-attribute 

metadata = None

region class-attribute instance-attribute 

region = None

secret_key class-attribute instance-attribute 

secret_key = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

S3Bucket

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
417
418
419
class S3Bucket(BaseModel):
    key: Optional[str] = None
    name: Optional[str] = None

key class-attribute instance-attribute 

key = None

name class-attribute instance-attribute 

name = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

S3Filter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
422
423
424
class S3Filter(BaseModel):
    prefix: Optional[str] = None
    suffix: Optional[str] = None

prefix class-attribute instance-attribute 

prefix = None

suffix class-attribute instance-attribute 

suffix = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SASLConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
class SASLConfig(BaseModel):
    mechanism: Annotated[
        Optional[str],
        Field(
            title=(
                "SASLMechanism is the name of the enabled SASL mechanism.\nPossible"
                " values: OAUTHBEARER, PLAIN (defaults to PLAIN).\n+optional"
            )
        ),
    ] = None
    password_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(alias="passwordSecret", title="Password for SASL/PLAIN authentication"),
    ] = None
    user_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="userSecret",
            title=(
                "User is the authentication identity (authcid) to present for\nSASL/PLAIN or SASL/SCRAM authentication"
            ),
        ),
    ] = None

mechanism class-attribute instance-attribute 

mechanism = None

password_secret class-attribute instance-attribute 

password_secret = None

user_secret class-attribute instance-attribute 

user_secret = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SFTPEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
class SFTPEventSource(BaseModel):
    address: Annotated[Optional[v1_1.SecretKeySelector], Field(description="Address sftp address.")] = None
    event_type: Annotated[
        Optional[str],
        Field(
            alias="eventType",
            title=(
                "Type of file operations to watch\nRefer"
                " https://github.com/fsnotify/fsnotify/blob/master/fsnotify.go for more"
                " information"
            ),
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    password: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(description="Password required for authentication if any."),
    ] = None
    poll_interval_duration: Annotated[
        Optional[str],
        Field(
            alias="pollIntervalDuration",
            title=(
                "PollIntervalDuration the interval at which to poll the SFTP server\ndefaults to 10 seconds\n+optional"
            ),
        ),
    ] = None
    ssh_key_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sshKeySecret",
            title="SSHKeySecret refers to the secret that contains SSH key",
        ),
    ] = None
    username: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(description="Username required for authentication if any."),
    ] = None
    watch_path_config: Annotated[
        Optional[WatchPathConfig],
        Field(
            alias="watchPathConfig",
            title="WatchPathConfig contains configuration about the file path to watch",
        ),
    ] = None

address class-attribute instance-attribute 

address = None

event_type class-attribute instance-attribute 

event_type = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

password class-attribute instance-attribute 

password = None

poll_interval_duration class-attribute instance-attribute 

poll_interval_duration = None

ssh_key_secret class-attribute instance-attribute 

ssh_key_secret = None

username class-attribute instance-attribute 

username = None

watch_path_config class-attribute instance-attribute 

watch_path_config = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SNSEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
class SNSEventSource(BaseModel):
    access_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="accessKey",
            title="AccessKey refers K8s secret containing aws access key",
        ),
    ] = None
    endpoint: Annotated[
        Optional[str],
        Field(
            title=("Endpoint configures connection to a specific SNS endpoint instead of Amazons servers\n+optional")
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    region: Annotated[Optional[str], Field(title="Region is AWS region")] = None
    role_arn: Annotated[
        Optional[str],
        Field(
            alias="roleARN",
            title=("RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional"),
        ),
    ] = None
    secret_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="secretKey",
            title="SecretKey refers K8s secret containing aws secret key",
        ),
    ] = None
    topic_arn: Annotated[Optional[str], Field(alias="topicArn", title="TopicArn")] = None
    validate_signature: Annotated[
        Optional[bool],
        Field(
            alias="validateSignature",
            title=("ValidateSignature is boolean that can be set to true for SNS signature verification\n+optional"),
        ),
    ] = None
    webhook: Annotated[Optional[WebhookContext], Field(title="Webhook configuration for http server")] = None

access_key class-attribute instance-attribute 

access_key = None

endpoint class-attribute instance-attribute 

endpoint = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

region class-attribute instance-attribute 

region = None

role_arn class-attribute instance-attribute 

role_arn = None

secret_key class-attribute instance-attribute 

secret_key = None

topic_arn class-attribute instance-attribute 

topic_arn = None

validate_signature class-attribute instance-attribute 

validate_signature = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SQSEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
class SQSEventSource(BaseModel):
    access_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="accessKey",
            title="AccessKey refers K8s secret containing aws access key",
        ),
    ] = None
    dlq: Annotated[
        Optional[bool],
        Field(
            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"
            )
        ),
    ] = None
    endpoint: Annotated[
        Optional[str],
        Field(
            title=("Endpoint configures connection to a specific SQS endpoint instead of Amazons servers\n+optional")
        ),
    ] = None
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    json_body: Annotated[
        Optional[bool],
        Field(
            alias="jsonBody",
            title=("JSONBody specifies that all event body payload coming from this\nsource will be JSON\n+optional"),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    queue: Annotated[Optional[str], Field(title="Queue is AWS SQS queue to listen to for messages")] = None
    queue_account_id: Annotated[
        Optional[str],
        Field(
            alias="queueAccountId",
            title=("QueueAccountID is the ID of the account that created the queue to monitor\n+optional"),
        ),
    ] = None
    region: Annotated[Optional[str], Field(title="Region is AWS region")] = None
    role_arn: Annotated[
        Optional[str],
        Field(
            alias="roleARN",
            title=("RoleARN is the Amazon Resource Name (ARN) of the role to assume.\n+optional"),
        ),
    ] = None
    secret_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="secretKey",
            title="SecretKey refers K8s secret containing aws secret key",
        ),
    ] = None
    session_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="sessionToken",
            title=(
                "SessionToken refers to K8s secret containing AWS temporary credentials(STS) session token\n+optional"
            ),
        ),
    ] = None
    wait_time_seconds: Annotated[
        Optional[str],
        Field(
            alias="waitTimeSeconds",
            description=(
                "WaitTimeSeconds is The duration (in seconds) for which the call waits"
                " for a message to arrive\nin the queue before returning."
            ),
        ),
    ] = None

access_key class-attribute instance-attribute 

access_key = None

dlq class-attribute instance-attribute 

dlq = None

endpoint class-attribute instance-attribute 

endpoint = None

filter class-attribute instance-attribute 

filter = None

json_body class-attribute instance-attribute 

json_body = None

metadata class-attribute instance-attribute 

metadata = None

queue class-attribute instance-attribute 

queue = None

queue_account_id class-attribute instance-attribute 

queue_account_id = None

region class-attribute instance-attribute 

region = None

role_arn class-attribute instance-attribute 

role_arn = None

secret_key class-attribute instance-attribute 

secret_key = None

session_token class-attribute instance-attribute 

session_token = None

wait_time_seconds class-attribute instance-attribute 

wait_time_seconds = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SchemaRegistryConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1480
1481
1482
1483
1484
1485
1486
class SchemaRegistryConfig(BaseModel):
    auth: Annotated[
        Optional[BasicAuth],
        Field(title="+optional\nSchemaRegistry - basic authentication"),
    ] = None
    schema_id: Annotated[Optional[int], Field(alias="schemaId", title="Schema ID")] = None
    url: Annotated[Optional[str], Field(description="Schema Registry URL.")] = None

auth class-attribute instance-attribute 

auth = None

schema_id class-attribute instance-attribute 

schema_id = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SecureHeader

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2303
2304
2305
2306
2307
2308
2309
2310
2311
class SecureHeader(BaseModel):
    name: Optional[str] = None
    value_from: Annotated[
        Optional[ValueFromSource],
        Field(
            alias="valueFrom",
            title="Values can be read from either secrets or configmaps",
        ),
    ] = None

name class-attribute instance-attribute 

name = None

value_from class-attribute instance-attribute 

value_from = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Selector

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
427
428
429
430
431
432
433
434
435
436
437
438
439
class Selector(BaseModel):
    key: Annotated[Optional[str], Field(title="Key name")] = None
    operation: Annotated[
        Optional[str],
        Field(
            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"
            )
        ),
    ] = None
    value: Annotated[Optional[str], Field(title="Value")] = None

key class-attribute instance-attribute 

key = None

operation class-attribute instance-attribute 

operation = None

value class-attribute instance-attribute 

value = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Sensor

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
4029
4030
4031
4032
class Sensor(BaseModel):
    metadata: Optional[v1.ObjectMeta] = None
    spec: Optional[SensorSpec] = None
    status: Annotated[Optional[SensorStatus], Field(title="+optional")] = None

metadata class-attribute instance-attribute 

metadata = None

spec class-attribute instance-attribute 

spec = None

status class-attribute instance-attribute 

status = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SensorList

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
4040
4041
4042
class SensorList(BaseModel):
    items: Optional[List[Sensor]] = None
    metadata: Optional[v1.ListMeta] = None

items class-attribute instance-attribute 

items = None

metadata class-attribute instance-attribute 

metadata = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SensorSpec

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
class SensorSpec(BaseModel):
    dependencies: Annotated[
        Optional[List[EventDependency]],
        Field(description=("Dependencies is a list of the events that this sensor is dependent on.")),
    ] = None
    error_on_failed_round: Annotated[
        Optional[bool],
        Field(
            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."
            ),
        ),
    ] = None
    event_bus_name: Annotated[
        Optional[str],
        Field(
            alias="eventBusName",
            title=('EventBusName references to a EventBus name. By default the value is "default"'),
        ),
    ] = None
    logging_fields: Annotated[
        Optional[Dict[str, str]],
        Field(
            alias="loggingFields",
            title=("LoggingFields add additional key-value pairs when logging happens\n+optional"),
        ),
    ] = None
    replicas: Annotated[Optional[int], Field(title="Replicas is the sensor deployment replicas")] = None
    revision_history_limit: Annotated[
        Optional[int],
        Field(
            alias="revisionHistoryLimit",
            title=("RevisionHistoryLimit specifies how many old deployment revisions to retain\n+optional"),
        ),
    ] = None
    template: Annotated[
        Optional[Template],
        Field(title="Template is the pod specification for the sensor\n+optional"),
    ] = None
    triggers: Annotated[
        Optional[List[Trigger]],
        Field(
            description=(
                "Triggers is a list of the things that this sensor evokes. These are the outputs from this sensor."
            )
        ),
    ] = None

dependencies class-attribute instance-attribute 

dependencies = None

error_on_failed_round class-attribute instance-attribute 

error_on_failed_round = None

event_bus_name class-attribute instance-attribute 

event_bus_name = None

logging_fields class-attribute instance-attribute 

logging_fields = None

replicas class-attribute instance-attribute 

replicas = None

revision_history_limit class-attribute instance-attribute 

revision_history_limit = None

template class-attribute instance-attribute 

template = None

triggers class-attribute instance-attribute 

triggers = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SensorStatus

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3441
3442
class SensorStatus(BaseModel):
    status: Optional[Status] = None

status class-attribute instance-attribute 

status = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Service

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
class Service(BaseModel):
    cluster_ip: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    ports: Annotated[
        Optional[List[v1_1.ServicePort]],
        Field(
            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"
            )
        ),
    ] = None

cluster_ip class-attribute instance-attribute 

cluster_ip = None

ports class-attribute instance-attribute 

ports = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SlackEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
class SlackEventSource(BaseModel):
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    signing_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(alias="signingSecret", title="Slack App signing secret"),
    ] = None
    token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(title="Token for URL verification handshake"),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration for a REST endpoint"),
    ] = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

signing_secret class-attribute instance-attribute 

signing_secret = None

token class-attribute instance-attribute 

token = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SlackSender

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
442
443
444
445
446
447
448
449
450
451
452
453
454
class SlackSender(BaseModel):
    icon: Annotated[
        Optional[str],
        Field(
            title=(
                "Icon is the Slack application's icon, e.g. :robot_face: or https://example.com/image.png\n+optional"
            )
        ),
    ] = None
    username: Annotated[
        Optional[str],
        Field(title="Username is the Slack application's username\n+optional"),
    ] = None

icon class-attribute instance-attribute 

icon = None

username class-attribute instance-attribute 

username = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SlackThread

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
class SlackThread(BaseModel):
    broadcast_message_to_channel: Annotated[
        Optional[bool],
        Field(
            alias="broadcastMessageToChannel",
            title=(
                "BroadcastMessageToChannel allows to also broadcast the message from"
                " the thread to the channel\n+optional"
            ),
        ),
    ] = None
    message_aggregation_key: Annotated[
        Optional[str],
        Field(
            alias="messageAggregationKey",
            title=("MessageAggregationKey allows to aggregate the messages to a thread by some key.\n+optional"),
        ),
    ] = None

broadcast_message_to_channel class-attribute instance-attribute 

broadcast_message_to_channel = None

message_aggregation_key class-attribute instance-attribute 

message_aggregation_key = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

SlackTrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
class SlackTrigger(BaseModel):
    attachments: Annotated[
        Optional[str],
        Field(
            title=(
                "Attachments is a JSON format string that represents an array of Slack"
                " attachments according to the attachments API:"
                " https://api.slack.com/reference/messaging/attachments .\n+optional"
            )
        ),
    ] = None
    blocks: Annotated[
        Optional[str],
        Field(
            title=(
                "Blocks is a JSON format string that represents an array of Slack"
                " blocks according to the blocks API:"
                " https://api.slack.com/reference/block-kit/blocks .\n+optional"
            )
        ),
    ] = None
    channel: Annotated[
        Optional[str],
        Field(title=("Channel refers to which Slack channel to send Slack message.\n+optional")),
    ] = None
    message: Annotated[
        Optional[str],
        Field(title=("Message refers to the message to send to the Slack channel.\n+optional")),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(
            title=(
                "Parameters is the list of key-value extracted from event's payload"
                " that are applied to\nthe trigger resource.\n+optional"
            )
        ),
    ] = None
    sender: Annotated[
        Optional[SlackSender],
        Field(
            title=(
                "Sender refers to additional configuration of the Slack application that sends the message.\n+optional"
            )
        ),
    ] = None
    slack_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="slackToken",
            description=(
                "SlackToken refers to the Kubernetes secret that holds the slack token required to send messages."
            ),
        ),
    ] = None
    thread: Annotated[
        Optional[SlackThread],
        Field(title=("Thread refers to additional options for sending messages to a Slack thread.\n+optional")),
    ] = None

attachments class-attribute instance-attribute 

attachments = None

blocks class-attribute instance-attribute 

blocks = None

channel class-attribute instance-attribute 

channel = None

message class-attribute instance-attribute 

message = None

parameters class-attribute instance-attribute 

parameters = None

sender class-attribute instance-attribute 

sender = None

slack_token class-attribute instance-attribute 

slack_token = None

thread class-attribute instance-attribute 

thread = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

StandardK8STrigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
class StandardK8STrigger(BaseModel):
    live_object: Annotated[
        Optional[bool],
        Field(
            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"
            ),
        ),
    ] = None
    operation: Annotated[
        Optional[str],
        Field(
            title=(
                "Operation refers to the type of operation performed on the k8s"
                " resource.\nDefault value is Create.\n+optional"
            )
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(description=("Parameters is the list of parameters that is applied to resolved K8s trigger object.")),
    ] = None
    patch_strategy: Annotated[
        Optional[str],
        Field(
            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'
            ),
        ),
    ] = None
    source: Annotated[Optional[ArtifactLocation], Field(title="Source of the K8s resource file(s)")] = None

live_object class-attribute instance-attribute 

live_object = None

operation class-attribute instance-attribute 

operation = None

parameters class-attribute instance-attribute 

parameters = None

patch_strategy class-attribute instance-attribute 

patch_strategy = None

source class-attribute instance-attribute 

source = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Status

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
class Status(BaseModel):
    conditions: Annotated[
        Optional[List[Condition]],
        Field(
            title=(
                "Conditions are the latest available observations of a resource's"
                " current state.\n+optional\n+patchMergeKey=type\n+patchStrategy=merge"
            )
        ),
    ] = None

conditions class-attribute instance-attribute 

conditions = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

StatusPolicy

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
477
478
class StatusPolicy(BaseModel):
    allow: Optional[List[int]] = None

allow class-attribute instance-attribute 

allow = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

StorageGridEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
class StorageGridEventSource(BaseModel):
    api_url: Annotated[
        Optional[str],
        Field(alias="apiURL", description="APIURL is the url of the storagegrid api."),
    ] = None
    auth_token: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(alias="authToken", title="Auth token for storagegrid api"),
    ] = None
    bucket: Annotated[
        Optional[str],
        Field(description="Name of the bucket to register notifications for."),
    ] = None
    events: Optional[List[str]] = None
    filter: Annotated[
        Optional[StorageGridFilter],
        Field(description="Filter on object key which caused the notification."),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    region: Annotated[Optional[str], Field(title="S3 region.\nDefaults to us-east-1\n+optional")] = None
    topic_arn: Annotated[Optional[str], Field(alias="topicArn", title="TopicArn")] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration for a REST endpoint"),
    ] = None

api_url class-attribute instance-attribute 

api_url = None

auth_token class-attribute instance-attribute 

auth_token = None

bucket class-attribute instance-attribute 

bucket = None

events class-attribute instance-attribute 

events = None

filter class-attribute instance-attribute 

filter = None

metadata class-attribute instance-attribute 

metadata = None

region class-attribute instance-attribute 

region = None

topic_arn class-attribute instance-attribute 

topic_arn = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

StorageGridFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
481
482
483
class StorageGridFilter(BaseModel):
    prefix: Optional[str] = None
    suffix: Optional[str] = None

prefix class-attribute instance-attribute 

prefix = None

suffix class-attribute instance-attribute 

suffix = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

StripeEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
class StripeEventSource(BaseModel):
    api_key: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="apiKey",
            title=(
                "APIKey refers to K8s secret that holds Stripe API key. Used only if"
                " CreateWebhook is enabled.\n+optional"
            ),
        ),
    ] = None
    create_webhook: Annotated[
        Optional[bool],
        Field(
            alias="createWebhook",
            title=("CreateWebhook if specified creates a new webhook programmatically.\n+optional"),
        ),
    ] = None
    event_filter: Annotated[
        Optional[List[str]],
        Field(
            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"
            ),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    webhook: Annotated[
        Optional[WebhookContext],
        Field(title="Webhook holds configuration for a REST endpoint"),
    ] = None

api_key class-attribute instance-attribute 

api_key = None

create_webhook class-attribute instance-attribute 

create_webhook = None

event_filter class-attribute instance-attribute 

event_filter = None

metadata class-attribute instance-attribute 

metadata = None

webhook class-attribute instance-attribute 

webhook = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TLSConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
class TLSConfig(BaseModel):
    ca_cert_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="caCertSecret",
            title="CACertSecret refers to the secret that contains the CA cert",
        ),
    ] = None
    client_cert_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="clientCertSecret",
            title="ClientCertSecret refers to the secret that contains the client cert",
        ),
    ] = None
    client_key_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="clientKeySecret",
            title="ClientKeySecret refers to the secret that contains the client key",
        ),
    ] = None
    insecure_skip_verify: Annotated[
        Optional[bool],
        Field(
            alias="insecureSkipVerify",
            title=(
                "If true, skips creation of TLSConfig with certs and creates an empty"
                " TLSConfig. (Defaults to false)\n+optional"
            ),
        ),
    ] = None

ca_cert_secret class-attribute instance-attribute 

ca_cert_secret = None

client_cert_secret class-attribute instance-attribute 

client_cert_secret = None

client_key_secret class-attribute instance-attribute 

client_key_secret = None

insecure_skip_verify class-attribute instance-attribute 

insecure_skip_verify = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Template

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
class Template(BaseModel):
    affinity: Annotated[
        Optional[v1_1.Affinity],
        Field(title="If specified, the pod's scheduling constraints\n+optional"),
    ] = None
    container: Annotated[
        Optional[v1_1.Container],
        Field(title=("Container is the main container image to run in the sensor pod\n+optional")),
    ] = None
    image_pull_secrets: Annotated[
        Optional[List[v1_1.LocalObjectReference]],
        Field(
            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"
            ),
        ),
    ] = None
    metadata: Annotated[
        Optional[Metadata],
        Field(title="Metadata sets the pods's metadata, i.e. annotations and labels"),
    ] = None
    node_selector: Annotated[
        Optional[Dict[str, str]],
        Field(
            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"
            ),
        ),
    ] = None
    priority: Annotated[
        Optional[int],
        Field(
            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"
            )
        ),
    ] = None
    priority_class_name: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    security_context: Annotated[
        Optional[v1_1.PodSecurityContext],
        Field(
            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"
            ),
        ),
    ] = None
    service_account_name: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    tolerations: Annotated[
        Optional[List[v1_1.Toleration]],
        Field(title="If specified, the pod's tolerations.\n+optional"),
    ] = None
    volumes: Annotated[
        Optional[List[v1_1.Volume]],
        Field(
            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"
            )
        ),
    ] = None

affinity class-attribute instance-attribute 

affinity = None

container class-attribute instance-attribute 

container = None

image_pull_secrets class-attribute instance-attribute 

image_pull_secrets = None

metadata class-attribute instance-attribute 

metadata = None

node_selector class-attribute instance-attribute 

node_selector = None

priority class-attribute instance-attribute 

priority = None

priority_class_name class-attribute instance-attribute 

priority_class_name = None

security_context class-attribute instance-attribute 

security_context = None

service_account_name class-attribute instance-attribute 

service_account_name = None

tolerations class-attribute instance-attribute 

tolerations = None

volumes class-attribute instance-attribute 

volumes = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TimeFilter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
class TimeFilter(BaseModel):
    start: Annotated[
        Optional[str],
        Field(
            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."
            )
        ),
    ] = None
    stop: Annotated[
        Optional[str],
        Field(
            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)."
            )
        ),
    ] = None

start class-attribute instance-attribute 

start = None

stop class-attribute instance-attribute 

stop = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Trigger

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
class Trigger(BaseModel):
    at_least_once: Annotated[
        Optional[bool],
        Field(
            alias="atLeastOnce",
            title=(
                "AtLeastOnce determines the trigger execution semantics.\nDefaults to"
                " false. Trigger execution will use at-most-once semantics.\nIf set to"
                " true, Trigger execution will switch to at-least-once"
                " semantics.\n+kubebuilder:default=false\n+optional"
            ),
        ),
    ] = None
    parameters: Annotated[
        Optional[List[TriggerParameter]],
        Field(title=("Parameters is the list of parameters applied to the trigger template definition")),
    ] = None
    policy: Annotated[
        Optional[TriggerPolicy],
        Field(title=("Policy to configure backoff and execution criteria for the trigger\n+optional")),
    ] = None
    rate_limit: Annotated[
        Optional[RateLimit],
        Field(alias="rateLimit", title="Rate limit, default unit is Second\n+optional"),
    ] = None
    retry_strategy: Annotated[
        Optional[Backoff],
        Field(
            alias="retryStrategy",
            title="Retry strategy, defaults to no retry\n+optional",
        ),
    ] = None
    template: Annotated[
        Optional[TriggerTemplate],
        Field(description="Template describes the trigger specification."),
    ] = None

at_least_once class-attribute instance-attribute 

at_least_once = None

parameters class-attribute instance-attribute 

parameters = None

policy class-attribute instance-attribute 

policy = None

rate_limit class-attribute instance-attribute 

rate_limit = None

retry_strategy class-attribute instance-attribute 

retry_strategy = None

template class-attribute instance-attribute 

template = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TriggerParameter

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
class TriggerParameter(BaseModel):
    dest: Annotated[
        Optional[str],
        Field(
            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."
            )
        ),
    ] = None
    operation: Annotated[
        Optional[str],
        Field(
            description=(
                "Operation is what to do with the existing value at Dest, whether"
                " to\n'prepend', 'overwrite', or 'append' it."
            )
        ),
    ] = None
    src: Annotated[
        Optional[TriggerParameterSource],
        Field(title=("Src contains a source reference to the value of the parameter from a dependency")),
    ] = None

dest class-attribute instance-attribute 

dest = None

operation class-attribute instance-attribute 

operation = None

src class-attribute instance-attribute 

src = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TriggerParameterSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
class TriggerParameterSource(BaseModel):
    context_key: Annotated[
        Optional[str],
        Field(
            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."
            ),
        ),
    ] = None
    context_template: Annotated[
        Optional[str],
        Field(
            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/"
            ),
        ),
    ] = None
    data_key: Annotated[
        Optional[str],
        Field(
            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."
            ),
        ),
    ] = None
    data_template: Annotated[
        Optional[str],
        Field(
            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/"
            ),
        ),
    ] = None
    dependency_name: Annotated[
        Optional[str],
        Field(
            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."
            ),
        ),
    ] = None
    use_raw_data: Annotated[
        Optional[bool],
        Field(
            alias="useRawData",
            title=(
                "UseRawData indicates if the value in an event at data key should be"
                " used without converting to string.\nWhen true, a number, boolean,"
                " json or string parameter may be extracted. When the field is"
                " unspecified, or explicitly\nfalse, the behavior is to turn the"
                " extracted field into a string. (e.g. when set to true, the"
                " parameter\n123 will resolve to the numerical type, but when false, or"
                ' not provided, the string "123" will be resolved)\n+optional'
            ),
        ),
    ] = None
    value: Annotated[
        Optional[str],
        Field(
            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."
            )
        ),
    ] = None

context_key class-attribute instance-attribute 

context_key = None

context_template class-attribute instance-attribute 

context_template = None

data_key class-attribute instance-attribute 

data_key = None

data_template class-attribute instance-attribute 

data_template = None

dependency_name class-attribute instance-attribute 

dependency_name = None

use_raw_data class-attribute instance-attribute 

use_raw_data = None

value class-attribute instance-attribute 

value = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TriggerPolicy

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
class TriggerPolicy(BaseModel):
    k8s: Annotated[
        Optional[K8SResourcePolicy],
        Field(
            title=(
                "K8SResourcePolicy refers to the policy used to check the state of K8s"
                " based triggers using using labels"
            )
        ),
    ] = None
    status: Annotated[
        Optional[StatusPolicy],
        Field(title=("Status refers to the policy used to check the state of the trigger using response status")),
    ] = None

k8s class-attribute instance-attribute 

k8s = None

status class-attribute instance-attribute 

status = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

TriggerTemplate

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
class TriggerTemplate(BaseModel):
    argo_workflow: Annotated[
        Optional[ArgoWorkflowTrigger],
        Field(
            alias="argoWorkflow",
            title=(
                "ArgoWorkflow refers to the trigger that can perform various operations"
                " on an Argo io.argoproj.workflow.v1alpha1.\n+optional"
            ),
        ),
    ] = None
    aws_lambda: Annotated[
        Optional[AWSLambdaTrigger],
        Field(
            alias="awsLambda",
            title=(
                "AWSLambda refers to the trigger designed to invoke AWS Lambda function"
                " with with on-the-fly constructable payload.\n+optional"
            ),
        ),
    ] = None
    azure_event_hubs: Annotated[
        Optional[AzureEventHubsTrigger],
        Field(
            alias="azureEventHubs",
            title=("AzureEventHubs refers to the trigger send an event to an Azure Event Hub.\n+optional"),
        ),
    ] = None
    azure_service_bus: Annotated[
        Optional[AzureServiceBusTrigger],
        Field(
            alias="azureServiceBus",
            title=("AzureServiceBus refers to the trigger designed to place messages on Azure Service Bus\n+optional"),
        ),
    ] = None
    conditions: Annotated[
        Optional[str],
        Field(
            title=(
                "Conditions is the conditions to execute the trigger.\nFor example:"
                ' "(dep01 || dep02) && dep04"\n+optional'
            )
        ),
    ] = None
    conditions_reset: Annotated[
        Optional[List[ConditionsResetCriteria]],
        Field(alias="conditionsReset", title="Criteria to reset the conditons\n+optional"),
    ] = None
    custom: Annotated[
        Optional[CustomTrigger],
        Field(
            title=(
                "CustomTrigger refers to the trigger designed to connect to a gRPC"
                " trigger server and execute a custom trigger.\n+optional"
            )
        ),
    ] = None
    email: Annotated[
        Optional[EmailTrigger],
        Field(title=("Email refers to the trigger designed to send an email notification\n+optional")),
    ] = None
    http: Annotated[
        Optional[HTTPTrigger],
        Field(
            title=(
                "HTTP refers to the trigger designed to dispatch a HTTP request with"
                " on-the-fly constructable payload.\n+optional"
            )
        ),
    ] = None
    k8s: Annotated[
        Optional[StandardK8STrigger],
        Field(
            title=(
                "StandardK8STrigger refers to the trigger designed to create or update"
                " a generic Kubernetes resource.\n+optional"
            )
        ),
    ] = None
    kafka: Annotated[
        Optional[KafkaTrigger],
        Field(description=("Kafka refers to the trigger designed to place messages on Kafka topic.\n+optional.")),
    ] = None
    log: Annotated[
        Optional[LogTrigger],
        Field(
            title=("Log refers to the trigger designed to invoke log the io.argoproj.workflow.v1alpha1.\n+optional")
        ),
    ] = None
    name: Annotated[Optional[str], Field(description="Name is a unique name of the action to take.")] = None
    nats: Annotated[
        Optional[NATSTrigger],
        Field(description=("NATS refers to the trigger designed to place message on NATS subject.\n+optional.")),
    ] = None
    open_whisk: Annotated[
        Optional[OpenWhiskTrigger],
        Field(
            alias="openWhisk",
            title=("OpenWhisk refers to the trigger designed to invoke OpenWhisk action.\n+optional"),
        ),
    ] = None
    pulsar: Annotated[
        Optional[PulsarTrigger],
        Field(title=("Pulsar refers to the trigger designed to place messages on Pulsar topic.\n+optional")),
    ] = None
    slack: Annotated[
        Optional[SlackTrigger],
        Field(title=("Slack refers to the trigger designed to send slack notification message.\n+optional")),
    ] = None

argo_workflow class-attribute instance-attribute 

argo_workflow = None

aws_lambda class-attribute instance-attribute 

aws_lambda = None

azure_event_hubs class-attribute instance-attribute 

azure_event_hubs = None

azure_service_bus class-attribute instance-attribute 

azure_service_bus = None

conditions class-attribute instance-attribute 

conditions = None

conditions_reset class-attribute instance-attribute 

conditions_reset = None

custom class-attribute instance-attribute 

custom = None

email class-attribute instance-attribute 

email = None

http class-attribute instance-attribute 

http = None

k8s class-attribute instance-attribute 

k8s = None

kafka class-attribute instance-attribute 

kafka = None

log class-attribute instance-attribute 

log = None

name class-attribute instance-attribute 

name = None

nats class-attribute instance-attribute 

nats = None

open_whisk class-attribute instance-attribute 

open_whisk = None

pulsar class-attribute instance-attribute 

pulsar = None

slack class-attribute instance-attribute 

slack = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

URLArtifact

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
155
156
157
158
159
160
161
162
163
class URLArtifact(BaseModel):
    path: Annotated[Optional[str], Field(title="Path is the complete URL")] = None
    verify_cert: Annotated[
        Optional[bool],
        Field(
            alias="verifyCert",
            title="VerifyCert decides whether the connection is secure or not",
        ),
    ] = None

path class-attribute instance-attribute 

path = None

verify_cert class-attribute instance-attribute 

verify_cert = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

ValueFromSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
1176
1177
1178
class ValueFromSource(BaseModel):
    config_map_key_ref: Annotated[Optional[v1_1.ConfigMapKeySelector], Field(alias="configMapKeyRef")] = None
    secret_key_ref: Annotated[Optional[v1_1.SecretKeySelector], Field(alias="secretKeyRef")] = None

config_map_key_ref class-attribute instance-attribute 

config_map_key_ref = None

secret_key_ref class-attribute instance-attribute 

secret_key_ref = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

WatchPathConfig

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
318
319
320
321
322
323
324
325
326
327
328
329
330
class WatchPathConfig(BaseModel):
    directory: Annotated[Optional[str], Field(title="Directory to watch for events")] = None
    path: Annotated[
        Optional[str],
        Field(title=("Path is relative path of object to watch with respect to the directory")),
    ] = None
    path_regexp: Annotated[
        Optional[str],
        Field(
            alias="pathRegexp",
            title=("PathRegexp is regexp of relative path of object to watch with respect to the directory"),
        ),
    ] = None

directory class-attribute instance-attribute 

directory = None

path class-attribute instance-attribute 

path = None

path_regexp class-attribute instance-attribute 

path_regexp = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

WebhookContext

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
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
class WebhookContext(BaseModel):
    auth_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="authSecret",
            title=("AuthSecret holds a secret selector that contains a bearer token for authentication\n+optional"),
        ),
    ] = None
    endpoint: Annotated[Optional[str], Field(title="REST API endpoint")] = None
    max_payload_size: Annotated[
        Optional[str],
        Field(
            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"
            ),
        ),
    ] = None
    metadata: Annotated[
        Optional[Dict[str, str]],
        Field(
            title=("Metadata holds the user defined metadata which will passed along the event payload.\n+optional")
        ),
    ] = None
    method: Annotated[
        Optional[str],
        Field(
            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"
            )
        ),
    ] = None
    port: Annotated[
        Optional[str],
        Field(description="Port on which HTTP server is listening for incoming events."),
    ] = None
    server_cert_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="serverCertSecret",
            description="ServerCertPath refers the file that contains the cert.",
        ),
    ] = None
    server_key_secret: Annotated[
        Optional[v1_1.SecretKeySelector],
        Field(
            alias="serverKeySecret",
            title="ServerKeyPath refers the file that contains private key",
        ),
    ] = None
    url: Annotated[Optional[str], Field(description="URL is the url of the server.")] = None

auth_secret class-attribute instance-attribute 

auth_secret = None

endpoint class-attribute instance-attribute 

endpoint = None

max_payload_size class-attribute instance-attribute 

max_payload_size = None

metadata class-attribute instance-attribute 

metadata = None

method class-attribute instance-attribute 

method = None

port class-attribute instance-attribute 

port = None

server_cert_secret class-attribute instance-attribute 

server_cert_secret = None

server_key_secret class-attribute instance-attribute 

server_key_secret = None

url class-attribute instance-attribute 

url = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

WebhookEventSource

Source code in src/hera/events/models/io/argoproj/events/v1alpha1.py 
2298
2299
2300
class WebhookEventSource(BaseModel):
    filter: Annotated[Optional[EventSourceFilter], Field(title="Filter\n+optional")] = None
    webhook_context: Annotated[Optional[WebhookContext], Field(alias="webhookContext")] = None

filter class-attribute instance-attribute 

filter = None

webhook_context class-attribute instance-attribute 

webhook_context = None

Config

Config class dictates the behavior of the underlying Pydantic model.

See Pydantic documentation for more info.

Source code in src/hera/shared/_pydantic.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class Config:
    """Config class dictates the behavior of the underlying Pydantic model.

    See Pydantic documentation for more info.
    """

    allow_population_by_field_name = True
    """support populating Hera object fields by their Field alias"""

    allow_mutation = True
    """supports mutating Hera objects post instantiation"""

    use_enum_values = True
    """supports using enums, which are then unpacked to obtain the actual `.value`, on Hera objects"""

    arbitrary_types_allowed = True
    """supports specifying arbitrary types for any field to support Hera object fields processing"""

    smart_union = True
    """uses smart union for matching a field's specified value to the underlying type that's part of a union"""

allow_mutation class-attribute instance-attribute 

allow_mutation = True

supports mutating Hera objects post instantiation

allow_population_by_field_name class-attribute instance-attribute 

allow_population_by_field_name = True

support populating Hera object fields by their Field alias

arbitrary_types_allowed class-attribute instance-attribute 

arbitrary_types_allowed = True

supports specifying arbitrary types for any field to support Hera object fields processing

smart_union class-attribute instance-attribute 

smart_union = True

uses smart union for matching a field’s specified value to the underlying type that’s part of a union

use_enum_values class-attribute instance-attribute 

use_enum_values = True

supports using enums, which are then unpacked to obtain the actual .value, on Hera objects

Comments