Hera Workflows Auto-generated Models
hera.workflows.models
Amount
ArchiveStrategy
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArchivedWorkflowDeletedResponse
Arguments
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtGCStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
not_specified
class-attribute
instance-attribute
not_specified: Optional[bool] = Field(None, alias='notSpecified', description="if this is true, we already checked to see if we need to do it and we don't")
Artifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 |
|
archive
class-attribute
instance-attribute
archive: Optional[ArchiveStrategy] = Field(None, description='Archive controls how the artifact will be saved to the artifact repository.')
archive_logs
class-attribute
instance-attribute
archive_logs: Optional[bool] = Field(None, alias='archiveLogs', description='ArchiveLogs indicates if the container logs should be archived')
artifact_gc
class-attribute
instance-attribute
artifact_gc: Optional[ArtifactGC] = Field(None, alias='artifactGC', description='ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows')
artifactory
class-attribute
instance-attribute
artifactory: Optional[ArtifactoryArtifact] = Field(None, description='Artifactory contains artifactory artifact location details')
azure
class-attribute
instance-attribute
azure: Optional[AzureArtifact] = Field(None, description='Azure contains Azure Storage artifact location details')
deleted
class-attribute
instance-attribute
from_
class-attribute
instance-attribute
from_: Optional[str] = Field(None, alias='from', description='From allows an artifact to reference an artifact from a previous step')
from_expression
class-attribute
instance-attribute
from_expression: Optional[str] = Field(None, alias='fromExpression', description='FromExpression, if defined, is evaluated to specify the value for the artifact')
gcs
class-attribute
instance-attribute
git
class-attribute
instance-attribute
global_name
class-attribute
instance-attribute
global_name: Optional[str] = Field(None, alias='globalName', description="GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts")
hdfs
class-attribute
instance-attribute
hdfs: Optional[HDFSArtifact] = Field(None, description='HDFS contains HDFS artifact location details')
http
class-attribute
instance-attribute
http: Optional[HTTPArtifact] = Field(None, description='HTTP contains HTTP artifact location details')
mode
class-attribute
instance-attribute
mode: Optional[int] = Field(None, description='mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.')
name
class-attribute
instance-attribute
name: str = Field(Ellipsis, description="name of the artifact. must be unique within a template's inputs/outputs.")
optional
class-attribute
instance-attribute
optional: Optional[bool] = Field(None, description="Make Artifacts optional, if Artifacts doesn't generate or exist")
oss
class-attribute
instance-attribute
path
class-attribute
instance-attribute
raw
class-attribute
instance-attribute
recurse_mode
class-attribute
instance-attribute
recurse_mode: Optional[bool] = Field(None, alias='recurseMode', description='If mode is set, apply the permission recursively into the artifact if it is a folder')
s3
class-attribute
instance-attribute
ArtifactGC
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
pod_metadata
class-attribute
instance-attribute
pod_metadata: Optional[Metadata] = Field(None, alias='podMetadata', description='PodMetadata is an optional field for specifying the Labels and Annotations that should be assigned to the Pod doing the deletion')
ArtifactGCSpec
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactGCStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactLocation
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
archive_logs
class-attribute
instance-attribute
archive_logs: Optional[bool] = Field(None, alias='archiveLogs', description='ArchiveLogs indicates if the container logs should be archived')
artifactory
class-attribute
instance-attribute
artifactory: Optional[ArtifactoryArtifact] = Field(None, description='Artifactory contains artifactory artifact location details')
azure
class-attribute
instance-attribute
azure: Optional[AzureArtifact] = Field(None, description='Azure contains Azure Storage artifact location details')
gcs
class-attribute
instance-attribute
git
class-attribute
instance-attribute
hdfs
class-attribute
instance-attribute
hdfs: Optional[HDFSArtifact] = Field(None, description='HDFS contains HDFS artifact location details')
http
class-attribute
instance-attribute
http: Optional[HTTPArtifact] = Field(None, description='HTTP contains HTTP artifact location details')
oss
class-attribute
instance-attribute
raw
class-attribute
instance-attribute
ArtifactNodeSpec
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactPaths
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 |
|
archive
class-attribute
instance-attribute
archive: Optional[ArchiveStrategy] = Field(None, description='Archive controls how the artifact will be saved to the artifact repository.')
archive_logs
class-attribute
instance-attribute
archive_logs: Optional[bool] = Field(None, alias='archiveLogs', description='ArchiveLogs indicates if the container logs should be archived')
artifact_gc
class-attribute
instance-attribute
artifact_gc: Optional[ArtifactGC] = Field(None, alias='artifactGC', description='ArtifactGC describes the strategy to use when to deleting an artifact from completed or deleted workflows')
artifactory
class-attribute
instance-attribute
artifactory: Optional[ArtifactoryArtifact] = Field(None, description='Artifactory contains artifactory artifact location details')
azure
class-attribute
instance-attribute
azure: Optional[AzureArtifact] = Field(None, description='Azure contains Azure Storage artifact location details')
deleted
class-attribute
instance-attribute
from_
class-attribute
instance-attribute
from_: Optional[str] = Field(None, alias='from', description='From allows an artifact to reference an artifact from a previous step')
from_expression
class-attribute
instance-attribute
from_expression: Optional[str] = Field(None, alias='fromExpression', description='FromExpression, if defined, is evaluated to specify the value for the artifact')
gcs
class-attribute
instance-attribute
git
class-attribute
instance-attribute
global_name
class-attribute
instance-attribute
global_name: Optional[str] = Field(None, alias='globalName', description="GlobalName exports an output artifact to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.artifacts.XXXX}} and in workflow.status.outputs.artifacts")
hdfs
class-attribute
instance-attribute
hdfs: Optional[HDFSArtifact] = Field(None, description='HDFS contains HDFS artifact location details')
http
class-attribute
instance-attribute
http: Optional[HTTPArtifact] = Field(None, description='HTTP contains HTTP artifact location details')
mode
class-attribute
instance-attribute
mode: Optional[int] = Field(None, description='mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.')
name
class-attribute
instance-attribute
name: str = Field(Ellipsis, description="name of the artifact. must be unique within a template's inputs/outputs.")
optional
class-attribute
instance-attribute
optional: Optional[bool] = Field(None, description="Make Artifacts optional, if Artifacts doesn't generate or exist")
oss
class-attribute
instance-attribute
path
class-attribute
instance-attribute
raw
class-attribute
instance-attribute
recurse_mode
class-attribute
instance-attribute
recurse_mode: Optional[bool] = Field(None, alias='recurseMode', description='If mode is set, apply the permission recursively into the artifact if it is a folder')
s3
class-attribute
instance-attribute
ArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
archive_logs
class-attribute
instance-attribute
archive_logs: Optional[bool] = Field(None, alias='archiveLogs', description='ArchiveLogs enables log archiving')
artifactory
class-attribute
instance-attribute
artifactory: Optional[ArtifactoryArtifactRepository] = Field(None, description='Artifactory stores artifacts to JFrog Artifactory')
azure
class-attribute
instance-attribute
azure: Optional[AzureArtifactRepository] = Field(None, description='Azure stores artifact in an Azure Storage account')
gcs
class-attribute
instance-attribute
gcs: Optional[GCSArtifactRepository] = Field(None, description='GCS stores artifact in a GCS object store')
hdfs
class-attribute
instance-attribute
ArtifactRepositoryRef
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactRepositoryRefStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
artifact_repository
class-attribute
instance-attribute
artifact_repository: Optional[ArtifactRepository] = Field(None, alias='artifactRepository', description='The repository the workflow will use. This maybe empty before v3.1.')
config_map
class-attribute
instance-attribute
config_map: Optional[str] = Field(None, alias='configMap', description='The name of the config map. Defaults to "artifact-repositories".')
default
class-attribute
instance-attribute
default: Optional[bool] = Field(None, description='If this ref represents the default artifact repository, rather than a config map.')
ArtifactResult
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactResultNodeStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactoryArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ArtifactoryArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
password_secret
class-attribute
instance-attribute
password_secret: Optional[v1.SecretKeySelector] = Field(None, alias='passwordSecret', description='PasswordSecret is the secret selector to the repository password')
AzureArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
account_key_secret
class-attribute
instance-attribute
account_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accountKeySecret', description='AccountKeySecret is the secret selector to the Azure Blob Storage account access key')
blob
class-attribute
instance-attribute
blob: str = Field(Ellipsis, description='Blob is the blob name (i.e., path) in the container where the artifact resides')
container
class-attribute
instance-attribute
container: str = Field(Ellipsis, description='Container is the container where resources will be stored')
AzureArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
account_key_secret
class-attribute
instance-attribute
account_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accountKeySecret', description='AccountKeySecret is the secret selector to the Azure Blob Storage account access key')
blob_name_format
class-attribute
instance-attribute
blob_name_format: Optional[str] = Field(None, alias='blobNameFormat', description='BlobNameFormat is defines the format of how to store blob names. Can reference workflow variables')
container
class-attribute
instance-attribute
container: str = Field(Ellipsis, description='Container is the container where resources will be stored')
Backoff
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
duration
class-attribute
instance-attribute
duration: Optional[str] = Field(None, description='Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")')
BasicAuth
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Cache
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ClientCertAuth
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ClusterWorkflowTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
ClusterWorkflowTemplateCreateRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ClusterWorkflowTemplateDeleteResponse
ClusterWorkflowTemplateLintRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ClusterWorkflowTemplateList
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
ClusterWorkflowTemplateUpdateRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
CollectEventRequest
CollectEventResponse
Condition
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
message
class-attribute
instance-attribute
status
class-attribute
instance-attribute
ContainerNode
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 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 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 |
|
args
class-attribute
instance-attribute
args: Optional[List[str]] = Field(None, description='Arguments to the entrypoint. The container image\'s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
command
class-attribute
instance-attribute
command: Optional[List[str]] = Field(None, description='Entrypoint array. Not executed within a shell. The container image\'s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
env
class-attribute
instance-attribute
env: Optional[List[v1.EnvVar]] = Field(None, description='List of environment variables to set in the container. Cannot be updated.')
env_from
class-attribute
instance-attribute
env_from: Optional[List[v1.EnvFromSource]] = Field(None, alias='envFrom', description='List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.')
image
class-attribute
instance-attribute
image: Optional[str] = Field(None, description='Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.')
image_pull_policy
class-attribute
instance-attribute
image_pull_policy: Optional[str] = Field(None, alias='imagePullPolicy', description='Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images')
lifecycle
class-attribute
instance-attribute
lifecycle: Optional[v1.Lifecycle] = Field(None, description='Actions that the management system should take in response to container lifecycle events. Cannot be updated.')
liveness_probe
class-attribute
instance-attribute
liveness_probe: Optional[v1.Probe] = Field(None, alias='livenessProbe', description='Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
name
class-attribute
instance-attribute
name: str = Field(Ellipsis, description='Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.')
ports
class-attribute
instance-attribute
ports: Optional[List[v1.ContainerPort]] = Field(None, description='List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.')
readiness_probe
class-attribute
instance-attribute
readiness_probe: Optional[v1.Probe] = Field(None, alias='readinessProbe', description='Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
resources
class-attribute
instance-attribute
resources: Optional[v1.ResourceRequirements] = Field(None, description='Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/')
security_context
class-attribute
instance-attribute
security_context: Optional[v1.SecurityContext] = Field(None, alias='securityContext', description='SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/')
startup_probe
class-attribute
instance-attribute
startup_probe: Optional[v1.Probe] = Field(None, alias='startupProbe', description="StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes")
stdin
class-attribute
instance-attribute
stdin: Optional[bool] = Field(None, description='Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.')
stdin_once
class-attribute
instance-attribute
stdin_once: Optional[bool] = Field(None, alias='stdinOnce', description='Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false')
termination_message_path
class-attribute
instance-attribute
termination_message_path: Optional[str] = Field(None, alias='terminationMessagePath', description="Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.")
termination_message_policy
class-attribute
instance-attribute
termination_message_policy: Optional[str] = Field(None, alias='terminationMessagePolicy', description='Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.')
tty
class-attribute
instance-attribute
tty: Optional[bool] = Field(None, description="Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.")
volume_devices
class-attribute
instance-attribute
volume_devices: Optional[List[v1.VolumeDevice]] = Field(None, alias='volumeDevices', description='volumeDevices is the list of block devices to be used by the container.')
ContainerSetRetryStrategy
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ContainerSetTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
retry_strategy
class-attribute
instance-attribute
retry_strategy: Optional[ContainerSetRetryStrategy] = Field(None, alias='retryStrategy', description='RetryStrategy describes how to retry a container nodes in the container set if it fails. Nbr of retries(default 0) and sleep duration between retries(default 0s, instant retry) can be set.')
ContinueOn
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Counter
CreateCronWorkflowRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
create_options
class-attribute
instance-attribute
cron_workflow
class-attribute
instance-attribute
CreateS3BucketOptions
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
CronWorkflow
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
CronWorkflowDeletedResponse
CronWorkflowList
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
CronWorkflowResumeRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
CronWorkflowSpec
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
concurrency_policy
class-attribute
instance-attribute
concurrency_policy: Optional[str] = Field(None, alias='concurrencyPolicy', description='ConcurrencyPolicy is the K8s-style concurrency policy that will be used')
failed_jobs_history_limit
class-attribute
instance-attribute
failed_jobs_history_limit: Optional[int] = Field(None, alias='failedJobsHistoryLimit', description='FailedJobsHistoryLimit is the number of failed jobs to be kept at a time')
schedule
class-attribute
instance-attribute
schedule: str = Field(Ellipsis, description='Schedule is a schedule to run the Workflow in Cron format')
starting_deadline_seconds
class-attribute
instance-attribute
starting_deadline_seconds: Optional[int] = Field(None, alias='startingDeadlineSeconds', description='StartingDeadlineSeconds is the K8s-style deadline that will limit the time a CronWorkflow will be run after its original scheduled time if it is missed.')
successful_jobs_history_limit
class-attribute
instance-attribute
successful_jobs_history_limit: Optional[int] = Field(None, alias='successfulJobsHistoryLimit', description='SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time')
suspend
class-attribute
instance-attribute
suspend: Optional[bool] = Field(None, description='Suspend is a flag that will stop new CronWorkflows from running if set to true')
timezone
class-attribute
instance-attribute
timezone: Optional[str] = Field(None, description='Timezone is the timezone against which the cron schedule will be calculated, e.g. "Asia/Tokyo". Default is machine\'s local time.')
CronWorkflowStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
active
class-attribute
instance-attribute
active: List[v1.ObjectReference] = Field(Ellipsis, description='Active is a list of active workflows stemming from this CronWorkflow')
CronWorkflowSuspendRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
DAGTask
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
arguments
class-attribute
instance-attribute
arguments: Optional[Arguments] = Field(None, description='Arguments are the parameter and artifact arguments to the template')
continue_on
class-attribute
instance-attribute
continue_on: Optional[ContinueOn] = Field(None, alias='continueOn', description='ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified')
dependencies
class-attribute
instance-attribute
dependencies: Optional[List[str]] = Field(None, description='Dependencies are name of other targets which this depends on')
depends
class-attribute
instance-attribute
depends: Optional[str] = Field(None, description='Depends are name of other targets which this depends on')
hooks
class-attribute
instance-attribute
hooks: Optional[Dict[str, LifecycleHook]] = Field(None, description='Hooks hold the lifecycle hook which is invoked at lifecycle of task, irrespective of the success, failure, or error status of the primary task')
inline
class-attribute
instance-attribute
inline: Optional[Template] = Field(None, description='Inline is the template. Template must be empty if this is declared (and vice-versa).')
name
class-attribute
instance-attribute
on_exit
class-attribute
instance-attribute
on_exit: Optional[str] = Field(None, alias='onExit', description='OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead.')
template
class-attribute
instance-attribute
template_ref
class-attribute
instance-attribute
template_ref: Optional[TemplateRef] = Field(None, alias='templateRef', description='TemplateRef is the reference to the template resource to execute.')
when
class-attribute
instance-attribute
when: Optional[str] = Field(None, description='When is an expression in which the task should conditionally execute')
with_items
class-attribute
instance-attribute
with_items: Optional[List[Item]] = Field(None, alias='withItems', description='WithItems expands a task into multiple parallel tasks from the items in the list')
DAGTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
fail_fast
class-attribute
instance-attribute
fail_fast: Optional[bool] = Field(None, alias='failFast', description='This flag is for DAG logic. The DAG logic has a built-in "fail fast" feature to stop scheduling new steps, as soon as it detects that one of the DAG nodes is failed. Then it waits until all DAG nodes are completed before failing the DAG itself. The FailFast flag default is true, if set to false, it will allow a DAG to run all branches of the DAG to completion (either success or failure), regardless of the failed outcomes of branches in the DAG. More info and example about this feature at https://github.com/argoproj/argo-workflows/issues/1442')
Data
DataSource
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Event
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
EventResponse
ExecutorConfig
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
GCSArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
bucket
class-attribute
instance-attribute
key
class-attribute
instance-attribute
GCSArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Gauge
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
GetUserInfoResponse
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
email_verified
class-attribute
instance-attribute
service_account_name
class-attribute
instance-attribute
service_account_namespace
class-attribute
instance-attribute
GitArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
branch
class-attribute
instance-attribute
branch: Optional[str] = Field(None, description='Branch is the branch to fetch when `SingleBranch` is enabled')
depth
class-attribute
instance-attribute
depth: Optional[int] = Field(None, description='Depth specifies clones/fetches should be shallow and include the given number of commits from the branch tip')
disable_submodules
class-attribute
instance-attribute
disable_submodules: Optional[bool] = Field(None, alias='disableSubmodules', description='DisableSubmodules disables submodules during git clone')
fetch
class-attribute
instance-attribute
fetch: Optional[List[str]] = Field(None, description='Fetch specifies a number of refs that should be fetched before checkout')
insecure_ignore_host_key
class-attribute
instance-attribute
insecure_ignore_host_key: Optional[bool] = Field(None, alias='insecureIgnoreHostKey', description='InsecureIgnoreHostKey disables SSH strict host key checking during git clone')
password_secret
class-attribute
instance-attribute
password_secret: Optional[v1.SecretKeySelector] = Field(None, alias='passwordSecret', description='PasswordSecret is the secret selector to the repository password')
repo
class-attribute
instance-attribute
revision
class-attribute
instance-attribute
revision: Optional[str] = Field(None, description='Revision is the git commit, tag, branch to checkout')
single_branch
class-attribute
instance-attribute
single_branch: Optional[bool] = Field(None, alias='singleBranch', description='SingleBranch enables single branch clone, using the `branch` parameter')
HDFSArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
addresses
class-attribute
instance-attribute
addresses: Optional[List[str]] = Field(None, description='Addresses is accessible addresses of HDFS name nodes')
force
class-attribute
instance-attribute
hdfs_user
class-attribute
instance-attribute
hdfs_user: Optional[str] = Field(None, alias='hdfsUser', description='HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.')
krb_c_cache_secret
class-attribute
instance-attribute
krb_c_cache_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbCCacheSecret', description='KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.')
krb_config_config_map
class-attribute
instance-attribute
krb_config_config_map: Optional[v1.ConfigMapKeySelector] = Field(None, alias='krbConfigConfigMap', description='KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.')
krb_keytab_secret
class-attribute
instance-attribute
krb_keytab_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbKeytabSecret', description='KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.')
krb_realm
class-attribute
instance-attribute
krb_realm: Optional[str] = Field(None, alias='krbRealm', description='KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.')
krb_service_principal_name
class-attribute
instance-attribute
krb_service_principal_name: Optional[str] = Field(None, alias='krbServicePrincipalName', description='KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.')
HDFSArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
addresses
class-attribute
instance-attribute
addresses: Optional[List[str]] = Field(None, description='Addresses is accessible addresses of HDFS name nodes')
force
class-attribute
instance-attribute
hdfs_user
class-attribute
instance-attribute
hdfs_user: Optional[str] = Field(None, alias='hdfsUser', description='HDFSUser is the user to access HDFS file system. It is ignored if either ccache or keytab is used.')
krb_c_cache_secret
class-attribute
instance-attribute
krb_c_cache_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbCCacheSecret', description='KrbCCacheSecret is the secret selector for Kerberos ccache Either ccache or keytab can be set to use Kerberos.')
krb_config_config_map
class-attribute
instance-attribute
krb_config_config_map: Optional[v1.ConfigMapKeySelector] = Field(None, alias='krbConfigConfigMap', description='KrbConfig is the configmap selector for Kerberos config as string It must be set if either ccache or keytab is used.')
krb_keytab_secret
class-attribute
instance-attribute
krb_keytab_secret: Optional[v1.SecretKeySelector] = Field(None, alias='krbKeytabSecret', description='KrbKeytabSecret is the secret selector for Kerberos keytab Either ccache or keytab can be set to use Kerberos.')
krb_realm
class-attribute
instance-attribute
krb_realm: Optional[str] = Field(None, alias='krbRealm', description='KrbRealm is the Kerberos realm used with Kerberos keytab It must be set if keytab is used.')
krb_service_principal_name
class-attribute
instance-attribute
krb_service_principal_name: Optional[str] = Field(None, alias='krbServicePrincipalName', description='KrbServicePrincipalName is the principal name of Kerberos service It must be set if either ccache or keytab is used.')
HTTP
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
body
class-attribute
instance-attribute
body_from
class-attribute
instance-attribute
body_from: Optional[HTTPBodySource] = Field(None, alias='bodyFrom', description='BodyFrom is content of the HTTP Request as Bytes')
headers
class-attribute
instance-attribute
headers: Optional[List[HTTPHeader]] = Field(None, description='Headers are an optional list of headers to send with HTTP requests')
insecure_skip_verify
class-attribute
instance-attribute
insecure_skip_verify: Optional[bool] = Field(None, alias='insecureSkipVerify', description='InsecureSkipVerify is a bool when if set to true will skip TLS verification for the HTTP client')
method
class-attribute
instance-attribute
success_condition
class-attribute
instance-attribute
success_condition: Optional[str] = Field(None, alias='successCondition', description='SuccessCondition is an expression if evaluated to true is considered successful')
HTTPArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
auth
class-attribute
instance-attribute
auth: Optional[HTTPAuth] = Field(None, description='Auth contains information for client authentication')
HTTPAuth
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
basic_auth
class-attribute
instance-attribute
client_cert
class-attribute
instance-attribute
HTTPBodySource
HTTPHeader
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
HTTPHeaderSource
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Header
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Histogram
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
InfoResponse
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
managed_namespace
class-attribute
instance-attribute
modals
class-attribute
instance-attribute
Inputs
Item
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
LabelKeys
LabelValueFrom
LabelValues
LifecycleHook
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
arguments
class-attribute
instance-attribute
arguments: Optional[Arguments] = Field(None, description='Arguments hold arguments to the template')
expression
class-attribute
instance-attribute
expression: Optional[str] = Field(None, description='Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored')
Link
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
name
class-attribute
instance-attribute
scope
class-attribute
instance-attribute
scope: str = Field(Ellipsis, description='"workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs" or "chat"')
url
class-attribute
instance-attribute
url: str = Field(Ellipsis, description='The URL. Can contain "${metadata.namespace}", "${metadata.name}", "${status.startedAt}", "${status.finishedAt}" or any other element in workflow yaml, e.g. "${io.argoproj.workflow.v1alpha1.metadata.annotations.userDefinedKey}"')
LintCronWorkflowRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
LogEntry
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ManifestFrom
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
MemoizationStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
cache_name
class-attribute
instance-attribute
cache_name: str = Field(Ellipsis, alias='cacheName', description='Cache is the name of the cache that was used')
Memoize
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
cache
class-attribute
instance-attribute
key
class-attribute
instance-attribute
Metadata
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
MetricLabel
Metrics
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Mutex
MutexHolding
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
holder
class-attribute
instance-attribute
holder: Optional[str] = Field(None, description="Holder is a reference to the object which holds the Mutex. Holding Scenario:\n 1. Current workflow's NodeID which is holding the lock.\n e.g: ${NodeID}\nWaiting Scenario:\n 1. Current workflow or other workflow NodeID which is holding the lock.\n e.g: ${WorkflowName}/${NodeID}")
MutexStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
NodeResult
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
NodeStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 |
|
boundary_id
class-attribute
instance-attribute
boundary_id: Optional[str] = Field(None, alias='boundaryID', description='BoundaryID indicates the node ID of the associated template root node in which this node belongs to')
children
class-attribute
instance-attribute
daemoned
class-attribute
instance-attribute
daemoned: Optional[bool] = Field(None, description='Daemoned tracks whether or not this node was daemoned and need to be terminated')
display_name
class-attribute
instance-attribute
display_name: Optional[str] = Field(None, alias='displayName', description='DisplayName is a human readable representation of the node. Unique within a template boundary')
estimated_duration
class-attribute
instance-attribute
estimated_duration: Optional[int] = Field(None, alias='estimatedDuration', description='EstimatedDuration in seconds.')
finished_at
class-attribute
instance-attribute
finished_at: Optional[v1_1.Time] = Field(None, alias='finishedAt', description='Time at which this node completed')
host_node_name
class-attribute
instance-attribute
host_node_name: Optional[str] = Field(None, alias='hostNodeName', description='HostNodeName name of the Kubernetes node on which the Pod is running, if applicable')
id
class-attribute
instance-attribute
id: str = Field(Ellipsis, description='ID is a unique identifier of a node within the worklow It is implemented as a hash of the node name, which makes the ID deterministic')
inputs
class-attribute
instance-attribute
inputs: Optional[Inputs] = Field(None, description='Inputs captures input parameter values and artifact locations supplied to this template invocation')
memoization_status
class-attribute
instance-attribute
memoization_status: Optional[MemoizationStatus] = Field(None, alias='memoizationStatus', description='MemoizationStatus holds information about cached nodes')
message
class-attribute
instance-attribute
message: Optional[str] = Field(None, description='A human readable message indicating details about why the node is in this condition.')
name
class-attribute
instance-attribute
name: str = Field(Ellipsis, description='Name is unique name in the node tree used to generate the node ID')
outbound_nodes
class-attribute
instance-attribute
outbound_nodes: Optional[List[str]] = Field(None, alias='outboundNodes', description='OutboundNodes tracks the node IDs which are considered "outbound" nodes to a template invocation. For every invocation of a template, there are nodes which we considered as "outbound". Essentially, these are last nodes in the execution sequence to run, before the template is considered completed. These nodes are then connected as parents to a following step.\n\nIn the case of single pod steps (i.e. container, script, resource templates), this list will be nil since the pod itself is already considered the "outbound" node. In the case of DAGs, outbound nodes are the "target" tasks (tasks with no children). In the case of steps, outbound nodes are all the containers involved in the last step group. NOTE: since templates are composable, the list of outbound nodes are carried upwards when a DAG/steps template invokes another DAG/steps template. In other words, the outbound nodes of a template, will be a superset of the outbound nodes of its last children.')
outputs
class-attribute
instance-attribute
outputs: Optional[Outputs] = Field(None, description='Outputs captures output parameter values and artifact locations produced by this template invocation')
phase
class-attribute
instance-attribute
phase: Optional[str] = Field(None, description='Phase a simple, high-level summary of where the node is in its lifecycle. Can be used as a state machine.')
pod_ip
class-attribute
instance-attribute
pod_ip: Optional[str] = Field(None, alias='podIP', description='PodIP captures the IP of the pod for daemoned steps')
progress
class-attribute
instance-attribute
resources_duration
class-attribute
instance-attribute
resources_duration: Optional[Dict[str, int]] = Field(None, alias='resourcesDuration', description='ResourcesDuration is indicative, but not accurate, resource duration. This is populated when the nodes completes.')
started_at
class-attribute
instance-attribute
started_at: Optional[v1_1.Time] = Field(None, alias='startedAt', description='Time at which this node started')
synchronization_status
class-attribute
instance-attribute
synchronization_status: Optional[NodeSynchronizationStatus] = Field(None, alias='synchronizationStatus', description='SynchronizationStatus is the synchronization status of the node')
template_name
class-attribute
instance-attribute
template_name: Optional[str] = Field(None, alias='templateName', description='TemplateName is the template name which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)')
template_ref
class-attribute
instance-attribute
template_ref: Optional[TemplateRef] = Field(None, alias='templateRef', description='TemplateRef is the reference to the template resource which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)')
NodeSynchronizationStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
NoneStrategy
OAuth2Auth
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
client_id_secret
class-attribute
instance-attribute
client_secret_secret
class-attribute
instance-attribute
endpoint_params
class-attribute
instance-attribute
OAuth2EndpointParam
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
OSSArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
access_key_secret
class-attribute
instance-attribute
access_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present: Optional[bool] = Field(None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist")
endpoint
class-attribute
instance-attribute
endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')
key
class-attribute
instance-attribute
lifecycle_rule
class-attribute
instance-attribute
lifecycle_rule: Optional[OSSLifecycleRule] = Field(None, alias='lifecycleRule', description="LifecycleRule specifies how to manage bucket's lifecycle")
OSSArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
access_key_secret
class-attribute
instance-attribute
access_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present: Optional[bool] = Field(None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the OSS bucket for output artifacts, if it doesn't exist")
endpoint
class-attribute
instance-attribute
endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')
key_format
class-attribute
instance-attribute
key_format: Optional[str] = Field(None, alias='keyFormat', description='KeyFormat is defines the format of how to store keys. Can reference workflow variables')
lifecycle_rule
class-attribute
instance-attribute
lifecycle_rule: Optional[OSSLifecycleRule] = Field(None, alias='lifecycleRule', description="LifecycleRule specifies how to manage bucket's lifecycle")
OSSLifecycleRule
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
mark_deletion_after_days
class-attribute
instance-attribute
mark_deletion_after_days: Optional[int] = Field(None, alias='markDeletionAfterDays', description='MarkDeletionAfterDays is the number of days before we delete objects in the bucket')
mark_infrequent_access_after_days
class-attribute
instance-attribute
mark_infrequent_access_after_days: Optional[int] = Field(None, alias='markInfrequentAccessAfterDays', description='MarkInfrequentAccessAfterDays is the number of days before we convert the objects in the bucket to Infrequent Access (IA) storage type')
Outputs
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
artifacts
class-attribute
instance-attribute
artifacts: Optional[List[Artifact]] = Field(None, description='Artifacts holds the list of output artifacts produced by a step')
exit_code
class-attribute
instance-attribute
exit_code: Optional[str] = Field(None, alias='exitCode', description='ExitCode holds the exit code of a script template')
ParallelSteps
Parameter
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
default
class-attribute
instance-attribute
default: Optional[str] = Field(None, description='Default is the default value to use for an input parameter if a value was not supplied')
description
class-attribute
instance-attribute
enum
class-attribute
instance-attribute
enum: Optional[List[str]] = Field(None, description='Enum holds a list of string values to choose from, for the actual value of the parameter')
global_name
class-attribute
instance-attribute
global_name: Optional[str] = Field(None, alias='globalName', description="GlobalName exports an output parameter to the global scope, making it available as '{{io.argoproj.workflow.v1alpha1.outputs.parameters.XXXX}} and in workflow.status.outputs.parameters")
name
class-attribute
instance-attribute
Plugin
PodGC
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Prometheus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
counter
class-attribute
instance-attribute
gauge
class-attribute
instance-attribute
help
class-attribute
instance-attribute
histogram
class-attribute
instance-attribute
labels
class-attribute
instance-attribute
name
class-attribute
instance-attribute
RawArtifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
ResourceTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
action
class-attribute
instance-attribute
action: str = Field(Ellipsis, description='Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace, patch')
failure_condition
class-attribute
instance-attribute
failure_condition: Optional[str] = Field(None, alias='failureCondition', description='FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed')
flags
class-attribute
instance-attribute
flags: Optional[List[str]] = Field(None, description='Flags is a set of additional options passed to kubectl before submitting a resource I.e. to disable resource validation: flags: [\n\t"--validate=false" # disable resource validation\n]')
manifest
class-attribute
instance-attribute
manifest_from
class-attribute
instance-attribute
manifest_from: Optional[ManifestFrom] = Field(None, alias='manifestFrom', description='ManifestFrom is the source for a single kubernetes manifest')
merge_strategy
class-attribute
instance-attribute
merge_strategy: Optional[str] = Field(None, alias='mergeStrategy', description='MergeStrategy is the strategy used to merge a patch. It defaults to "strategic" Must be one of: strategic, merge, json')
ResubmitArchivedWorkflowRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
RetryAffinity
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
RetryArchivedWorkflowRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
node_field_selector
class-attribute
instance-attribute
restart_successful
class-attribute
instance-attribute
RetryNodeAntiAffinity
RetryStrategy
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
affinity
class-attribute
instance-attribute
affinity: Optional[RetryAffinity] = Field(None, description="Affinity prevents running workflow's step on the same host")
backoff
class-attribute
instance-attribute
expression
class-attribute
instance-attribute
expression: Optional[str] = Field(None, description='Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored')
S3Artifact
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
access_key_secret
class-attribute
instance-attribute
access_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present: Optional[CreateS3BucketOptions] = Field(None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.")
encryption_options
class-attribute
instance-attribute
endpoint
class-attribute
instance-attribute
endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')
insecure
class-attribute
instance-attribute
key
class-attribute
instance-attribute
key: Optional[str] = Field(None, description='Key is the key in the bucket where the artifact resides')
region
class-attribute
instance-attribute
role_arn
class-attribute
instance-attribute
role_arn: Optional[str] = Field(None, alias='roleARN', description='RoleARN is the Amazon Resource Name (ARN) of the role to assume.')
S3ArtifactRepository
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
access_key_secret
class-attribute
instance-attribute
access_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='accessKeySecret', description="AccessKeySecret is the secret selector to the bucket's access key")
bucket
class-attribute
instance-attribute
create_bucket_if_not_present
class-attribute
instance-attribute
create_bucket_if_not_present: Optional[CreateS3BucketOptions] = Field(None, alias='createBucketIfNotPresent', description="CreateBucketIfNotPresent tells the driver to attempt to create the S3 bucket for output artifacts, if it doesn't exist. Setting Enabled Encryption will apply either SSE-S3 to the bucket if KmsKeyId is not set or SSE-KMS if it is.")
encryption_options
class-attribute
instance-attribute
endpoint
class-attribute
instance-attribute
endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')
insecure
class-attribute
instance-attribute
key_format
class-attribute
instance-attribute
key_format: Optional[str] = Field(None, alias='keyFormat', description='KeyFormat is defines the format of how to store keys. Can reference workflow variables')
key_prefix
class-attribute
instance-attribute
key_prefix: Optional[str] = Field(None, alias='keyPrefix', description='KeyPrefix is prefix used as part of the bucket key in which the controller will store artifacts. DEPRECATED. Use KeyFormat instead')
region
class-attribute
instance-attribute
role_arn
class-attribute
instance-attribute
role_arn: Optional[str] = Field(None, alias='roleARN', description='RoleARN is the Amazon Resource Name (ARN) of the role to assume.')
S3EncryptionOptions
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
enable_encryption
class-attribute
instance-attribute
enable_encryption: Optional[bool] = Field(None, alias='enableEncryption', description='EnableEncryption tells the driver to encrypt objects if set to true. If kmsKeyId and serverSideCustomerKeySecret are not set, SSE-S3 will be used')
kms_encryption_context
class-attribute
instance-attribute
kms_encryption_context: Optional[str] = Field(None, alias='kmsEncryptionContext', description='KmsEncryptionContext is a json blob that contains an encryption context. See https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context for more information')
kms_key_id
class-attribute
instance-attribute
kms_key_id: Optional[str] = Field(None, alias='kmsKeyId', description='KMSKeyId tells the driver to encrypt the object using the specified KMS Key.')
server_side_customer_key_secret
class-attribute
instance-attribute
server_side_customer_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='serverSideCustomerKeySecret', description='ServerSideCustomerKeySecret tells the driver to encrypt the output artifacts using SSE-C with the specified secret.')
ScriptTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 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 1884 1885 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 1940 1941 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 |
|
args
class-attribute
instance-attribute
args: Optional[List[str]] = Field(None, description='Arguments to the entrypoint. The container image\'s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
command
class-attribute
instance-attribute
command: Optional[List[str]] = Field(None, description='Entrypoint array. Not executed within a shell. The container image\'s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
env
class-attribute
instance-attribute
env: Optional[List[v1.EnvVar]] = Field(None, description='List of environment variables to set in the container. Cannot be updated.')
env_from
class-attribute
instance-attribute
env_from: Optional[List[v1.EnvFromSource]] = Field(None, alias='envFrom', description='List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.')
image
class-attribute
instance-attribute
image: str = Field(Ellipsis, description='Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.')
image_pull_policy
class-attribute
instance-attribute
image_pull_policy: Optional[str] = Field(None, alias='imagePullPolicy', description='Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images')
lifecycle
class-attribute
instance-attribute
lifecycle: Optional[v1.Lifecycle] = Field(None, description='Actions that the management system should take in response to container lifecycle events. Cannot be updated.')
liveness_probe
class-attribute
instance-attribute
liveness_probe: Optional[v1.Probe] = Field(None, alias='livenessProbe', description='Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
name
class-attribute
instance-attribute
name: Optional[str] = Field(None, description='Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.')
ports
class-attribute
instance-attribute
ports: Optional[List[v1.ContainerPort]] = Field(None, description='List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.')
readiness_probe
class-attribute
instance-attribute
readiness_probe: Optional[v1.Probe] = Field(None, alias='readinessProbe', description='Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
resources
class-attribute
instance-attribute
resources: Optional[v1.ResourceRequirements] = Field(None, description='Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/')
security_context
class-attribute
instance-attribute
security_context: Optional[v1.SecurityContext] = Field(None, alias='securityContext', description='SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/')
source
class-attribute
instance-attribute
source: str = Field(Ellipsis, description='Source contains the source code of the script to execute')
startup_probe
class-attribute
instance-attribute
startup_probe: Optional[v1.Probe] = Field(None, alias='startupProbe', description="StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes")
stdin
class-attribute
instance-attribute
stdin: Optional[bool] = Field(None, description='Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.')
stdin_once
class-attribute
instance-attribute
stdin_once: Optional[bool] = Field(None, alias='stdinOnce', description='Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false')
termination_message_path
class-attribute
instance-attribute
termination_message_path: Optional[str] = Field(None, alias='terminationMessagePath', description="Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.")
termination_message_policy
class-attribute
instance-attribute
termination_message_policy: Optional[str] = Field(None, alias='terminationMessagePolicy', description='Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.')
tty
class-attribute
instance-attribute
tty: Optional[bool] = Field(None, description="Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.")
volume_devices
class-attribute
instance-attribute
volume_devices: Optional[List[v1.VolumeDevice]] = Field(None, alias='volumeDevices', description='volumeDevices is the list of block devices to be used by the container.')
SemaphoreHolding
SemaphoreRef
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
SemaphoreStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Sequence
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
count
class-attribute
instance-attribute
count: Optional[intstr.IntOrString] = Field(None, description='Count is number of elements in the sequence (default: 0). Not to be used with end')
end
class-attribute
instance-attribute
end: Optional[intstr.IntOrString] = Field(None, description='Number at which to end the sequence (default: 0). Not to be used with Count')
Submit
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
arguments
class-attribute
instance-attribute
arguments: Optional[Arguments] = Field(None, description='Arguments extracted from the event and then set as arguments to the workflow created.')
SubmitOpts
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
annotations
class-attribute
instance-attribute
dry_run
class-attribute
instance-attribute
dry_run: Optional[bool] = Field(None, alias='dryRun', description='DryRun validates the workflow on the client-side without creating it. This option is not supported in API')
entry_point
class-attribute
instance-attribute
entry_point: Optional[str] = Field(None, alias='entryPoint', description='Entrypoint overrides spec.entrypoint')
generate_name
class-attribute
instance-attribute
generate_name: Optional[str] = Field(None, alias='generateName', description='GenerateName overrides metadata.generateName')
labels
class-attribute
instance-attribute
name
class-attribute
instance-attribute
owner_reference
class-attribute
instance-attribute
owner_reference: Optional[v1_1.OwnerReference] = Field(None, alias='ownerReference', description='OwnerReference creates a metadata.ownerReference')
parameters
class-attribute
instance-attribute
parameters: Optional[List[str]] = Field(None, description='Parameters passes input parameters to workflow')
pod_priority_class_name
class-attribute
instance-attribute
pod_priority_class_name: Optional[str] = Field(None, alias='podPriorityClassName', description='Set the podPriorityClassName of the workflow')
priority
class-attribute
instance-attribute
priority: Optional[int] = Field(None, description='Priority is used if controller is configured to process limited number of workflows in parallel, higher priority workflows are processed first.')
SuppliedValueFrom
SuspendTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Synchronization
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
SynchronizationStatus
TTLStrategy
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
seconds_after_completion
class-attribute
instance-attribute
seconds_after_completion: Optional[int] = Field(None, alias='secondsAfterCompletion', description='SecondsAfterCompletion is the number of seconds to live after completion')
TarStrategy
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Template
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
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 2717 2718 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 2804 2805 2806 |
|
active_deadline_seconds
class-attribute
instance-attribute
active_deadline_seconds: Optional[intstr.IntOrString] = Field(None, alias='activeDeadlineSeconds', description='Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.')
affinity
class-attribute
instance-attribute
affinity: Optional[v1.Affinity] = Field(None, description="Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)")
archive_location
class-attribute
instance-attribute
archive_location: Optional[ArtifactLocation] = Field(None, alias='archiveLocation', description='Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the <workflowname>/<nodename> in the key.')
automount_service_account_token
class-attribute
instance-attribute
automount_service_account_token: Optional[bool] = Field(None, alias='automountServiceAccountToken', description='AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.')
container
class-attribute
instance-attribute
container: Optional[v1.Container] = Field(None, description='Container is the main container image to run in the pod')
container_set
class-attribute
instance-attribute
container_set: Optional[ContainerSetTemplate] = Field(None, alias='containerSet', description='ContainerSet groups multiple containers within a single pod.')
daemon
class-attribute
instance-attribute
daemon: Optional[bool] = Field(None, description='Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness')
dag
class-attribute
instance-attribute
data
class-attribute
instance-attribute
executor
class-attribute
instance-attribute
executor: Optional[ExecutorConfig] = Field(None, description='Executor holds configurations of the executor container.')
fail_fast
class-attribute
instance-attribute
fail_fast: Optional[bool] = Field(None, alias='failFast', description='FailFast, if specified, will fail this template if any of its child pods has failed. This is useful for when this template is expanded with `withItems`, etc.')
host_aliases
class-attribute
instance-attribute
host_aliases: Optional[List[v1.HostAlias]] = Field(None, alias='hostAliases', description='HostAliases is an optional list of hosts and IPs that will be injected into the pod spec')
http
class-attribute
instance-attribute
init_containers
class-attribute
instance-attribute
init_containers: Optional[List[UserContainer]] = Field(None, alias='initContainers', description='InitContainers is a list of containers which run before the main container.')
inputs
class-attribute
instance-attribute
inputs: Optional[Inputs] = Field(None, description='Inputs describe what inputs parameters and artifacts are supplied to this template')
memoize
class-attribute
instance-attribute
memoize: Optional[Memoize] = Field(None, description='Memoize allows templates to use outputs generated from already executed templates')
metadata
class-attribute
instance-attribute
metadata: Optional[Metadata] = Field(None, description="Metdata sets the pods's metadata, i.e. annotations and labels")
metrics
class-attribute
instance-attribute
metrics: Optional[Metrics] = Field(None, description='Metrics are a list of metrics emitted from this template')
name
class-attribute
instance-attribute
node_selector
class-attribute
instance-attribute
node_selector: Optional[Dict[str, str]] = Field(None, alias='nodeSelector', description='NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level.')
outputs
class-attribute
instance-attribute
outputs: Optional[Outputs] = Field(None, description='Outputs describe the parameters and artifacts that this template produces')
parallelism
class-attribute
instance-attribute
parallelism: Optional[int] = Field(None, description='Parallelism limits the max total parallel pods that can execute at the same time within the boundaries of this template invocation. If additional steps/dag templates are invoked, the pods created by those templates will not be counted towards this total.')
plugin
class-attribute
instance-attribute
pod_spec_patch
class-attribute
instance-attribute
pod_spec_patch: Optional[str] = Field(None, alias='podSpecPatch', description='PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).')
priority
class-attribute
instance-attribute
priority_class_name
class-attribute
instance-attribute
priority_class_name: Optional[str] = Field(None, alias='priorityClassName', description='PriorityClassName to apply to workflow pods.')
resource
class-attribute
instance-attribute
resource: Optional[ResourceTemplate] = Field(None, description='Resource template subtype which can run k8s resources')
retry_strategy
class-attribute
instance-attribute
retry_strategy: Optional[RetryStrategy] = Field(None, alias='retryStrategy', description='RetryStrategy describes how to retry a template when it fails')
scheduler_name
class-attribute
instance-attribute
scheduler_name: Optional[str] = Field(None, alias='schedulerName', description='If specified, the pod will be dispatched by specified scheduler. Or it will be dispatched by workflow scope scheduler if specified. If neither specified, the pod will be dispatched by default scheduler.')
script
class-attribute
instance-attribute
script: Optional[ScriptTemplate] = Field(None, description='Script runs a portion of code against an interpreter')
security_context
class-attribute
instance-attribute
security_context: Optional[v1.PodSecurityContext] = Field(None, alias='securityContext', description='SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.')
service_account_name
class-attribute
instance-attribute
service_account_name: Optional[str] = Field(None, alias='serviceAccountName', description='ServiceAccountName to apply to workflow pods')
sidecars
class-attribute
instance-attribute
sidecars: Optional[List[UserContainer]] = Field(None, description='Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes')
steps
class-attribute
instance-attribute
steps: Optional[List[ParallelSteps]] = Field(None, description='Steps define a series of sequential/parallel workflow steps')
suspend
class-attribute
instance-attribute
suspend: Optional[SuspendTemplate] = Field(None, description='Suspend template subtype which can suspend a workflow when reaching the step')
synchronization
class-attribute
instance-attribute
synchronization: Optional[Synchronization] = Field(None, description='Synchronization holds synchronization lock configuration for this template')
timeout
class-attribute
instance-attribute
timeout: Optional[str] = Field(None, description="Timeout allows to set the total node execution timeout duration counting from the node's start time. This duration also includes time in which the node spends in Pending state. This duration may not be applied to Step or DAG templates.")
TemplateRef
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
TransformationStep
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
UpdateCronWorkflowRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
cron_workflow
class-attribute
instance-attribute
name
class-attribute
instance-attribute
UserContainer
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
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 2064 2065 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 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 |
|
args
class-attribute
instance-attribute
args: Optional[List[str]] = Field(None, description='Arguments to the entrypoint. The container image\'s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
command
class-attribute
instance-attribute
command: Optional[List[str]] = Field(None, description='Entrypoint array. Not executed within a shell. The container image\'s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container\'s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell')
env
class-attribute
instance-attribute
env: Optional[List[v1.EnvVar]] = Field(None, description='List of environment variables to set in the container. Cannot be updated.')
env_from
class-attribute
instance-attribute
env_from: Optional[List[v1.EnvFromSource]] = Field(None, alias='envFrom', description='List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.')
image
class-attribute
instance-attribute
image: Optional[str] = Field(None, description='Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.')
image_pull_policy
class-attribute
instance-attribute
image_pull_policy: Optional[str] = Field(None, alias='imagePullPolicy', description='Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images')
lifecycle
class-attribute
instance-attribute
lifecycle: Optional[v1.Lifecycle] = Field(None, description='Actions that the management system should take in response to container lifecycle events. Cannot be updated.')
liveness_probe
class-attribute
instance-attribute
liveness_probe: Optional[v1.Probe] = Field(None, alias='livenessProbe', description='Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
mirror_volume_mounts
class-attribute
instance-attribute
mirror_volume_mounts: Optional[bool] = Field(None, alias='mirrorVolumeMounts', description='MirrorVolumeMounts will mount the same volumes specified in the main container to the container (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding')
name
class-attribute
instance-attribute
name: str = Field(Ellipsis, description='Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.')
ports
class-attribute
instance-attribute
ports: Optional[List[v1.ContainerPort]] = Field(None, description='List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.')
readiness_probe
class-attribute
instance-attribute
readiness_probe: Optional[v1.Probe] = Field(None, alias='readinessProbe', description='Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes')
resources
class-attribute
instance-attribute
resources: Optional[v1.ResourceRequirements] = Field(None, description='Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/')
security_context
class-attribute
instance-attribute
security_context: Optional[v1.SecurityContext] = Field(None, alias='securityContext', description='SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/')
startup_probe
class-attribute
instance-attribute
startup_probe: Optional[v1.Probe] = Field(None, alias='startupProbe', description="StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes")
stdin
class-attribute
instance-attribute
stdin: Optional[bool] = Field(None, description='Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.')
stdin_once
class-attribute
instance-attribute
stdin_once: Optional[bool] = Field(None, alias='stdinOnce', description='Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false')
termination_message_path
class-attribute
instance-attribute
termination_message_path: Optional[str] = Field(None, alias='terminationMessagePath', description="Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.")
termination_message_policy
class-attribute
instance-attribute
termination_message_policy: Optional[str] = Field(None, alias='terminationMessagePolicy', description='Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.')
tty
class-attribute
instance-attribute
tty: Optional[bool] = Field(None, description="Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.")
volume_devices
class-attribute
instance-attribute
volume_devices: Optional[List[v1.VolumeDevice]] = Field(None, alias='volumeDevices', description='volumeDevices is the list of block devices to be used by the container.')
ValueFrom
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
config_map_key_ref
class-attribute
instance-attribute
config_map_key_ref: Optional[v1.ConfigMapKeySelector] = Field(None, alias='configMapKeyRef', description='ConfigMapKeyRef is configmap selector for input parameter configuration')
default
class-attribute
instance-attribute
default: Optional[str] = Field(None, description='Default specifies a value to be used if retrieving the value from the specified source fails')
event
class-attribute
instance-attribute
event: Optional[str] = Field(None, description='Selector (https://github.com/antonmedv/expr) that is evaluated against the event to get the value of the parameter. E.g. `payload.message`')
expression
class-attribute
instance-attribute
expression: Optional[str] = Field(None, description='Expression, if defined, is evaluated to specify the value for the parameter')
jq_filter
class-attribute
instance-attribute
jq_filter: Optional[str] = Field(None, alias='jqFilter', description='JQFilter expression against the resource object in resource templates')
json_path
class-attribute
instance-attribute
json_path: Optional[str] = Field(None, alias='jsonPath', description='JSONPath of a resource to retrieve an output parameter value from in resource templates')
parameter
class-attribute
instance-attribute
parameter: Optional[str] = Field(None, description="Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. '{{steps.mystep.outputs.myparam}}')")
Version
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
git_tree_state
class-attribute
instance-attribute
VolumeClaimGC
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
Workflow
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
WorkflowCreateRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowDeleteResponse
WorkflowEventBinding
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
WorkflowEventBindingList
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
WorkflowEventBindingSpec
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowLintRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowList
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
WorkflowMetadata
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowResubmitRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowResumeRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowRetryRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
node_field_selector
class-attribute
instance-attribute
WorkflowSetRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
node_field_selector
class-attribute
instance-attribute
output_parameters
class-attribute
instance-attribute
WorkflowSpec
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
2873 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 2958 2959 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 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 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 |
|
active_deadline_seconds
class-attribute
instance-attribute
active_deadline_seconds: Optional[int] = Field(None, alias='activeDeadlineSeconds', description='Optional duration in seconds relative to the workflow start time which the workflow is allowed to run before the controller terminates the io.argoproj.workflow.v1alpha1. A value of zero is used to terminate a Running workflow')
affinity
class-attribute
instance-attribute
affinity: Optional[v1.Affinity] = Field(None, description='Affinity sets the scheduling constraints for all pods in the io.argoproj.workflow.v1alpha1. Can be overridden by an affinity specified in the template')
archive_logs
class-attribute
instance-attribute
archive_logs: Optional[bool] = Field(None, alias='archiveLogs', description='ArchiveLogs indicates if the container logs should be archived')
arguments
class-attribute
instance-attribute
arguments: Optional[Arguments] = Field(None, description="Arguments contain the parameters and artifacts sent to the workflow entrypoint Parameters are referencable globally using the 'workflow' variable prefix. e.g. {{io.argoproj.workflow.v1alpha1.parameters.myparam}}")
artifact_gc
class-attribute
instance-attribute
artifact_gc: Optional[ArtifactGC] = Field(None, alias='artifactGC', description='ArtifactGC describes the strategy to use when deleting artifacts from completed or deleted workflows (applies to all output Artifacts unless Artifact.ArtifactGC is specified, which overrides this)')
artifact_repository_ref
class-attribute
instance-attribute
artifact_repository_ref: Optional[ArtifactRepositoryRef] = Field(None, alias='artifactRepositoryRef', description='ArtifactRepositoryRef specifies the configMap name and key containing the artifact repository config.')
automount_service_account_token
class-attribute
instance-attribute
automount_service_account_token: Optional[bool] = Field(None, alias='automountServiceAccountToken', description='AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in pods. ServiceAccountName of ExecutorConfig must be specified if this value is false.')
dns_config
class-attribute
instance-attribute
dns_config: Optional[v1.PodDNSConfig] = Field(None, alias='dnsConfig', description='PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.')
dns_policy
class-attribute
instance-attribute
dns_policy: Optional[str] = Field(None, alias='dnsPolicy', description='Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are \'ClusterFirstWithHostNet\', \'ClusterFirst\', \'Default\' or \'None\'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to \'ClusterFirstWithHostNet\'.')
entrypoint
class-attribute
instance-attribute
entrypoint: Optional[str] = Field(None, description='Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1.')
executor
class-attribute
instance-attribute
executor: Optional[ExecutorConfig] = Field(None, description='Executor holds configurations of executor containers of the io.argoproj.workflow.v1alpha1.')
hooks
class-attribute
instance-attribute
hooks: Optional[Dict[str, LifecycleHook]] = Field(None, description='Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step')
host_aliases
class-attribute
instance-attribute
host_network
class-attribute
instance-attribute
host_network: Optional[bool] = Field(None, alias='hostNetwork', description='Host networking requested for this workflow pod. Default to false.')
image_pull_secrets
class-attribute
instance-attribute
image_pull_secrets: Optional[List[v1.LocalObjectReference]] = Field(None, alias='imagePullSecrets', description='ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod')
metrics
class-attribute
instance-attribute
metrics: Optional[Metrics] = Field(None, description='Metrics are a list of metrics emitted from this Workflow')
node_selector
class-attribute
instance-attribute
node_selector: Optional[Dict[str, str]] = Field(None, alias='nodeSelector', description='NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template.')
on_exit
class-attribute
instance-attribute
on_exit: Optional[str] = Field(None, alias='onExit', description='OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary io.argoproj.workflow.v1alpha1.')
parallelism
class-attribute
instance-attribute
parallelism: Optional[int] = Field(None, description='Parallelism limits the max total parallel pods that can execute at the same time in a workflow')
pod_disruption_budget
class-attribute
instance-attribute
pod_disruption_budget: Optional[v1beta1.PodDisruptionBudgetSpec] = Field(None, alias='podDisruptionBudget', description="PodDisruptionBudget holds the number of concurrent disruptions that you allow for Workflow's Pods. Controller will automatically add the selector with workflow name, if selector is empty. Optional: Defaults to empty.")
pod_gc
class-attribute
instance-attribute
pod_gc: Optional[PodGC] = Field(None, alias='podGC', description='PodGC describes the strategy to use when deleting completed pods')
pod_metadata
class-attribute
instance-attribute
pod_metadata: Optional[Metadata] = Field(None, alias='podMetadata', description='PodMetadata defines additional metadata that should be applied to workflow pods')
pod_priority
class-attribute
instance-attribute
pod_priority: Optional[int] = Field(None, alias='podPriority', description='Priority to apply to workflow pods. DEPRECATED: Use PodPriorityClassName instead.')
pod_priority_class_name
class-attribute
instance-attribute
pod_priority_class_name: Optional[str] = Field(None, alias='podPriorityClassName', description='PriorityClassName to apply to workflow pods.')
pod_spec_patch
class-attribute
instance-attribute
pod_spec_patch: Optional[str] = Field(None, alias='podSpecPatch', description='PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).')
priority
class-attribute
instance-attribute
priority: Optional[int] = Field(None, description='Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.')
retry_strategy
class-attribute
instance-attribute
retry_strategy: Optional[RetryStrategy] = Field(None, alias='retryStrategy', description='RetryStrategy for all templates in the io.argoproj.workflow.v1alpha1.')
scheduler_name
class-attribute
instance-attribute
scheduler_name: Optional[str] = Field(None, alias='schedulerName', description="Set scheduler name for all pods. Will be overridden if container/script template's scheduler name is set. Default scheduler will be used if neither specified.")
security_context
class-attribute
instance-attribute
security_context: Optional[v1.PodSecurityContext] = Field(None, alias='securityContext', description='SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.')
service_account_name
class-attribute
instance-attribute
service_account_name: Optional[str] = Field(None, alias='serviceAccountName', description='ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.')
shutdown
class-attribute
instance-attribute
shutdown: Optional[str] = Field(None, description='Shutdown will shutdown the workflow according to its ShutdownStrategy')
suspend
class-attribute
instance-attribute
suspend: Optional[bool] = Field(None, description='Suspend will suspend the workflow and prevent execution of any future steps in the workflow')
synchronization
class-attribute
instance-attribute
synchronization: Optional[Synchronization] = Field(None, description='Synchronization holds synchronization lock configuration for this Workflow')
template_defaults
class-attribute
instance-attribute
template_defaults: Optional[Template] = Field(None, alias='templateDefaults', description='TemplateDefaults holds default template values that will apply to all templates in the Workflow, unless overridden on the template-level')
templates
class-attribute
instance-attribute
templates: Optional[List[Template]] = Field(None, description='Templates is a list of workflow templates used in a workflow')
tolerations
class-attribute
instance-attribute
tolerations: Optional[List[v1.Toleration]] = Field(None, description='Tolerations to apply to workflow pods.')
ttl_strategy
class-attribute
instance-attribute
ttl_strategy: Optional[TTLStrategy] = Field(None, alias='ttlStrategy', description='TTLStrategy limits the lifetime of a Workflow that has finished execution depending on if it Succeeded or Failed. If this struct is set, once the Workflow finishes, it will be deleted after the time to live expires. If this field is unset, the controller config map will hold the default values.')
volume_claim_gc
class-attribute
instance-attribute
volume_claim_gc: Optional[VolumeClaimGC] = Field(None, alias='volumeClaimGC', description='VolumeClaimGC describes the strategy to use when deleting volumes from completed workflows')
volume_claim_templates
class-attribute
instance-attribute
volume_claim_templates: Optional[List[v1.PersistentVolumeClaim]] = Field(None, alias='volumeClaimTemplates', description='VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow')
volumes
class-attribute
instance-attribute
volumes: Optional[List[v1.Volume]] = Field(None, description='Volumes is a list of volumes that can be mounted by containers in a io.argoproj.workflow.v1alpha1.')
WorkflowStatus
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
3116 3117 3118 3119 3120 3121 3122 3123 3124 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 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 |
|
artifact_gc_status
class-attribute
instance-attribute
artifact_gc_status: Optional[ArtGCStatus] = Field(None, alias='artifactGCStatus', description='ArtifactGCStatus maintains the status of Artifact Garbage Collection')
artifact_repository_ref
class-attribute
instance-attribute
artifact_repository_ref: Optional[ArtifactRepositoryRefStatus] = Field(None, alias='artifactRepositoryRef', description='ArtifactRepositoryRef is used to cache the repository to use so we do not need to determine it everytime we reconcile.')
compressed_nodes
class-attribute
instance-attribute
compressed_nodes: Optional[str] = Field(None, alias='compressedNodes', description='Compressed and base64 decoded Nodes map')
conditions
class-attribute
instance-attribute
conditions: Optional[List[Condition]] = Field(None, description='Conditions is a list of conditions the Workflow may have')
estimated_duration
class-attribute
instance-attribute
estimated_duration: Optional[int] = Field(None, alias='estimatedDuration', description='EstimatedDuration in seconds.')
finished_at
class-attribute
instance-attribute
finished_at: Optional[v1_1.Time] = Field(None, alias='finishedAt', description='Time at which this workflow completed')
message
class-attribute
instance-attribute
message: Optional[str] = Field(None, description='A human readable message indicating details about why the workflow is in this condition.')
nodes
class-attribute
instance-attribute
nodes: Optional[Dict[str, NodeStatus]] = Field(None, description="Nodes is a mapping between a node ID and the node's status.")
offload_node_status_version
class-attribute
instance-attribute
offload_node_status_version: Optional[str] = Field(None, alias='offloadNodeStatusVersion', description='Whether on not node status has been offloaded to a database. If exists, then Nodes and CompressedNodes will be empty. This will actually be populated with a hash of the offloaded data.')
outputs
class-attribute
instance-attribute
outputs: Optional[Outputs] = Field(None, description='Outputs captures output values and artifact locations produced by the workflow via global outputs')
persistent_volume_claims
class-attribute
instance-attribute
persistent_volume_claims: Optional[List[v1.Volume]] = Field(None, alias='persistentVolumeClaims', description='PersistentVolumeClaims tracks all PVCs that were created as part of the io.argoproj.workflow.v1alpha1. The contents of this list are drained at the end of the workflow.')
phase
class-attribute
instance-attribute
phase: Optional[str] = Field(None, description='Phase a simple, high-level summary of where the workflow is in its lifecycle.')
progress
class-attribute
instance-attribute
resources_duration
class-attribute
instance-attribute
resources_duration: Optional[Dict[str, int]] = Field(None, alias='resourcesDuration', description='ResourcesDuration is the total for the workflow')
started_at
class-attribute
instance-attribute
started_at: Optional[v1_1.Time] = Field(None, alias='startedAt', description='Time at which this workflow started')
stored_templates
class-attribute
instance-attribute
stored_templates: Optional[Dict[str, Template]] = Field(None, alias='storedTemplates', description="StoredTemplates is a mapping between a template ref and the node's status.")
WorkflowStep
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
arguments
class-attribute
instance-attribute
arguments: Optional[Arguments] = Field(None, description='Arguments hold arguments to the template')
continue_on
class-attribute
instance-attribute
continue_on: Optional[ContinueOn] = Field(None, alias='continueOn', description='ContinueOn makes argo to proceed with the following step even if this step fails. Errors and Failed states can be specified')
hooks
class-attribute
instance-attribute
hooks: Optional[Dict[str, LifecycleHook]] = Field(None, description='Hooks holds the lifecycle hook which is invoked at lifecycle of step, irrespective of the success, failure, or error status of the primary step')
inline
class-attribute
instance-attribute
inline: Optional[Template] = Field(None, description='Inline is the template. Template must be empty if this is declared (and vice-versa).')
name
class-attribute
instance-attribute
on_exit
class-attribute
instance-attribute
on_exit: Optional[str] = Field(None, alias='onExit', description='OnExit is a template reference which is invoked at the end of the template, irrespective of the success, failure, or error of the primary template. DEPRECATED: Use Hooks[exit].Template instead.')
template
class-attribute
instance-attribute
template: Optional[str] = Field(None, description='Template is the name of the template to execute as the step')
template_ref
class-attribute
instance-attribute
template_ref: Optional[TemplateRef] = Field(None, alias='templateRef', description='TemplateRef is the reference to the template resource to execute as the step.')
when
class-attribute
instance-attribute
when: Optional[str] = Field(None, description='When is an expression in which the step should conditionally execute')
with_items
class-attribute
instance-attribute
with_items: Optional[List[Item]] = Field(None, alias='withItems', description='WithItems expands a step into multiple parallel steps from the items in the list')
WorkflowStopRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowSubmitRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
resource_kind
class-attribute
instance-attribute
resource_name
class-attribute
instance-attribute
WorkflowSuspendRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowTaskSetSpec
WorkflowTaskSetStatus
WorkflowTemplate
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')
WorkflowTemplateCreateRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowTemplateDeleteResponse
WorkflowTemplateLintRequest
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
WorkflowTemplateList
Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py
api_version
class-attribute
instance-attribute
api_version: Optional[str] = Field(None, alias='apiVersion', description='APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#resources')
kind
class-attribute
instance-attribute
kind: Optional[str] = Field(None, description='Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.io.k8s.community/contributors/devel/sig-architecture/api-conventions.md#types-kinds')