Hera Workflows Auto-generated Models

hera.workflows.models

Amount

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Amount(BaseModel):
    __root__: float = Field(..., description="Amount represent a numeric amount.")

ArchiveStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArchiveStrategy(BaseModel):
    none: Optional[NoneStrategy] = None
    tar: Optional[TarStrategy] = None
    zip: Optional[ZipStrategy] = None

none class-attribute instance-attribute

none: Optional[NoneStrategy] = None

tar class-attribute instance-attribute

tar: Optional[TarStrategy] = None

zip class-attribute instance-attribute

zip: Optional[ZipStrategy] = None

ArchivedWorkflowDeletedResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArchivedWorkflowDeletedResponse(BaseModel):
    pass

Arguments

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Arguments(BaseModel):
    artifacts: Optional[List[Artifact]] = Field(
        None, description="Artifacts is the list of artifacts to pass to the template or workflow"
    )
    parameters: Optional[List[Parameter]] = Field(
        None, description="Parameters is the list of parameters to pass to the template or workflow"
    )

artifacts class-attribute instance-attribute

artifacts: Optional[List[Artifact]] = Field(None, description='Artifacts is the list of artifacts to pass to the template or workflow')

parameters class-attribute instance-attribute

parameters: Optional[List[Parameter]] = Field(None, description='Parameters is the list of parameters to pass to the template or workflow')

ArtGCStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtGCStatus(BaseModel):
    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",
    )
    pods_recouped: Optional[Dict[str, bool]] = Field(
        None,
        alias="podsRecouped",
        description=(
            "have completed Pods been processed? (mapped by Pod name) used to prevent re-processing the Status of a"
            " Pod more than once"
        ),
    )
    strategies_processed: Optional[Dict[str, bool]] = Field(
        None,
        alias="strategiesProcessed",
        description=(
            "have Pods been started to perform this strategy? (enables us not to re-process what we've already done)"
        ),
    )

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")

pods_recouped class-attribute instance-attribute

pods_recouped: Optional[Dict[str, bool]] = Field(None, alias='podsRecouped', description='have completed Pods been processed? (mapped by Pod name) used to prevent re-processing the Status of a Pod more than once')

strategies_processed class-attribute instance-attribute

strategies_processed: Optional[Dict[str, bool]] = Field(None, alias='strategiesProcessed', description="have Pods been started to perform this strategy? (enables us not to re-process what we've already done)")

Artifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Artifact(BaseModel):
    archive: Optional[ArchiveStrategy] = Field(
        None, description="Archive controls how the artifact will be saved to the artifact repository."
    )
    archive_logs: Optional[bool] = Field(
        None, alias="archiveLogs", description="ArchiveLogs indicates if the container logs should be archived"
    )
    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: Optional[ArtifactoryArtifact] = Field(
        None, description="Artifactory contains artifactory artifact location details"
    )
    azure: Optional[AzureArtifact] = Field(None, description="Azure contains Azure Storage artifact location details")
    deleted: Optional[bool] = Field(None, description="Has this been deleted?")
    from_: Optional[str] = Field(
        None, alias="from", description="From allows an artifact to reference an artifact from a previous step"
    )
    from_expression: Optional[str] = Field(
        None,
        alias="fromExpression",
        description="FromExpression, if defined, is evaluated to specify the value for the artifact",
    )
    gcs: Optional[GCSArtifact] = Field(None, description="GCS contains GCS artifact location details")
    git: Optional[GitArtifact] = Field(None, description="Git contains git artifact location details")
    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: Optional[HDFSArtifact] = Field(None, description="HDFS contains HDFS artifact location details")
    http: Optional[HTTPArtifact] = Field(None, description="HTTP contains HTTP artifact location details")
    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: str = Field(..., description="name of the artifact. must be unique within a template's inputs/outputs.")
    optional: Optional[bool] = Field(
        None, description="Make Artifacts optional, if Artifacts doesn't generate or exist"
    )
    oss: Optional[OSSArtifact] = Field(None, description="OSS contains OSS artifact location details")
    path: Optional[str] = Field(None, description="Path is the container path to the artifact")
    raw: Optional[RawArtifact] = Field(None, description="Raw contains raw artifact location details")
    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: Optional[S3Artifact] = Field(None, description="S3 contains S3 artifact location details")
    sub_path: Optional[str] = Field(
        None,
        alias="subPath",
        description="SubPath allows an artifact to be sourced from a subpath within the specified source",
    )

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

deleted: Optional[bool] = Field(None, description='Has this been deleted?')

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

gcs: Optional[GCSArtifact] = Field(None, description='GCS contains GCS artifact location details')

git class-attribute instance-attribute

git: Optional[GitArtifact] = Field(None, description='Git contains git artifact location details')

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

oss: Optional[OSSArtifact] = Field(None, description='OSS contains OSS artifact location details')

path class-attribute instance-attribute

path: Optional[str] = Field(None, description='Path is the container path to the artifact')

raw class-attribute instance-attribute

raw: Optional[RawArtifact] = Field(None, description='Raw contains raw artifact location details')

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

s3: Optional[S3Artifact] = Field(None, description='S3 contains S3 artifact location details')

sub_path class-attribute instance-attribute

sub_path: Optional[str] = Field(None, alias='subPath', description='SubPath allows an artifact to be sourced from a subpath within the specified source')

ArtifactGC

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactGC(BaseModel):
    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"
        ),
    )
    service_account_name: Optional[str] = Field(
        None,
        alias="serviceAccountName",
        description=(
            "ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the"
            " Pod doing the deletion"
        ),
    )
    strategy: Optional[str] = Field(None, description="Strategy is the strategy to use.")

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')

service_account_name class-attribute instance-attribute

service_account_name: Optional[str] = Field(None, alias='serviceAccountName', description='ServiceAccountName is an optional field for specifying the Service Account that should be assigned to the Pod doing the deletion')

strategy class-attribute instance-attribute

strategy: Optional[str] = Field(None, description='Strategy is the strategy to use.')

ArtifactGCSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactGCSpec(BaseModel):
    artifacts_by_node: Optional[Dict[str, ArtifactNodeSpec]] = Field(
        None,
        alias="artifactsByNode",
        description="ArtifactsByNode maps Node name to information pertaining to Artifacts on that Node",
    )

artifacts_by_node class-attribute instance-attribute

artifacts_by_node: Optional[Dict[str, ArtifactNodeSpec]] = Field(None, alias='artifactsByNode', description='ArtifactsByNode maps Node name to information pertaining to Artifacts on that Node')

ArtifactGCStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactGCStatus(BaseModel):
    artifact_results_by_node: Optional[Dict[str, ArtifactResultNodeStatus]] = Field(
        None, alias="artifactResultsByNode", description="ArtifactResultsByNode maps Node name to result"
    )

artifact_results_by_node class-attribute instance-attribute

artifact_results_by_node: Optional[Dict[str, ArtifactResultNodeStatus]] = Field(None, alias='artifactResultsByNode', description='ArtifactResultsByNode maps Node name to result')

ArtifactLocation

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactLocation(BaseModel):
    archive_logs: Optional[bool] = Field(
        None, alias="archiveLogs", description="ArchiveLogs indicates if the container logs should be archived"
    )
    artifactory: Optional[ArtifactoryArtifact] = Field(
        None, description="Artifactory contains artifactory artifact location details"
    )
    azure: Optional[AzureArtifact] = Field(None, description="Azure contains Azure Storage artifact location details")
    gcs: Optional[GCSArtifact] = Field(None, description="GCS contains GCS artifact location details")
    git: Optional[GitArtifact] = Field(None, description="Git contains git artifact location details")
    hdfs: Optional[HDFSArtifact] = Field(None, description="HDFS contains HDFS artifact location details")
    http: Optional[HTTPArtifact] = Field(None, description="HTTP contains HTTP artifact location details")
    oss: Optional[OSSArtifact] = Field(None, description="OSS contains OSS artifact location details")
    raw: Optional[RawArtifact] = Field(None, description="Raw contains raw artifact location details")
    s3: Optional[S3Artifact] = Field(None, description="S3 contains S3 artifact location details")

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

gcs: Optional[GCSArtifact] = Field(None, description='GCS contains GCS artifact location details')

git class-attribute instance-attribute

git: Optional[GitArtifact] = Field(None, description='Git contains git artifact location details')

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

oss: Optional[OSSArtifact] = Field(None, description='OSS contains OSS artifact location details')

raw class-attribute instance-attribute

raw: Optional[RawArtifact] = Field(None, description='Raw contains raw artifact location details')

s3 class-attribute instance-attribute

s3: Optional[S3Artifact] = Field(None, description='S3 contains S3 artifact location details')

ArtifactNodeSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactNodeSpec(BaseModel):
    archive_location: Optional[ArtifactLocation] = Field(
        None,
        alias="archiveLocation",
        description="ArchiveLocation is the template-level Artifact location specification",
    )
    artifacts: Optional[Dict[str, Artifact]] = Field(
        None, description="Artifacts maps artifact name to Artifact description"
    )

archive_location class-attribute instance-attribute

archive_location: Optional[ArtifactLocation] = Field(None, alias='archiveLocation', description='ArchiveLocation is the template-level Artifact location specification')

artifacts class-attribute instance-attribute

artifacts: Optional[Dict[str, Artifact]] = Field(None, description='Artifacts maps artifact name to Artifact description')

ArtifactPaths

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactPaths(BaseModel):
    archive: Optional[ArchiveStrategy] = Field(
        None, description="Archive controls how the artifact will be saved to the artifact repository."
    )
    archive_logs: Optional[bool] = Field(
        None, alias="archiveLogs", description="ArchiveLogs indicates if the container logs should be archived"
    )
    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: Optional[ArtifactoryArtifact] = Field(
        None, description="Artifactory contains artifactory artifact location details"
    )
    azure: Optional[AzureArtifact] = Field(None, description="Azure contains Azure Storage artifact location details")
    deleted: Optional[bool] = Field(None, description="Has this been deleted?")
    from_: Optional[str] = Field(
        None, alias="from", description="From allows an artifact to reference an artifact from a previous step"
    )
    from_expression: Optional[str] = Field(
        None,
        alias="fromExpression",
        description="FromExpression, if defined, is evaluated to specify the value for the artifact",
    )
    gcs: Optional[GCSArtifact] = Field(None, description="GCS contains GCS artifact location details")
    git: Optional[GitArtifact] = Field(None, description="Git contains git artifact location details")
    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: Optional[HDFSArtifact] = Field(None, description="HDFS contains HDFS artifact location details")
    http: Optional[HTTPArtifact] = Field(None, description="HTTP contains HTTP artifact location details")
    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: str = Field(..., description="name of the artifact. must be unique within a template's inputs/outputs.")
    optional: Optional[bool] = Field(
        None, description="Make Artifacts optional, if Artifacts doesn't generate or exist"
    )
    oss: Optional[OSSArtifact] = Field(None, description="OSS contains OSS artifact location details")
    path: Optional[str] = Field(None, description="Path is the container path to the artifact")
    raw: Optional[RawArtifact] = Field(None, description="Raw contains raw artifact location details")
    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: Optional[S3Artifact] = Field(None, description="S3 contains S3 artifact location details")
    sub_path: Optional[str] = Field(
        None,
        alias="subPath",
        description="SubPath allows an artifact to be sourced from a subpath within the specified source",
    )

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

deleted: Optional[bool] = Field(None, description='Has this been deleted?')

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

gcs: Optional[GCSArtifact] = Field(None, description='GCS contains GCS artifact location details')

git class-attribute instance-attribute

git: Optional[GitArtifact] = Field(None, description='Git contains git artifact location details')

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

oss: Optional[OSSArtifact] = Field(None, description='OSS contains OSS artifact location details')

path class-attribute instance-attribute

path: Optional[str] = Field(None, description='Path is the container path to the artifact')

raw class-attribute instance-attribute

raw: Optional[RawArtifact] = Field(None, description='Raw contains raw artifact location details')

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

s3: Optional[S3Artifact] = Field(None, description='S3 contains S3 artifact location details')

sub_path class-attribute instance-attribute

sub_path: Optional[str] = Field(None, alias='subPath', description='SubPath allows an artifact to be sourced from a subpath within the specified source')

ArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactRepository(BaseModel):
    archive_logs: Optional[bool] = Field(None, alias="archiveLogs", description="ArchiveLogs enables log archiving")
    artifactory: Optional[ArtifactoryArtifactRepository] = Field(
        None, description="Artifactory stores artifacts to JFrog Artifactory"
    )
    azure: Optional[AzureArtifactRepository] = Field(
        None, description="Azure stores artifact in an Azure Storage account"
    )
    gcs: Optional[GCSArtifactRepository] = Field(None, description="GCS stores artifact in a GCS object store")
    hdfs: Optional[HDFSArtifactRepository] = Field(None, description="HDFS stores artifacts in HDFS")
    oss: Optional[OSSArtifactRepository] = Field(
        None, description="OSS stores artifact in a OSS-compliant object store"
    )
    s3: Optional[S3ArtifactRepository] = Field(None, description="S3 stores artifact in a S3-compliant object store")

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

hdfs: Optional[HDFSArtifactRepository] = Field(None, description='HDFS stores artifacts in HDFS')

oss class-attribute instance-attribute

oss: Optional[OSSArtifactRepository] = Field(None, description='OSS stores artifact in a OSS-compliant object store')

s3 class-attribute instance-attribute

s3: Optional[S3ArtifactRepository] = Field(None, description='S3 stores artifact in a S3-compliant object store')

ArtifactRepositoryRef

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactRepositoryRef(BaseModel):
    config_map: Optional[str] = Field(
        None, alias="configMap", description='The name of the config map. Defaults to "artifact-repositories".'
    )
    key: Optional[str] = Field(
        None,
        description=(
            'The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository"'
            " annotation."
        ),
    )

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".')

key class-attribute instance-attribute

key: Optional[str] = Field(None, description='The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.')

ArtifactRepositoryRefStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactRepositoryRefStatus(BaseModel):
    artifact_repository: Optional[ArtifactRepository] = Field(
        None,
        alias="artifactRepository",
        description="The repository the workflow will use. This maybe empty before v3.1.",
    )
    config_map: Optional[str] = Field(
        None, alias="configMap", description='The name of the config map. Defaults to "artifact-repositories".'
    )
    default: Optional[bool] = Field(
        None, description="If this ref represents the default artifact repository, rather than a config map."
    )
    key: Optional[str] = Field(
        None,
        description=(
            'The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository"'
            " annotation."
        ),
    )
    namespace: Optional[str] = Field(
        None,
        description=(
            "The namespace of the config map. Defaults to the workflow's namespace, or the controller's namespace (if"
            " found)."
        ),
    )

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.')

key class-attribute instance-attribute

key: Optional[str] = Field(None, description='The config map key. Defaults to the value of the "workflows.argoproj.io/default-artifact-repository" annotation.')

namespace class-attribute instance-attribute

namespace: Optional[str] = Field(None, description="The namespace of the config map. Defaults to the workflow's namespace, or the controller's namespace (if found).")

ArtifactResult

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactResult(BaseModel):
    error: Optional[str] = Field(
        None, description="Error is an optional error message which should be set if Success==false"
    )
    name: str = Field(..., description="Name is the name of the Artifact")
    success: Optional[bool] = Field(None, description="Success describes whether the deletion succeeded")

error class-attribute instance-attribute

error: Optional[str] = Field(None, description='Error is an optional error message which should be set if Success==false')

name class-attribute instance-attribute

name: str = Field(Ellipsis, description='Name is the name of the Artifact')

success class-attribute instance-attribute

success: Optional[bool] = Field(None, description='Success describes whether the deletion succeeded')

ArtifactResultNodeStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactResultNodeStatus(BaseModel):
    artifact_results: Optional[Dict[str, ArtifactResult]] = Field(
        None, alias="artifactResults", description="ArtifactResults maps Artifact name to result of the deletion"
    )

artifact_results class-attribute instance-attribute

artifact_results: Optional[Dict[str, ArtifactResult]] = Field(None, alias='artifactResults', description='ArtifactResults maps Artifact name to result of the deletion')

ArtifactoryArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactoryArtifact(BaseModel):
    password_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="passwordSecret", description="PasswordSecret is the secret selector to the repository password"
    )
    url: str = Field(..., description="URL of the artifact")
    username_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="usernameSecret", description="UsernameSecret is the secret selector to the repository username"
    )

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')

url class-attribute instance-attribute

url: str = Field(Ellipsis, description='URL of the artifact')

username_secret class-attribute instance-attribute

username_secret: Optional[v1.SecretKeySelector] = Field(None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')

ArtifactoryArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ArtifactoryArtifactRepository(BaseModel):
    password_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="passwordSecret", description="PasswordSecret is the secret selector to the repository password"
    )
    repo_url: Optional[str] = Field(None, alias="repoURL", description="RepoURL is the url for artifactory repo.")
    username_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="usernameSecret", description="UsernameSecret is the secret selector to the repository username"
    )

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_url class-attribute instance-attribute

repo_url: Optional[str] = Field(None, alias='repoURL', description='RepoURL is the url for artifactory repo.')

username_secret class-attribute instance-attribute

username_secret: Optional[v1.SecretKeySelector] = Field(None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')

AzureArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class AzureArtifact(BaseModel):
    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: str = Field(
        ..., description="Blob is the blob name (i.e., path) in the container where the artifact resides"
    )
    container: str = Field(..., description="Container is the container where resources will be stored")
    endpoint: str = Field(
        ...,
        description=(
            "Endpoint is the service url associated with an account. It is most likely"
            ' "https://<ACCOUNT_NAME>.blob.core.windows.net"'
        ),
    )
    use_sdk_creds: Optional[bool] = Field(
        None,
        alias="useSDKCreds",
        description="UseSDKCreds tells the driver to figure out credentials based on sdk defaults.",
    )

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')

endpoint class-attribute instance-attribute

endpoint: str = Field(Ellipsis, description='Endpoint is the service url associated with an account. It is most likely "https://<ACCOUNT_NAME>.blob.core.windows.net"')

use_sdk_creds class-attribute instance-attribute

use_sdk_creds: Optional[bool] = Field(None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')

AzureArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class AzureArtifactRepository(BaseModel):
    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: Optional[str] = Field(
        None,
        alias="blobNameFormat",
        description=(
            "BlobNameFormat is defines the format of how to store blob names. Can reference workflow variables"
        ),
    )
    container: str = Field(..., description="Container is the container where resources will be stored")
    endpoint: str = Field(
        ...,
        description=(
            "Endpoint is the service url associated with an account. It is most likely"
            ' "https://<ACCOUNT_NAME>.blob.core.windows.net"'
        ),
    )
    use_sdk_creds: Optional[bool] = Field(
        None,
        alias="useSDKCreds",
        description="UseSDKCreds tells the driver to figure out credentials based on sdk defaults.",
    )

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')

endpoint class-attribute instance-attribute

endpoint: str = Field(Ellipsis, description='Endpoint is the service url associated with an account. It is most likely "https://<ACCOUNT_NAME>.blob.core.windows.net"')

use_sdk_creds class-attribute instance-attribute

use_sdk_creds: Optional[bool] = Field(None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')

Backoff

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Backoff(BaseModel):
    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")'
        ),
    )
    factor: Optional[intstr.IntOrString] = Field(
        None, description="Factor is a factor to multiply the base duration after each failed retry"
    )
    max_duration: Optional[str] = Field(
        None,
        alias="maxDuration",
        description="MaxDuration is the maximum amount of time allowed for the backoff strategy",
    )

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")')

factor class-attribute instance-attribute

factor: Optional[intstr.IntOrString] = Field(None, description='Factor is a factor to multiply the base duration after each failed retry')

max_duration class-attribute instance-attribute

max_duration: Optional[str] = Field(None, alias='maxDuration', description='MaxDuration is the maximum amount of time allowed for the backoff strategy')

BasicAuth

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class BasicAuth(BaseModel):
    password_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="passwordSecret", description="PasswordSecret is the secret selector to the repository password"
    )
    username_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="usernameSecret", description="UsernameSecret is the secret selector to the repository username"
    )

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')

username_secret class-attribute instance-attribute

username_secret: Optional[v1.SecretKeySelector] = Field(None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')

Cache

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Cache(BaseModel):
    config_map: v1.ConfigMapKeySelector = Field(
        ..., alias="configMap", description="ConfigMap sets a ConfigMap-based cache"
    )

config_map class-attribute instance-attribute

config_map: v1.ConfigMapKeySelector = Field(Ellipsis, alias='configMap', description='ConfigMap sets a ConfigMap-based cache')

ClientCertAuth

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClientCertAuth(BaseModel):
    client_cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias="clientCertSecret")
    client_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias="clientKeySecret")

client_cert_secret class-attribute instance-attribute

client_cert_secret: Optional[v1.SecretKeySelector] = Field(None, alias='clientCertSecret')

client_key_secret class-attribute instance-attribute

client_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='clientKeySecret')

ClusterWorkflowTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplate(BaseModel):
    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: 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"
        ),
    )
    metadata: v1_1.ObjectMeta
    spec: WorkflowSpec

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')

metadata instance-attribute

metadata: v1_1.ObjectMeta

spec instance-attribute

spec: WorkflowSpec

ClusterWorkflowTemplateCreateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplateCreateRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    template: Optional[ClusterWorkflowTemplate] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

template class-attribute instance-attribute

template: Optional[ClusterWorkflowTemplate] = None

ClusterWorkflowTemplateDeleteResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplateDeleteResponse(BaseModel):
    pass

ClusterWorkflowTemplateLintRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplateLintRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    template: Optional[ClusterWorkflowTemplate] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

template class-attribute instance-attribute

template: Optional[ClusterWorkflowTemplate] = None

ClusterWorkflowTemplateList

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplateList(BaseModel):
    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"
        ),
    )
    items: List[ClusterWorkflowTemplate]
    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"
        ),
    )
    metadata: v1_1.ListMeta

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')

items instance-attribute

items: List[ClusterWorkflowTemplate]

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')

metadata instance-attribute

metadata: v1_1.ListMeta

ClusterWorkflowTemplateUpdateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ClusterWorkflowTemplateUpdateRequest(BaseModel):
    name: Optional[str] = Field(None, description="DEPRECATED: This field is ignored.")
    template: Optional[ClusterWorkflowTemplate] = None

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='DEPRECATED: This field is ignored.')

template class-attribute instance-attribute

template: Optional[ClusterWorkflowTemplate] = None

CollectEventRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CollectEventRequest(BaseModel):
    name: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

CollectEventResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CollectEventResponse(BaseModel):
    pass

Condition

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Condition(BaseModel):
    message: Optional[str] = Field(None, description="Message is the condition message")
    status: Optional[str] = Field(None, description="Status is the status of the condition")
    type: Optional[str] = Field(None, description="Type is the type of condition")

message class-attribute instance-attribute

message: Optional[str] = Field(None, description='Message is the condition message')

status class-attribute instance-attribute

status: Optional[str] = Field(None, description='Status is the status of the condition')

type class-attribute instance-attribute

type: Optional[str] = Field(None, description='Type is the type of condition')

ContainerNode

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ContainerNode(BaseModel):
    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: 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"
        ),
    )
    dependencies: Optional[List[str]] = None
    env: Optional[List[v1.EnvVar]] = Field(
        None, description="List of environment variables to set in the container. Cannot be updated."
    )
    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: 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: 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: Optional[v1.Lifecycle] = Field(
        None,
        description=(
            "Actions that the management system should take in response to container lifecycle events. Cannot be"
            " updated."
        ),
    )
    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: str = Field(
        ...,
        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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: Optional[List[v1.VolumeDevice]] = Field(
        None,
        alias="volumeDevices",
        description="volumeDevices is the list of block devices to be used by the container.",
    )
    volume_mounts: Optional[List[v1.VolumeMount]] = Field(
        None,
        alias="volumeMounts",
        description="Pod volumes to mount into the container's filesystem. Cannot be updated.",
    )
    working_dir: Optional[str] = Field(
        None,
        alias="workingDir",
        description=(
            "Container's working directory. If not specified, the container runtime's default will be used, which"
            " might be configured in the container image. Cannot be updated."
        ),
    )

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')

dependencies class-attribute instance-attribute

dependencies: Optional[List[str]] = None

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.')

volume_mounts class-attribute instance-attribute

volume_mounts: Optional[List[v1.VolumeMount]] = Field(None, alias='volumeMounts', description="Pod volumes to mount into the container's filesystem. Cannot be updated.")

working_dir class-attribute instance-attribute

working_dir: Optional[str] = Field(None, alias='workingDir', description="Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.")

ContainerSetRetryStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ContainerSetRetryStrategy(BaseModel):
    duration: Optional[str] = Field(
        None,
        description=(
            'Duration is the time between each retry, examples values are "300ms", "1s" or "5m". Valid time units are'
            ' "ns", "us" (or "µs"), "ms", "s", "m", "h".'
        ),
    )
    retries: intstr.IntOrString = Field(..., description="Nbr of retries")

duration class-attribute instance-attribute

duration: Optional[str] = Field(None, description='Duration is the time between each retry, examples values are "300ms", "1s" or "5m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".')

retries class-attribute instance-attribute

retries: intstr.IntOrString = Field(Ellipsis, description='Nbr of retries')

ContainerSetTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ContainerSetTemplate(BaseModel):
    containers: List[ContainerNode]
    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."
        ),
    )
    volume_mounts: Optional[List[v1.VolumeMount]] = Field(None, alias="volumeMounts")

containers instance-attribute

containers: List[ContainerNode]

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.')

volume_mounts class-attribute instance-attribute

volume_mounts: Optional[List[v1.VolumeMount]] = Field(None, alias='volumeMounts')

ContinueOn

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ContinueOn(BaseModel):
    error: Optional[bool] = None
    failed: Optional[bool] = None

error class-attribute instance-attribute

error: Optional[bool] = None

failed class-attribute instance-attribute

failed: Optional[bool] = None

Counter

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Counter(BaseModel):
    value: str = Field(..., description="Value is the value of the metric")

value class-attribute instance-attribute

value: str = Field(Ellipsis, description='Value is the value of the metric')

CreateCronWorkflowRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CreateCronWorkflowRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    cron_workflow: Optional[CronWorkflow] = Field(None, alias="cronWorkflow")
    namespace: Optional[str] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

cron_workflow class-attribute instance-attribute

cron_workflow: Optional[CronWorkflow] = Field(None, alias='cronWorkflow')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

CreateS3BucketOptions

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CreateS3BucketOptions(BaseModel):
    object_locking: Optional[bool] = Field(
        None, alias="objectLocking", description="ObjectLocking Enable object locking"
    )

object_locking class-attribute instance-attribute

object_locking: Optional[bool] = Field(None, alias='objectLocking', description='ObjectLocking Enable object locking')

CronWorkflow

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflow(BaseModel):
    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: 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"
        ),
    )
    metadata: v1_1.ObjectMeta
    spec: CronWorkflowSpec
    status: Optional[CronWorkflowStatus] = None

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')

metadata instance-attribute

metadata: v1_1.ObjectMeta

spec instance-attribute

spec: CronWorkflowSpec

status class-attribute instance-attribute

status: Optional[CronWorkflowStatus] = None

CronWorkflowDeletedResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowDeletedResponse(BaseModel):
    pass

CronWorkflowList

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowList(BaseModel):
    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"
        ),
    )
    items: List[CronWorkflow]
    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"
        ),
    )
    metadata: v1_1.ListMeta

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')

items instance-attribute

items: List[CronWorkflow]

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')

metadata instance-attribute

metadata: v1_1.ListMeta

CronWorkflowResumeRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowResumeRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

CronWorkflowSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowSpec(BaseModel):
    concurrency_policy: Optional[str] = Field(
        None,
        alias="concurrencyPolicy",
        description="ConcurrencyPolicy is the K8s-style concurrency policy that will be used",
    )
    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: str = Field(..., description="Schedule is a schedule to run the Workflow in Cron format")
    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: Optional[int] = Field(
        None,
        alias="successfulJobsHistoryLimit",
        description="SuccessfulJobsHistoryLimit is the number of successful jobs to be kept at a time",
    )
    suspend: Optional[bool] = Field(
        None, description="Suspend is a flag that will stop new CronWorkflows from running if set to true"
    )
    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."
        ),
    )
    workflow_metadata: Optional[v1_1.ObjectMeta] = Field(
        None, alias="workflowMetadata", description="WorkflowMetadata contains some metadata of the workflow to be run"
    )
    workflow_spec: WorkflowSpec = Field(
        ..., alias="workflowSpec", description="WorkflowSpec is the spec of the workflow to be run"
    )

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.')

workflow_metadata class-attribute instance-attribute

workflow_metadata: Optional[v1_1.ObjectMeta] = Field(None, alias='workflowMetadata', description='WorkflowMetadata contains some metadata of the workflow to be run')

workflow_spec class-attribute instance-attribute

workflow_spec: WorkflowSpec = Field(Ellipsis, alias='workflowSpec', description='WorkflowSpec is the spec of the workflow to be run')

CronWorkflowStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowStatus(BaseModel):
    active: List[v1.ObjectReference] = Field(
        ..., description="Active is a list of active workflows stemming from this CronWorkflow"
    )
    conditions: List[Condition] = Field(
        ..., description="Conditions is a list of conditions the CronWorkflow may have"
    )
    last_scheduled_time: v1_1.Time = Field(
        ..., alias="lastScheduledTime", description="LastScheduleTime is the last time the CronWorkflow was scheduled"
    )

active class-attribute instance-attribute

active: List[v1.ObjectReference] = Field(Ellipsis, description='Active is a list of active workflows stemming from this CronWorkflow')

conditions class-attribute instance-attribute

conditions: List[Condition] = Field(Ellipsis, description='Conditions is a list of conditions the CronWorkflow may have')

last_scheduled_time class-attribute instance-attribute

last_scheduled_time: v1_1.Time = Field(Ellipsis, alias='lastScheduledTime', description='LastScheduleTime is the last time the CronWorkflow was scheduled')

CronWorkflowSuspendRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class CronWorkflowSuspendRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

DAGTask

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class DAGTask(BaseModel):
    arguments: Optional[Arguments] = Field(
        None, description="Arguments are the parameter and artifact arguments to the template"
    )
    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: Optional[List[str]] = Field(
        None, description="Dependencies are name of other targets which this depends on"
    )
    depends: Optional[str] = Field(None, description="Depends are name of other targets which this depends on")
    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: Optional[Template] = Field(
        None, description="Inline is the template. Template must be empty if this is declared (and vice-versa)."
    )
    name: str = Field(..., description="Name is the name of the target")
    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: Optional[str] = Field(None, description="Name of template to execute")
    template_ref: Optional[TemplateRef] = Field(
        None, alias="templateRef", description="TemplateRef is the reference to the template resource to execute."
    )
    when: Optional[str] = Field(
        None, description="When is an expression in which the task should conditionally execute"
    )
    with_items: Optional[List[Item]] = Field(
        None,
        alias="withItems",
        description="WithItems expands a task into multiple parallel tasks from the items in the list",
    )
    with_param: Optional[str] = Field(
        None,
        alias="withParam",
        description=(
            "WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected"
            " to be a JSON list."
        ),
    )
    with_sequence: Optional[Sequence] = Field(
        None, alias="withSequence", description="WithSequence expands a task into a numeric sequence"
    )

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

name: str = Field(Ellipsis, description='Name is the name of the target')

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='Name of template to execute')

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')

with_param class-attribute instance-attribute

with_param: Optional[str] = Field(None, alias='withParam', description='WithParam expands a task into multiple parallel tasks from the value in the parameter, which is expected to be a JSON list.')

with_sequence class-attribute instance-attribute

with_sequence: Optional[Sequence] = Field(None, alias='withSequence', description='WithSequence expands a task into a numeric sequence')

DAGTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class DAGTemplate(BaseModel):
    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"
        ),
    )
    target: Optional[str] = Field(None, description="Target are one or more names of targets to execute in a DAG")
    tasks: List[DAGTask] = Field(..., description="Tasks are a list of DAG tasks")

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')

target class-attribute instance-attribute

target: Optional[str] = Field(None, description='Target are one or more names of targets to execute in a DAG')

tasks class-attribute instance-attribute

tasks: List[DAGTask] = Field(Ellipsis, description='Tasks are a list of DAG tasks')

Data

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Data(BaseModel):
    source: DataSource = Field(..., description="Source sources external data into a data template")
    transformation: List[TransformationStep] = Field(
        ..., description="Transformation applies a set of transformations"
    )

source class-attribute instance-attribute

source: DataSource = Field(Ellipsis, description='Source sources external data into a data template')

transformation class-attribute instance-attribute

transformation: List[TransformationStep] = Field(Ellipsis, description='Transformation applies a set of transformations')

DataSource

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class DataSource(BaseModel):
    artifact_paths: Optional[ArtifactPaths] = Field(
        None,
        alias="artifactPaths",
        description="ArtifactPaths is a data transformation that collects a list of artifact paths",
    )

artifact_paths class-attribute instance-attribute

artifact_paths: Optional[ArtifactPaths] = Field(None, alias='artifactPaths', description='ArtifactPaths is a data transformation that collects a list of artifact paths')

Event

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Event(BaseModel):
    selector: str = Field(
        ...,
        description=(
            "Selector (https://github.com/antonmedv/expr) that we must must match the io.argoproj.workflow.v1alpha1."
            ' E.g. `payload.message == "test"`'
        ),
    )

selector class-attribute instance-attribute

selector: str = Field(Ellipsis, description='Selector (https://github.com/antonmedv/expr) that we must must match the io.argoproj.workflow.v1alpha1. E.g. `payload.message == "test"`')

EventResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class EventResponse(BaseModel):
    pass

ExecutorConfig

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ExecutorConfig(BaseModel):
    service_account_name: Optional[str] = Field(
        None,
        alias="serviceAccountName",
        description="ServiceAccountName specifies the service account name of the executor container.",
    )

service_account_name class-attribute instance-attribute

service_account_name: Optional[str] = Field(None, alias='serviceAccountName', description='ServiceAccountName specifies the service account name of the executor container.')

GCSArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class GCSArtifact(BaseModel):
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    key: str = Field(..., description="Key is the path in the bucket where the artifact resides")
    service_account_key_secret: Optional[v1.SecretKeySelector] = Field(
        None,
        alias="serviceAccountKeySecret",
        description="ServiceAccountKeySecret is the secret selector to the bucket's service account key",
    )

bucket class-attribute instance-attribute

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

key class-attribute instance-attribute

key: str = Field(Ellipsis, description='Key is the path in the bucket where the artifact resides')

service_account_key_secret class-attribute instance-attribute

service_account_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='serviceAccountKeySecret', description="ServiceAccountKeySecret is the secret selector to the bucket's service account key")

GCSArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class GCSArtifactRepository(BaseModel):
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    key_format: Optional[str] = Field(
        None,
        alias="keyFormat",
        description="KeyFormat is defines the format of how to store keys. Can reference workflow variables",
    )
    service_account_key_secret: Optional[v1.SecretKeySelector] = Field(
        None,
        alias="serviceAccountKeySecret",
        description="ServiceAccountKeySecret is the secret selector to the bucket's service account key",
    )

bucket class-attribute instance-attribute

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

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')

service_account_key_secret class-attribute instance-attribute

service_account_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='serviceAccountKeySecret', description="ServiceAccountKeySecret is the secret selector to the bucket's service account key")

Gauge

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Gauge(BaseModel):
    realtime: bool = Field(..., description="Realtime emits this metric in real time if applicable")
    value: str = Field(..., description="Value is the value of the metric")

realtime class-attribute instance-attribute

realtime: bool = Field(Ellipsis, description='Realtime emits this metric in real time if applicable')

value class-attribute instance-attribute

value: str = Field(Ellipsis, description='Value is the value of the metric')

GetUserInfoResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class GetUserInfoResponse(BaseModel):
    email: Optional[str] = None
    email_verified: Optional[bool] = Field(None, alias="emailVerified")
    groups: Optional[List[str]] = None
    issuer: Optional[str] = None
    service_account_name: Optional[str] = Field(None, alias="serviceAccountName")
    service_account_namespace: Optional[str] = Field(None, alias="serviceAccountNamespace")
    subject: Optional[str] = None

email class-attribute instance-attribute

email: Optional[str] = None

email_verified class-attribute instance-attribute

email_verified: Optional[bool] = Field(None, alias='emailVerified')

groups class-attribute instance-attribute

groups: Optional[List[str]] = None

issuer class-attribute instance-attribute

issuer: Optional[str] = None

service_account_name class-attribute instance-attribute

service_account_name: Optional[str] = Field(None, alias='serviceAccountName')

service_account_namespace class-attribute instance-attribute

service_account_namespace: Optional[str] = Field(None, alias='serviceAccountNamespace')

subject class-attribute instance-attribute

subject: Optional[str] = None

GitArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class GitArtifact(BaseModel):
    branch: Optional[str] = Field(None, description="Branch is the branch to fetch when `SingleBranch` is enabled")
    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: Optional[bool] = Field(
        None, alias="disableSubmodules", description="DisableSubmodules disables submodules during git clone"
    )
    fetch: Optional[List[str]] = Field(
        None, description="Fetch specifies a number of refs that should be fetched before checkout"
    )
    insecure_ignore_host_key: Optional[bool] = Field(
        None,
        alias="insecureIgnoreHostKey",
        description="InsecureIgnoreHostKey disables SSH strict host key checking during git clone",
    )
    password_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="passwordSecret", description="PasswordSecret is the secret selector to the repository password"
    )
    repo: str = Field(..., description="Repo is the git repository")
    revision: Optional[str] = Field(None, description="Revision is the git commit, tag, branch to checkout")
    single_branch: Optional[bool] = Field(
        None,
        alias="singleBranch",
        description="SingleBranch enables single branch clone, using the `branch` parameter",
    )
    ssh_private_key_secret: Optional[v1.SecretKeySelector] = Field(
        None,
        alias="sshPrivateKeySecret",
        description="SSHPrivateKeySecret is the secret selector to the repository ssh private key",
    )
    username_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="usernameSecret", description="UsernameSecret is the secret selector to the repository username"
    )

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

repo: str = Field(Ellipsis, description='Repo is the git repository')

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')

ssh_private_key_secret class-attribute instance-attribute

ssh_private_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='sshPrivateKeySecret', description='SSHPrivateKeySecret is the secret selector to the repository ssh private key')

username_secret class-attribute instance-attribute

username_secret: Optional[v1.SecretKeySelector] = Field(None, alias='usernameSecret', description='UsernameSecret is the secret selector to the repository username')

HDFSArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HDFSArtifact(BaseModel):
    addresses: Optional[List[str]] = Field(None, description="Addresses is accessible addresses of HDFS name nodes")
    force: Optional[bool] = Field(None, description="Force copies a file forcibly even if it exists")
    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: 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: 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: 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: 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: 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."
        ),
    )
    krb_username: Optional[str] = Field(
        None,
        alias="krbUsername",
        description="KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.",
    )
    path: str = Field(..., description="Path is a file path in HDFS")

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

force: Optional[bool] = Field(None, description='Force copies a file forcibly even if it exists')

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.')

krb_username class-attribute instance-attribute

krb_username: Optional[str] = Field(None, alias='krbUsername', description='KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.')

path class-attribute instance-attribute

path: str = Field(Ellipsis, description='Path is a file path in HDFS')

HDFSArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HDFSArtifactRepository(BaseModel):
    addresses: Optional[List[str]] = Field(None, description="Addresses is accessible addresses of HDFS name nodes")
    force: Optional[bool] = Field(None, description="Force copies a file forcibly even if it exists")
    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: 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: 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: 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: 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: 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."
        ),
    )
    krb_username: Optional[str] = Field(
        None,
        alias="krbUsername",
        description="KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.",
    )
    path_format: Optional[str] = Field(
        None,
        alias="pathFormat",
        description="PathFormat is defines the format of path to store a file. Can reference workflow variables",
    )

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

force: Optional[bool] = Field(None, description='Force copies a file forcibly even if it exists')

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.')

krb_username class-attribute instance-attribute

krb_username: Optional[str] = Field(None, alias='krbUsername', description='KrbUsername is the Kerberos username used with Kerberos keytab It must be set if keytab is used.')

path_format class-attribute instance-attribute

path_format: Optional[str] = Field(None, alias='pathFormat', description='PathFormat is defines the format of path to store a file. Can reference workflow variables')

HTTP

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTP(BaseModel):
    body: Optional[str] = Field(None, description="Body is content of the HTTP Request")
    body_from: Optional[HTTPBodySource] = Field(
        None, alias="bodyFrom", description="BodyFrom is  content of the HTTP Request as Bytes"
    )
    headers: Optional[List[HTTPHeader]] = Field(
        None, description="Headers are an optional list of headers to send with HTTP requests"
    )
    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: Optional[str] = Field(None, description="Method is HTTP methods for HTTP Request")
    success_condition: Optional[str] = Field(
        None,
        alias="successCondition",
        description="SuccessCondition is an expression if evaluated to true is considered successful",
    )
    timeout_seconds: Optional[int] = Field(
        None,
        alias="timeoutSeconds",
        description="TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds",
    )
    url: str = Field(..., description="URL of the HTTP Request")

body class-attribute instance-attribute

body: Optional[str] = Field(None, description='Body is content of the HTTP Request')

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

method: Optional[str] = Field(None, description='Method is HTTP methods for HTTP Request')

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')

timeout_seconds class-attribute instance-attribute

timeout_seconds: Optional[int] = Field(None, alias='timeoutSeconds', description='TimeoutSeconds is request timeout for HTTP Request. Default is 30 seconds')

url class-attribute instance-attribute

url: str = Field(Ellipsis, description='URL of the HTTP Request')

HTTPArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTPArtifact(BaseModel):
    auth: Optional[HTTPAuth] = Field(None, description="Auth contains information for client authentication")
    headers: Optional[List[Header]] = Field(
        None, description="Headers are an optional list of headers to send with HTTP requests for artifacts"
    )
    url: str = Field(..., description="URL of the artifact")

auth class-attribute instance-attribute

auth: Optional[HTTPAuth] = Field(None, description='Auth contains information for client authentication')

headers class-attribute instance-attribute

headers: Optional[List[Header]] = Field(None, description='Headers are an optional list of headers to send with HTTP requests for artifacts')

url class-attribute instance-attribute

url: str = Field(Ellipsis, description='URL of the artifact')

HTTPAuth

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTPAuth(BaseModel):
    basic_auth: Optional[BasicAuth] = Field(None, alias="basicAuth")
    client_cert: Optional[ClientCertAuth] = Field(None, alias="clientCert")
    oauth2: Optional[OAuth2Auth] = None

basic_auth class-attribute instance-attribute

basic_auth: Optional[BasicAuth] = Field(None, alias='basicAuth')

client_cert class-attribute instance-attribute

client_cert: Optional[ClientCertAuth] = Field(None, alias='clientCert')

oauth2 class-attribute instance-attribute

oauth2: Optional[OAuth2Auth] = None

HTTPBodySource

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTPBodySource(BaseModel):
    bytes: Optional[str] = None

bytes class-attribute instance-attribute

bytes: Optional[str] = None

HTTPHeader

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTPHeader(BaseModel):
    name: str
    value: Optional[str] = None
    value_from: Optional[HTTPHeaderSource] = Field(None, alias="valueFrom")

name instance-attribute

name: str

value class-attribute instance-attribute

value: Optional[str] = None

value_from class-attribute instance-attribute

value_from: Optional[HTTPHeaderSource] = Field(None, alias='valueFrom')

HTTPHeaderSource

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class HTTPHeaderSource(BaseModel):
    secret_key_ref: Optional[v1.SecretKeySelector] = Field(None, alias="secretKeyRef")

secret_key_ref class-attribute instance-attribute

secret_key_ref: Optional[v1.SecretKeySelector] = Field(None, alias='secretKeyRef')

Header

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Header(BaseModel):
    name: str = Field(..., description="Name is the header name")
    value: str = Field(..., description="Value is the literal value to use for the header")

name class-attribute instance-attribute

name: str = Field(Ellipsis, description='Name is the header name')

value class-attribute instance-attribute

value: str = Field(Ellipsis, description='Value is the literal value to use for the header')

Histogram

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Histogram(BaseModel):
    buckets: List[Amount] = Field(..., description="Buckets is a list of bucket divisors for the histogram")
    value: str = Field(..., description="Value is the value of the metric")

buckets class-attribute instance-attribute

buckets: List[Amount] = Field(Ellipsis, description='Buckets is a list of bucket divisors for the histogram')

value class-attribute instance-attribute

value: str = Field(Ellipsis, description='Value is the value of the metric')

InfoResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class InfoResponse(BaseModel):
    links: Optional[List[Link]] = None
    managed_namespace: Optional[str] = Field(None, alias="managedNamespace")
    modals: Optional[Dict[str, bool]] = Field(None, title="which modals to show")
    nav_color: Optional[str] = Field(None, alias="navColor")

links class-attribute instance-attribute

links: Optional[List[Link]] = None

managed_namespace class-attribute instance-attribute

managed_namespace: Optional[str] = Field(None, alias='managedNamespace')

modals class-attribute instance-attribute

modals: Optional[Dict[str, bool]] = Field(None, title='which modals to show')

nav_color class-attribute instance-attribute

nav_color: Optional[str] = Field(None, alias='navColor')

Inputs

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Inputs(BaseModel):
    artifacts: Optional[List[Artifact]] = Field(None, description="Artifact are a list of artifacts passed as inputs")
    parameters: Optional[List[Parameter]] = Field(
        None, description="Parameters are a list of parameters passed as inputs"
    )

artifacts class-attribute instance-attribute

artifacts: Optional[List[Artifact]] = Field(None, description='Artifact are a list of artifacts passed as inputs')

parameters class-attribute instance-attribute

parameters: Optional[List[Parameter]] = Field(None, description='Parameters are a list of parameters passed as inputs')

Item

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Item(BaseModel):
    __root__: Any = Field(
        ...,
        description=(
            "Item expands a single workflow step into multiple parallel steps The value of Item can be a map, string,"
            " bool, or number"
        ),
    )

LabelKeys

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class LabelKeys(BaseModel):
    items: Optional[List[str]] = None

items class-attribute instance-attribute

items: Optional[List[str]] = None

LabelValueFrom

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class LabelValueFrom(BaseModel):
    expression: str

expression instance-attribute

expression: str

LabelValues

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class LabelValues(BaseModel):
    items: Optional[List[str]] = None

items class-attribute instance-attribute

items: Optional[List[str]] = None

LifecycleHook

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class LifecycleHook(BaseModel):
    arguments: Optional[Arguments] = Field(None, description="Arguments hold arguments to the template")
    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"
        ),
    )
    template: Optional[str] = Field(None, description="Template is the name of the template to execute by the hook")
    template_ref: Optional[TemplateRef] = Field(
        None,
        alias="templateRef",
        description="TemplateRef is the reference to the template resource to execute by the hook",
    )

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')

template class-attribute instance-attribute

template: Optional[str] = Field(None, description='Template is the name of the template to execute by the hook')

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 by the hook')

Link

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Link(BaseModel):
    name: str = Field(..., description='The name of the link, E.g. "Workflow Logs" or "Pod Logs"')
    scope: str = Field(..., description='"workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs" or "chat"')
    url: str = Field(
        ...,
        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}"'
        ),
    )

name class-attribute instance-attribute

name: str = Field(Ellipsis, description='The name of the link, E.g. "Workflow Logs" or "Pod Logs"')

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

class LintCronWorkflowRequest(BaseModel):
    cron_workflow: Optional[CronWorkflow] = Field(None, alias="cronWorkflow")
    namespace: Optional[str] = None

cron_workflow class-attribute instance-attribute

cron_workflow: Optional[CronWorkflow] = Field(None, alias='cronWorkflow')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

LogEntry

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class LogEntry(BaseModel):
    content: Optional[str] = None
    pod_name: Optional[str] = Field(None, alias="podName")

content class-attribute instance-attribute

content: Optional[str] = None

pod_name class-attribute instance-attribute

pod_name: Optional[str] = Field(None, alias='podName')

ManifestFrom

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ManifestFrom(BaseModel):
    artifact: Artifact = Field(..., description="Artifact contains the artifact to use")

artifact class-attribute instance-attribute

artifact: Artifact = Field(Ellipsis, description='Artifact contains the artifact to use')

MemoizationStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class MemoizationStatus(BaseModel):
    cache_name: str = Field(..., alias="cacheName", description="Cache is the name of the cache that was used")
    hit: bool = Field(..., description="Hit indicates whether this node was created from a cache entry")
    key: str = Field(..., description="Key is the name of the key used for this node's cache")

cache_name class-attribute instance-attribute

cache_name: str = Field(Ellipsis, alias='cacheName', description='Cache is the name of the cache that was used')

hit class-attribute instance-attribute

hit: bool = Field(Ellipsis, description='Hit indicates whether this node was created from a cache entry')

key class-attribute instance-attribute

key: str = Field(Ellipsis, description="Key is the name of the key used for this node's cache")

Memoize

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Memoize(BaseModel):
    cache: Cache = Field(..., description="Cache sets and configures the kind of cache")
    key: str = Field(..., description="Key is the key to use as the caching key")
    max_age: str = Field(
        ...,
        alias="maxAge",
        description=(
            'MaxAge is the maximum age (e.g. "180s", "24h") of an entry that is still considered valid. If an entry is'
            " older than the MaxAge, it will be ignored."
        ),
    )

cache class-attribute instance-attribute

cache: Cache = Field(Ellipsis, description='Cache sets and configures the kind of cache')

key class-attribute instance-attribute

key: str = Field(Ellipsis, description='Key is the key to use as the caching key')

max_age class-attribute instance-attribute

max_age: str = Field(Ellipsis, alias='maxAge', description='MaxAge is the maximum age (e.g. "180s", "24h") of an entry that is still considered valid. If an entry is older than the MaxAge, it will be ignored.')

Metadata

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Metadata(BaseModel):
    annotations: Optional[Dict[str, str]] = None
    labels: Optional[Dict[str, str]] = None

annotations class-attribute instance-attribute

annotations: Optional[Dict[str, str]] = None

labels class-attribute instance-attribute

labels: Optional[Dict[str, str]] = None

MetricLabel

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class MetricLabel(BaseModel):
    key: str
    value: str

key instance-attribute

key: str

value instance-attribute

value: str

Metrics

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Metrics(BaseModel):
    prometheus: List[Prometheus] = Field(..., description="Prometheus is a list of prometheus metrics to be emitted")

prometheus class-attribute instance-attribute

prometheus: List[Prometheus] = Field(Ellipsis, description='Prometheus is a list of prometheus metrics to be emitted')

Mutex

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Mutex(BaseModel):
    name: Optional[str] = Field(None, description="name of the mutex")

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='name of the mutex')

MutexHolding

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class MutexHolding(BaseModel):
    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}"
        ),
    )
    mutex: Optional[str] = Field(None, description="Reference for the mutex e.g: ${namespace}/mutex/${mutexName}")

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}")

mutex class-attribute instance-attribute

mutex: Optional[str] = Field(None, description='Reference for the mutex e.g: ${namespace}/mutex/${mutexName}')

MutexStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class MutexStatus(BaseModel):
    holding: Optional[List[MutexHolding]] = Field(
        None,
        description=(
            "Holding is a list of mutexes and their respective objects that are held by mutex lock for this"
            " io.argoproj.workflow.v1alpha1."
        ),
    )
    waiting: Optional[List[MutexHolding]] = Field(
        None, description="Waiting is a list of mutexes and their respective objects this workflow is waiting for."
    )

holding class-attribute instance-attribute

holding: Optional[List[MutexHolding]] = Field(None, description='Holding is a list of mutexes and their respective objects that are held by mutex lock for this io.argoproj.workflow.v1alpha1.')

waiting class-attribute instance-attribute

waiting: Optional[List[MutexHolding]] = Field(None, description='Waiting is a list of mutexes and their respective objects this workflow is waiting for.')

NodeResult

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class NodeResult(BaseModel):
    message: Optional[str] = None
    outputs: Optional[Outputs] = None
    phase: Optional[str] = None
    progress: Optional[str] = None

message class-attribute instance-attribute

message: Optional[str] = None

outputs class-attribute instance-attribute

outputs: Optional[Outputs] = None

phase class-attribute instance-attribute

phase: Optional[str] = None

progress class-attribute instance-attribute

progress: Optional[str] = None

NodeStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class NodeStatus(BaseModel):
    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: Optional[List[str]] = Field(None, description="Children is a list of child node IDs")
    daemoned: Optional[bool] = Field(
        None, description="Daemoned tracks whether or not this node was daemoned and need to be terminated"
    )
    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: Optional[int] = Field(
        None, alias="estimatedDuration", description="EstimatedDuration in seconds."
    )
    finished_at: Optional[v1_1.Time] = Field(None, alias="finishedAt", description="Time at which this node completed")
    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: str = Field(
        ...,
        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: Optional[Inputs] = Field(
        None,
        description=(
            "Inputs captures input parameter values and artifact locations supplied to this template invocation"
        ),
    )
    memoization_status: Optional[MemoizationStatus] = Field(
        None, alias="memoizationStatus", description="MemoizationStatus holds information about cached nodes"
    )
    message: Optional[str] = Field(
        None, description="A human readable message indicating details about why the node is in this condition."
    )
    name: str = Field(..., description="Name is unique name in the node tree used to generate the node ID")
    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: Optional[Outputs] = Field(
        None,
        description=(
            "Outputs captures output parameter values and artifact locations produced by this template invocation"
        ),
    )
    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: Optional[str] = Field(
        None, alias="podIP", description="PodIP captures the IP of the pod for daemoned steps"
    )
    progress: Optional[str] = Field(None, description="Progress to completion")
    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: Optional[v1_1.Time] = Field(None, alias="startedAt", description="Time at which this node started")
    synchronization_status: Optional[NodeSynchronizationStatus] = Field(
        None,
        alias="synchronizationStatus",
        description="SynchronizationStatus is the synchronization status of the node",
    )
    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: 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)"
        ),
    )
    template_scope: Optional[str] = Field(
        None,
        alias="templateScope",
        description="TemplateScope is the template scope in which the template of this node was retrieved.",
    )
    type: str = Field(..., description="Type indicates type of node")

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

children: Optional[List[str]] = Field(None, description='Children is a list of child node IDs')

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

progress: Optional[str] = Field(None, description='Progress to completion')

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)')

template_scope class-attribute instance-attribute

template_scope: Optional[str] = Field(None, alias='templateScope', description='TemplateScope is the template scope in which the template of this node was retrieved.')

type class-attribute instance-attribute

type: str = Field(Ellipsis, description='Type indicates type of node')

NodeSynchronizationStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class NodeSynchronizationStatus(BaseModel):
    waiting: Optional[str] = Field(None, description="Waiting is the name of the lock that this node is waiting for")

waiting class-attribute instance-attribute

waiting: Optional[str] = Field(None, description='Waiting is the name of the lock that this node is waiting for')

NoneStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class NoneStrategy(BaseModel):
    pass

OAuth2Auth

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class OAuth2Auth(BaseModel):
    client_id_secret: Optional[v1.SecretKeySelector] = Field(None, alias="clientIDSecret")
    client_secret_secret: Optional[v1.SecretKeySelector] = Field(None, alias="clientSecretSecret")
    endpoint_params: Optional[List[OAuth2EndpointParam]] = Field(None, alias="endpointParams")
    scopes: Optional[List[str]] = None
    token_url_secret: Optional[v1.SecretKeySelector] = Field(None, alias="tokenURLSecret")

client_id_secret class-attribute instance-attribute

client_id_secret: Optional[v1.SecretKeySelector] = Field(None, alias='clientIDSecret')

client_secret_secret class-attribute instance-attribute

client_secret_secret: Optional[v1.SecretKeySelector] = Field(None, alias='clientSecretSecret')

endpoint_params class-attribute instance-attribute

endpoint_params: Optional[List[OAuth2EndpointParam]] = Field(None, alias='endpointParams')

scopes class-attribute instance-attribute

scopes: Optional[List[str]] = None

token_url_secret class-attribute instance-attribute

token_url_secret: Optional[v1.SecretKeySelector] = Field(None, alias='tokenURLSecret')

OAuth2EndpointParam

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class OAuth2EndpointParam(BaseModel):
    key: str = Field(..., description="Name is the header name")
    value: Optional[str] = Field(None, description="Value is the literal value to use for the header")

key class-attribute instance-attribute

key: str = Field(Ellipsis, description='Name is the header name')

value class-attribute instance-attribute

value: Optional[str] = Field(None, description='Value is the literal value to use for the header')

OSSArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class OSSArtifact(BaseModel):
    access_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="accessKeySecret", description="AccessKeySecret is the secret selector to the bucket's access key"
    )
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    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: Optional[str] = Field(None, description="Endpoint is the hostname of the bucket endpoint")
    key: str = Field(..., description="Key is the path in the bucket where the artifact resides")
    lifecycle_rule: Optional[OSSLifecycleRule] = Field(
        None, alias="lifecycleRule", description="LifecycleRule specifies how to manage bucket's lifecycle"
    )
    secret_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="secretKeySecret", description="SecretKeySecret is the secret selector to the bucket's secret key"
    )
    security_token: Optional[str] = Field(
        None,
        alias="securityToken",
        description=(
            "SecurityToken is the user's temporary security token. For more details, check out:"
            " https://www.alibabacloud.com/help/doc-detail/100624.htm"
        ),
    )

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

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

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

key: str = Field(Ellipsis, description='Key is the path in the bucket where the artifact resides')

lifecycle_rule class-attribute instance-attribute

lifecycle_rule: Optional[OSSLifecycleRule] = Field(None, alias='lifecycleRule', description="LifecycleRule specifies how to manage bucket's lifecycle")

secret_key_secret class-attribute instance-attribute

secret_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")

security_token class-attribute instance-attribute

security_token: Optional[str] = Field(None, alias='securityToken', description="SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm")

OSSArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class OSSArtifactRepository(BaseModel):
    access_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="accessKeySecret", description="AccessKeySecret is the secret selector to the bucket's access key"
    )
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    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: Optional[str] = Field(None, description="Endpoint is the hostname of the bucket endpoint")
    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: Optional[OSSLifecycleRule] = Field(
        None, alias="lifecycleRule", description="LifecycleRule specifies how to manage bucket's lifecycle"
    )
    secret_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="secretKeySecret", description="SecretKeySecret is the secret selector to the bucket's secret key"
    )
    security_token: Optional[str] = Field(
        None,
        alias="securityToken",
        description=(
            "SecurityToken is the user's temporary security token. For more details, check out:"
            " https://www.alibabacloud.com/help/doc-detail/100624.htm"
        ),
    )

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

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

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")

secret_key_secret class-attribute instance-attribute

secret_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")

security_token class-attribute instance-attribute

security_token: Optional[str] = Field(None, alias='securityToken', description="SecurityToken is the user's temporary security token. For more details, check out: https://www.alibabacloud.com/help/doc-detail/100624.htm")

OSSLifecycleRule

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class OSSLifecycleRule(BaseModel):
    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: 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"
        ),
    )

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

class Outputs(BaseModel):
    artifacts: Optional[List[Artifact]] = Field(
        None, description="Artifacts holds the list of output artifacts produced by a step"
    )
    exit_code: Optional[str] = Field(
        None, alias="exitCode", description="ExitCode holds the exit code of a script template"
    )
    parameters: Optional[List[Parameter]] = Field(
        None, description="Parameters holds the list of output parameters produced by a step"
    )
    result: Optional[str] = Field(None, description="Result holds the result (stdout) of a script template")

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')

parameters class-attribute instance-attribute

parameters: Optional[List[Parameter]] = Field(None, description='Parameters holds the list of output parameters produced by a step')

result class-attribute instance-attribute

result: Optional[str] = Field(None, description='Result holds the result (stdout) of a script template')

ParallelSteps

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ParallelSteps(BaseModel):
    __root__: List[WorkflowStep]

Parameter

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Parameter(BaseModel):
    default: Optional[str] = Field(
        None, description="Default is the default value to use for an input parameter if a value was not supplied"
    )
    description: Optional[str] = Field(None, description="Description is the parameter description")
    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: 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: str = Field(..., description="Name is the parameter name")
    value: Optional[str] = Field(
        None,
        description=(
            "Value is the literal value to use for the parameter. If specified in the context of an input parameter,"
            " the value takes precedence over any passed values"
        ),
    )
    value_from: Optional[ValueFrom] = Field(
        None, alias="valueFrom", description="ValueFrom is the source for the output parameter's value"
    )

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

description: Optional[str] = Field(None, description='Description is the parameter description')

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

name: str = Field(Ellipsis, description='Name is the parameter name')

value class-attribute instance-attribute

value: Optional[str] = Field(None, description='Value is the literal value to use for the parameter. If specified in the context of an input parameter, the value takes precedence over any passed values')

value_from class-attribute instance-attribute

value_from: Optional[ValueFrom] = Field(None, alias='valueFrom', description="ValueFrom is the source for the output parameter's value")

Plugin

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Plugin(BaseModel):
    pass

PodGC

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class PodGC(BaseModel):
    label_selector: Optional[v1_1.LabelSelector] = Field(
        None,
        alias="labelSelector",
        description=(
            "LabelSelector is the label selector to check if the pods match the labels before being added to the pod"
            " GC queue."
        ),
    )
    strategy: Optional[str] = Field(
        None,
        description=(
            'Strategy is the strategy to use. One of "OnPodCompletion", "OnPodSuccess", "OnWorkflowCompletion",'
            ' "OnWorkflowSuccess"'
        ),
    )

label_selector class-attribute instance-attribute

label_selector: Optional[v1_1.LabelSelector] = Field(None, alias='labelSelector', description='LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue.')

strategy class-attribute instance-attribute

strategy: Optional[str] = Field(None, description='Strategy is the strategy to use. One of "OnPodCompletion", "OnPodSuccess", "OnWorkflowCompletion", "OnWorkflowSuccess"')

Prometheus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Prometheus(BaseModel):
    counter: Optional[Counter] = Field(None, description="Counter is a counter metric")
    gauge: Optional[Gauge] = Field(None, description="Gauge is a gauge metric")
    help: str = Field(..., description="Help is a string that describes the metric")
    histogram: Optional[Histogram] = Field(None, description="Histogram is a histogram metric")
    labels: Optional[List[MetricLabel]] = Field(None, description="Labels is a list of metric labels")
    name: str = Field(..., description="Name is the name of the metric")
    when: Optional[str] = Field(
        None, description="When is a conditional statement that decides when to emit the metric"
    )

counter class-attribute instance-attribute

counter: Optional[Counter] = Field(None, description='Counter is a counter metric')

gauge class-attribute instance-attribute

gauge: Optional[Gauge] = Field(None, description='Gauge is a gauge metric')

help class-attribute instance-attribute

help: str = Field(Ellipsis, description='Help is a string that describes the metric')

histogram class-attribute instance-attribute

histogram: Optional[Histogram] = Field(None, description='Histogram is a histogram metric')

labels class-attribute instance-attribute

labels: Optional[List[MetricLabel]] = Field(None, description='Labels is a list of metric labels')

name class-attribute instance-attribute

name: str = Field(Ellipsis, description='Name is the name of the metric')

when class-attribute instance-attribute

when: Optional[str] = Field(None, description='When is a conditional statement that decides when to emit the metric')

RawArtifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class RawArtifact(BaseModel):
    data: str = Field(..., description="Data is the string contents of the artifact")

data class-attribute instance-attribute

data: str = Field(Ellipsis, description='Data is the string contents of the artifact')

ResourceTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ResourceTemplate(BaseModel):
    action: str = Field(
        ...,
        description=(
            "Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace,"
            " patch"
        ),
    )
    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: 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: Optional[str] = Field(None, description="Manifest contains the kubernetes manifest")
    manifest_from: Optional[ManifestFrom] = Field(
        None, alias="manifestFrom", description="ManifestFrom is the source for a single kubernetes manifest"
    )
    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"
        ),
    )
    set_owner_reference: Optional[bool] = Field(
        None,
        alias="setOwnerReference",
        description=(
            "SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource."
        ),
    )
    success_condition: Optional[str] = Field(
        None,
        alias="successCondition",
        description=(
            "SuccessCondition is a label selector expression which describes the conditions of the k8s resource in"
            " which it is acceptable to proceed to the following step"
        ),
    )

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: Optional[str] = Field(None, description='Manifest contains the kubernetes manifest')

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')

set_owner_reference class-attribute instance-attribute

set_owner_reference: Optional[bool] = Field(None, alias='setOwnerReference', description='SetOwnerReference sets the reference to the workflow on the OwnerReference of generated resource.')

success_condition class-attribute instance-attribute

success_condition: Optional[str] = Field(None, alias='successCondition', description='SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step')

ResubmitArchivedWorkflowRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ResubmitArchivedWorkflowRequest(BaseModel):
    memoized: Optional[bool] = None
    name: Optional[str] = None
    namespace: Optional[str] = None
    parameters: Optional[List[str]] = None
    uid: Optional[str] = None

memoized class-attribute instance-attribute

memoized: Optional[bool] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

parameters class-attribute instance-attribute

parameters: Optional[List[str]] = None

uid class-attribute instance-attribute

uid: Optional[str] = None

RetryAffinity

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class RetryAffinity(BaseModel):
    node_anti_affinity: Optional[RetryNodeAntiAffinity] = Field(None, alias="nodeAntiAffinity")

node_anti_affinity class-attribute instance-attribute

node_anti_affinity: Optional[RetryNodeAntiAffinity] = Field(None, alias='nodeAntiAffinity')

RetryArchivedWorkflowRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class RetryArchivedWorkflowRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None
    node_field_selector: Optional[str] = Field(None, alias="nodeFieldSelector")
    parameters: Optional[List[str]] = None
    restart_successful: Optional[bool] = Field(None, alias="restartSuccessful")
    uid: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

node_field_selector class-attribute instance-attribute

node_field_selector: Optional[str] = Field(None, alias='nodeFieldSelector')

parameters class-attribute instance-attribute

parameters: Optional[List[str]] = None

restart_successful class-attribute instance-attribute

restart_successful: Optional[bool] = Field(None, alias='restartSuccessful')

uid class-attribute instance-attribute

uid: Optional[str] = None

RetryNodeAntiAffinity

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class RetryNodeAntiAffinity(BaseModel):
    pass

RetryStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class RetryStrategy(BaseModel):
    affinity: Optional[RetryAffinity] = Field(
        None, description="Affinity prevents running workflow's step on the same host"
    )
    backoff: Optional[Backoff] = Field(None, description="Backoff is a backoff strategy")
    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"
        ),
    )
    limit: Optional[intstr.IntOrString] = Field(
        None,
        description=(
            "Limit is the maximum number of retry attempts when retrying a container. It does not include the original"
            " container; the maximum number of total attempts will be `limit + 1`."
        ),
    )
    retry_policy: Optional[str] = Field(
        None, alias="retryPolicy", description="RetryPolicy is a policy of NodePhase statuses that will be retried"
    )

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

backoff: Optional[Backoff] = Field(None, description='Backoff is a backoff strategy')

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')

limit class-attribute instance-attribute

limit: Optional[intstr.IntOrString] = Field(None, description='Limit is the maximum number of retry attempts when retrying a container. It does not include the original container; the maximum number of total attempts will be `limit + 1`.')

retry_policy class-attribute instance-attribute

retry_policy: Optional[str] = Field(None, alias='retryPolicy', description='RetryPolicy is a policy of NodePhase statuses that will be retried')

S3Artifact

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class S3Artifact(BaseModel):
    access_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="accessKeySecret", description="AccessKeySecret is the secret selector to the bucket's access key"
    )
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    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: Optional[S3EncryptionOptions] = Field(None, alias="encryptionOptions")
    endpoint: Optional[str] = Field(None, description="Endpoint is the hostname of the bucket endpoint")
    insecure: Optional[bool] = Field(None, description="Insecure will connect to the service with TLS")
    key: Optional[str] = Field(None, description="Key is the key in the bucket where the artifact resides")
    region: Optional[str] = Field(None, description="Region contains the optional bucket region")
    role_arn: Optional[str] = Field(
        None, alias="roleARN", description="RoleARN is the Amazon Resource Name (ARN) of the role to assume."
    )
    secret_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="secretKeySecret", description="SecretKeySecret is the secret selector to the bucket's secret key"
    )
    use_sdk_creds: Optional[bool] = Field(
        None,
        alias="useSDKCreds",
        description="UseSDKCreds tells the driver to figure out credentials based on sdk defaults.",
    )

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

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

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

encryption_options: Optional[S3EncryptionOptions] = Field(None, alias='encryptionOptions')

endpoint class-attribute instance-attribute

endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')

insecure class-attribute instance-attribute

insecure: Optional[bool] = Field(None, description='Insecure will connect to the service with TLS')

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

region: Optional[str] = Field(None, description='Region contains the optional bucket region')

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.')

secret_key_secret class-attribute instance-attribute

secret_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")

use_sdk_creds class-attribute instance-attribute

use_sdk_creds: Optional[bool] = Field(None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')

S3ArtifactRepository

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class S3ArtifactRepository(BaseModel):
    access_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="accessKeySecret", description="AccessKeySecret is the secret selector to the bucket's access key"
    )
    bucket: Optional[str] = Field(None, description="Bucket is the name of the bucket")
    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: Optional[S3EncryptionOptions] = Field(None, alias="encryptionOptions")
    endpoint: Optional[str] = Field(None, description="Endpoint is the hostname of the bucket endpoint")
    insecure: Optional[bool] = Field(None, description="Insecure will connect to the service with TLS")
    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: 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: Optional[str] = Field(None, description="Region contains the optional bucket region")
    role_arn: Optional[str] = Field(
        None, alias="roleARN", description="RoleARN is the Amazon Resource Name (ARN) of the role to assume."
    )
    secret_key_secret: Optional[v1.SecretKeySelector] = Field(
        None, alias="secretKeySecret", description="SecretKeySecret is the secret selector to the bucket's secret key"
    )
    use_sdk_creds: Optional[bool] = Field(
        None,
        alias="useSDKCreds",
        description="UseSDKCreds tells the driver to figure out credentials based on sdk defaults.",
    )

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

bucket: Optional[str] = Field(None, description='Bucket is the name of the bucket')

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

encryption_options: Optional[S3EncryptionOptions] = Field(None, alias='encryptionOptions')

endpoint class-attribute instance-attribute

endpoint: Optional[str] = Field(None, description='Endpoint is the hostname of the bucket endpoint')

insecure class-attribute instance-attribute

insecure: Optional[bool] = Field(None, description='Insecure will connect to the service with TLS')

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

region: Optional[str] = Field(None, description='Region contains the optional bucket region')

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.')

secret_key_secret class-attribute instance-attribute

secret_key_secret: Optional[v1.SecretKeySelector] = Field(None, alias='secretKeySecret', description="SecretKeySecret is the secret selector to the bucket's secret key")

use_sdk_creds class-attribute instance-attribute

use_sdk_creds: Optional[bool] = Field(None, alias='useSDKCreds', description='UseSDKCreds tells the driver to figure out credentials based on sdk defaults.')

S3EncryptionOptions

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class S3EncryptionOptions(BaseModel):
    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: 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: 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: Optional[v1.SecretKeySelector] = Field(
        None,
        alias="serverSideCustomerKeySecret",
        description=(
            "ServerSideCustomerKeySecret tells the driver to encrypt the output artifacts using SSE-C with the"
            " specified secret."
        ),
    )

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

class ScriptTemplate(BaseModel):
    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: 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: Optional[List[v1.EnvVar]] = Field(
        None, description="List of environment variables to set in the container. Cannot be updated."
    )
    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: str = Field(
        ...,
        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: 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: Optional[v1.Lifecycle] = Field(
        None,
        description=(
            "Actions that the management system should take in response to container lifecycle events. Cannot be"
            " updated."
        ),
    )
    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: 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: 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: 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: 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: 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: str = Field(..., description="Source contains the source code of the script to execute")
    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: 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: 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: 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: 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: 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: Optional[List[v1.VolumeDevice]] = Field(
        None,
        alias="volumeDevices",
        description="volumeDevices is the list of block devices to be used by the container.",
    )
    volume_mounts: Optional[List[v1.VolumeMount]] = Field(
        None,
        alias="volumeMounts",
        description="Pod volumes to mount into the container's filesystem. Cannot be updated.",
    )
    working_dir: Optional[str] = Field(
        None,
        alias="workingDir",
        description=(
            "Container's working directory. If not specified, the container runtime's default will be used, which"
            " might be configured in the container image. Cannot be updated."
        ),
    )

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.')

volume_mounts class-attribute instance-attribute

volume_mounts: Optional[List[v1.VolumeMount]] = Field(None, alias='volumeMounts', description="Pod volumes to mount into the container's filesystem. Cannot be updated.")

working_dir class-attribute instance-attribute

working_dir: Optional[str] = Field(None, alias='workingDir', description="Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.")

SemaphoreHolding

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SemaphoreHolding(BaseModel):
    holders: Optional[List[str]] = Field(
        None, description="Holders stores the list of current holder names in the io.argoproj.workflow.v1alpha1."
    )
    semaphore: Optional[str] = Field(None, description="Semaphore stores the semaphore name.")

holders class-attribute instance-attribute

holders: Optional[List[str]] = Field(None, description='Holders stores the list of current holder names in the io.argoproj.workflow.v1alpha1.')

semaphore class-attribute instance-attribute

semaphore: Optional[str] = Field(None, description='Semaphore stores the semaphore name.')

SemaphoreRef

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SemaphoreRef(BaseModel):
    config_map_key_ref: Optional[v1.ConfigMapKeySelector] = Field(
        None, alias="configMapKeyRef", description="ConfigMapKeyRef is configmap selector for Semaphore configuration"
    )

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 Semaphore configuration')

SemaphoreStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SemaphoreStatus(BaseModel):
    holding: Optional[List[SemaphoreHolding]] = Field(
        None, description="Holding stores the list of resource acquired synchronization lock for workflows."
    )
    waiting: Optional[List[SemaphoreHolding]] = Field(
        None, description="Waiting indicates the list of current synchronization lock holders."
    )

holding class-attribute instance-attribute

holding: Optional[List[SemaphoreHolding]] = Field(None, description='Holding stores the list of resource acquired synchronization lock for workflows.')

waiting class-attribute instance-attribute

waiting: Optional[List[SemaphoreHolding]] = Field(None, description='Waiting indicates the list of current synchronization lock holders.')

Sequence

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Sequence(BaseModel):
    count: Optional[intstr.IntOrString] = Field(
        None, description="Count is number of elements in the sequence (default: 0). Not to be used with end"
    )
    end: Optional[intstr.IntOrString] = Field(
        None, description="Number at which to end the sequence (default: 0). Not to be used with Count"
    )
    format: Optional[str] = Field(
        None, description="Format is a printf format string to format the value in the sequence"
    )
    start: Optional[intstr.IntOrString] = Field(None, description="Number at which to start the sequence (default: 0)")

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')

format class-attribute instance-attribute

format: Optional[str] = Field(None, description='Format is a printf format string to format the value in the sequence')

start class-attribute instance-attribute

start: Optional[intstr.IntOrString] = Field(None, description='Number at which to start the sequence (default: 0)')

Submit

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Submit(BaseModel):
    arguments: Optional[Arguments] = Field(
        None, description="Arguments extracted from the event and then set as arguments to the workflow created."
    )
    metadata: Optional[v1_1.ObjectMeta] = Field(
        None, description="Metadata optional means to customize select fields of the workflow metadata"
    )
    workflow_template_ref: WorkflowTemplateRef = Field(
        ..., alias="workflowTemplateRef", description="WorkflowTemplateRef the workflow template to submit"
    )

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.')

metadata class-attribute instance-attribute

metadata: Optional[v1_1.ObjectMeta] = Field(None, description='Metadata optional means to customize select fields of the workflow metadata')

workflow_template_ref class-attribute instance-attribute

workflow_template_ref: WorkflowTemplateRef = Field(Ellipsis, alias='workflowTemplateRef', description='WorkflowTemplateRef the workflow template to submit')

SubmitOpts

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SubmitOpts(BaseModel):
    annotations: Optional[str] = Field(None, description="Annotations adds to metadata.labels")
    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: Optional[str] = Field(None, alias="entryPoint", description="Entrypoint overrides spec.entrypoint")
    generate_name: Optional[str] = Field(
        None, alias="generateName", description="GenerateName overrides metadata.generateName"
    )
    labels: Optional[str] = Field(None, description="Labels adds to metadata.labels")
    name: Optional[str] = Field(None, description="Name overrides metadata.name")
    owner_reference: Optional[v1_1.OwnerReference] = Field(
        None, alias="ownerReference", description="OwnerReference creates a metadata.ownerReference"
    )
    parameters: Optional[List[str]] = Field(None, description="Parameters passes input parameters to workflow")
    pod_priority_class_name: Optional[str] = Field(
        None, alias="podPriorityClassName", description="Set the podPriorityClassName of the workflow"
    )
    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."
        ),
    )
    server_dry_run: Optional[bool] = Field(
        None,
        alias="serverDryRun",
        description="ServerDryRun validates the workflow on the server-side without creating it",
    )
    service_account: Optional[str] = Field(
        None,
        alias="serviceAccount",
        description="ServiceAccount runs all pods in the workflow using specified ServiceAccount.",
    )

annotations class-attribute instance-attribute

annotations: Optional[str] = Field(None, description='Annotations adds to metadata.labels')

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

labels: Optional[str] = Field(None, description='Labels adds to metadata.labels')

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='Name overrides metadata.name')

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.')

server_dry_run class-attribute instance-attribute

server_dry_run: Optional[bool] = Field(None, alias='serverDryRun', description='ServerDryRun validates the workflow on the server-side without creating it')

service_account class-attribute instance-attribute

service_account: Optional[str] = Field(None, alias='serviceAccount', description='ServiceAccount runs all pods in the workflow using specified ServiceAccount.')

SuppliedValueFrom

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SuppliedValueFrom(BaseModel):
    pass

SuspendTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SuspendTemplate(BaseModel):
    duration: Optional[str] = Field(
        None,
        description=(
            "Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit"
            ' is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"'
        ),
    )

duration class-attribute instance-attribute

duration: Optional[str] = Field(None, description='Duration is the seconds to wait before automatically resuming a template. Must be a string. Default unit is seconds. Could also be a Duration, e.g.: "2m", "6h", "1d"')

Synchronization

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Synchronization(BaseModel):
    mutex: Optional[Mutex] = Field(None, description="Mutex holds the Mutex lock details")
    semaphore: Optional[SemaphoreRef] = Field(None, description="Semaphore holds the Semaphore configuration")

mutex class-attribute instance-attribute

mutex: Optional[Mutex] = Field(None, description='Mutex holds the Mutex lock details')

semaphore class-attribute instance-attribute

semaphore: Optional[SemaphoreRef] = Field(None, description='Semaphore holds the Semaphore configuration')

SynchronizationStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class SynchronizationStatus(BaseModel):
    mutex: Optional[MutexStatus] = Field(None, description="Mutex stores this workflow's mutex holder details")
    semaphore: Optional[SemaphoreStatus] = Field(
        None, description="Semaphore stores this workflow's Semaphore holder details"
    )

mutex class-attribute instance-attribute

mutex: Optional[MutexStatus] = Field(None, description="Mutex stores this workflow's mutex holder details")

semaphore class-attribute instance-attribute

semaphore: Optional[SemaphoreStatus] = Field(None, description="Semaphore stores this workflow's Semaphore holder details")

TTLStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class TTLStrategy(BaseModel):
    seconds_after_completion: Optional[int] = Field(
        None,
        alias="secondsAfterCompletion",
        description="SecondsAfterCompletion is the number of seconds to live after completion",
    )
    seconds_after_failure: Optional[int] = Field(
        None,
        alias="secondsAfterFailure",
        description="SecondsAfterFailure is the number of seconds to live after failure",
    )
    seconds_after_success: Optional[int] = Field(
        None,
        alias="secondsAfterSuccess",
        description="SecondsAfterSuccess is the number of seconds to live after success",
    )

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')

seconds_after_failure class-attribute instance-attribute

seconds_after_failure: Optional[int] = Field(None, alias='secondsAfterFailure', description='SecondsAfterFailure is the number of seconds to live after failure')

seconds_after_success class-attribute instance-attribute

seconds_after_success: Optional[int] = Field(None, alias='secondsAfterSuccess', description='SecondsAfterSuccess is the number of seconds to live after success')

TarStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class TarStrategy(BaseModel):
    compression_level: Optional[int] = Field(
        None,
        alias="compressionLevel",
        description=(
            "CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to"
            " gzip.DefaultCompression."
        ),
    )

compression_level class-attribute instance-attribute

compression_level: Optional[int] = Field(None, alias='compressionLevel', description='CompressionLevel specifies the gzip compression level to use for the artifact. Defaults to gzip.DefaultCompression.')

Template

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Template(BaseModel):
    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: 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: 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: 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: Optional[v1.Container] = Field(
        None, description="Container is the main container image to run in the pod"
    )
    container_set: Optional[ContainerSetTemplate] = Field(
        None, alias="containerSet", description="ContainerSet groups multiple containers within a single pod."
    )
    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: Optional[DAGTemplate] = Field(None, description="DAG template subtype which runs a DAG")
    data: Optional[Data] = Field(None, description="Data is a data template")
    executor: Optional[ExecutorConfig] = Field(
        None, description="Executor holds configurations of the executor container."
    )
    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: 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: Optional[HTTP] = Field(None, description="HTTP makes a HTTP request")
    init_containers: Optional[List[UserContainer]] = Field(
        None,
        alias="initContainers",
        description="InitContainers is a list of containers which run before the main container.",
    )
    inputs: Optional[Inputs] = Field(
        None, description="Inputs describe what inputs parameters and artifacts are supplied to this template"
    )
    memoize: Optional[Memoize] = Field(
        None, description="Memoize allows templates to use outputs generated from already executed templates"
    )
    metadata: Optional[Metadata] = Field(
        None, description="Metdata sets the pods's metadata, i.e. annotations and labels"
    )
    metrics: Optional[Metrics] = Field(None, description="Metrics are a list of metrics emitted from this template")
    name: Optional[str] = Field(None, description="Name is the name of the template")
    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: Optional[Outputs] = Field(
        None, description="Outputs describe the parameters and artifacts that this template produces"
    )
    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: Optional[Plugin] = Field(None, description="Plugin is a plugin template")
    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: Optional[int] = Field(None, description="Priority to apply to workflow pods.")
    priority_class_name: Optional[str] = Field(
        None, alias="priorityClassName", description="PriorityClassName to apply to workflow pods."
    )
    resource: Optional[ResourceTemplate] = Field(
        None, description="Resource template subtype which can run k8s resources"
    )
    retry_strategy: Optional[RetryStrategy] = Field(
        None, alias="retryStrategy", description="RetryStrategy describes how to retry a template when it fails"
    )
    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: Optional[ScriptTemplate] = Field(None, description="Script runs a portion of code against an interpreter")
    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: Optional[str] = Field(
        None, alias="serviceAccountName", description="ServiceAccountName to apply to workflow pods"
    )
    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: Optional[List[ParallelSteps]] = Field(
        None, description="Steps define a series of sequential/parallel workflow steps"
    )
    suspend: Optional[SuspendTemplate] = Field(
        None, description="Suspend template subtype which can suspend a workflow when reaching the step"
    )
    synchronization: Optional[Synchronization] = Field(
        None, description="Synchronization holds synchronization lock configuration for this template"
    )
    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."
        ),
    )
    tolerations: Optional[List[v1.Toleration]] = Field(None, description="Tolerations to apply to workflow pods.")
    volumes: Optional[List[v1.Volume]] = Field(
        None, description="Volumes is a list of volumes that can be mounted by containers in a template."
    )

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

dag: Optional[DAGTemplate] = Field(None, description='DAG template subtype which runs a DAG')

data class-attribute instance-attribute

data: Optional[Data] = Field(None, description='Data is a data template')

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

http: Optional[HTTP] = Field(None, description='HTTP makes a HTTP request')

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

name: Optional[str] = Field(None, description='Name is the name of the template')

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

plugin: Optional[Plugin] = Field(None, description='Plugin is a plugin template')

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 to apply to workflow pods.')

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.")

tolerations class-attribute instance-attribute

tolerations: Optional[List[v1.Toleration]] = Field(None, description='Tolerations to apply to workflow pods.')

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 template.')

TemplateRef

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class TemplateRef(BaseModel):
    cluster_scope: Optional[bool] = Field(
        None,
        alias="clusterScope",
        description="ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).",
    )
    name: Optional[str] = Field(None, description="Name is the resource name of the template.")
    template: Optional[str] = Field(None, description="Template is the name of referred template in the resource.")

cluster_scope class-attribute instance-attribute

cluster_scope: Optional[bool] = Field(None, alias='clusterScope', description='ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).')

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='Name is the resource name of the template.')

template class-attribute instance-attribute

template: Optional[str] = Field(None, description='Template is the name of referred template in the resource.')

TransformationStep

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class TransformationStep(BaseModel):
    expression: str = Field(..., description="Expression defines an expr expression to apply")

expression class-attribute instance-attribute

expression: str = Field(Ellipsis, description='Expression defines an expr expression to apply')

UpdateCronWorkflowRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class UpdateCronWorkflowRequest(BaseModel):
    cron_workflow: Optional[CronWorkflow] = Field(None, alias="cronWorkflow")
    name: Optional[str] = Field(None, description="DEPRECATED: This field is ignored.")
    namespace: Optional[str] = None

cron_workflow class-attribute instance-attribute

cron_workflow: Optional[CronWorkflow] = Field(None, alias='cronWorkflow')

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='DEPRECATED: This field is ignored.')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

UserContainer

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class UserContainer(BaseModel):
    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: 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: Optional[List[v1.EnvVar]] = Field(
        None, description="List of environment variables to set in the container. Cannot be updated."
    )
    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: 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: 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: Optional[v1.Lifecycle] = Field(
        None,
        description=(
            "Actions that the management system should take in response to container lifecycle events. Cannot be"
            " updated."
        ),
    )
    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: 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: str = Field(
        ...,
        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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: Optional[List[v1.VolumeDevice]] = Field(
        None,
        alias="volumeDevices",
        description="volumeDevices is the list of block devices to be used by the container.",
    )
    volume_mounts: Optional[List[v1.VolumeMount]] = Field(
        None,
        alias="volumeMounts",
        description="Pod volumes to mount into the container's filesystem. Cannot be updated.",
    )
    working_dir: Optional[str] = Field(
        None,
        alias="workingDir",
        description=(
            "Container's working directory. If not specified, the container runtime's default will be used, which"
            " might be configured in the container image. Cannot be updated."
        ),
    )

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.')

volume_mounts class-attribute instance-attribute

volume_mounts: Optional[List[v1.VolumeMount]] = Field(None, alias='volumeMounts', description="Pod volumes to mount into the container's filesystem. Cannot be updated.")

working_dir class-attribute instance-attribute

working_dir: Optional[str] = Field(None, alias='workingDir', description="Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.")

ValueFrom

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ValueFrom(BaseModel):
    config_map_key_ref: Optional[v1.ConfigMapKeySelector] = Field(
        None,
        alias="configMapKeyRef",
        description="ConfigMapKeyRef is configmap selector for input parameter configuration",
    )
    default: Optional[str] = Field(
        None,
        description="Default specifies a value to be used if retrieving the value from the specified source fails",
    )
    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: Optional[str] = Field(
        None, description="Expression, if defined, is evaluated to specify the value for the parameter"
    )
    jq_filter: Optional[str] = Field(
        None, alias="jqFilter", description="JQFilter expression against the resource object in resource templates"
    )
    json_path: Optional[str] = Field(
        None,
        alias="jsonPath",
        description="JSONPath of a resource to retrieve an output parameter value from in resource templates",
    )
    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}}')"
        ),
    )
    path: Optional[str] = Field(
        None, description="Path in the container to retrieve an output parameter value from in container templates"
    )
    supplied: Optional[SuppliedValueFrom] = Field(
        None, description="Supplied value to be filled in directly, either through the CLI, API, etc."
    )

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}}')")

path class-attribute instance-attribute

path: Optional[str] = Field(None, description='Path in the container to retrieve an output parameter value from in container templates')

supplied class-attribute instance-attribute

supplied: Optional[SuppliedValueFrom] = Field(None, description='Supplied value to be filled in directly, either through the CLI, API, etc.')

Version

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Version(BaseModel):
    build_date: str = Field(..., alias="buildDate")
    compiler: str
    git_commit: str = Field(..., alias="gitCommit")
    git_tag: str = Field(..., alias="gitTag")
    git_tree_state: str = Field(..., alias="gitTreeState")
    go_version: str = Field(..., alias="goVersion")
    platform: str
    version: str

build_date class-attribute instance-attribute

build_date: str = Field(Ellipsis, alias='buildDate')

compiler instance-attribute

compiler: str

git_commit class-attribute instance-attribute

git_commit: str = Field(Ellipsis, alias='gitCommit')

git_tag class-attribute instance-attribute

git_tag: str = Field(Ellipsis, alias='gitTag')

git_tree_state class-attribute instance-attribute

git_tree_state: str = Field(Ellipsis, alias='gitTreeState')

go_version class-attribute instance-attribute

go_version: str = Field(Ellipsis, alias='goVersion')

platform instance-attribute

platform: str

version instance-attribute

version: str

VolumeClaimGC

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class VolumeClaimGC(BaseModel):
    strategy: Optional[str] = Field(
        None, description='Strategy is the strategy to use. One of "OnWorkflowCompletion", "OnWorkflowSuccess"'
    )

strategy class-attribute instance-attribute

strategy: Optional[str] = Field(None, description='Strategy is the strategy to use. One of "OnWorkflowCompletion", "OnWorkflowSuccess"')

Workflow

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class Workflow(BaseModel):
    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: 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"
        ),
    )
    metadata: v1_1.ObjectMeta
    spec: WorkflowSpec
    status: Optional[WorkflowStatus] = None

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')

metadata instance-attribute

metadata: v1_1.ObjectMeta

spec instance-attribute

spec: WorkflowSpec

status class-attribute instance-attribute

status: Optional[WorkflowStatus] = None

WorkflowCreateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowCreateRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    instance_id: Optional[str] = Field(None, alias="instanceID", description="This field is no longer used.")
    namespace: Optional[str] = None
    server_dry_run: Optional[bool] = Field(None, alias="serverDryRun")
    workflow: Optional[Workflow] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

instance_id class-attribute instance-attribute

instance_id: Optional[str] = Field(None, alias='instanceID', description='This field is no longer used.')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

server_dry_run class-attribute instance-attribute

server_dry_run: Optional[bool] = Field(None, alias='serverDryRun')

workflow class-attribute instance-attribute

workflow: Optional[Workflow] = None

WorkflowDeleteResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowDeleteResponse(BaseModel):
    pass

WorkflowEventBinding

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowEventBinding(BaseModel):
    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: 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"
        ),
    )
    metadata: v1_1.ObjectMeta
    spec: WorkflowEventBindingSpec

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')

metadata instance-attribute

metadata: v1_1.ObjectMeta

spec instance-attribute

spec: WorkflowEventBindingSpec

WorkflowEventBindingList

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowEventBindingList(BaseModel):
    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"
        ),
    )
    items: List[WorkflowEventBinding]
    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"
        ),
    )
    metadata: v1_1.ListMeta

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')

items instance-attribute

items: List[WorkflowEventBinding]

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')

metadata instance-attribute

metadata: v1_1.ListMeta

WorkflowEventBindingSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowEventBindingSpec(BaseModel):
    event: Event = Field(..., description="Event is the event to bind to")
    submit: Optional[Submit] = Field(None, description="Submit is the workflow template to submit")

event class-attribute instance-attribute

event: Event = Field(Ellipsis, description='Event is the event to bind to')

submit class-attribute instance-attribute

submit: Optional[Submit] = Field(None, description='Submit is the workflow template to submit')

WorkflowLintRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowLintRequest(BaseModel):
    namespace: Optional[str] = None
    workflow: Optional[Workflow] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

workflow class-attribute instance-attribute

workflow: Optional[Workflow] = None

WorkflowList

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowList(BaseModel):
    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"
        ),
    )
    items: List[Workflow]
    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"
        ),
    )
    metadata: v1_1.ListMeta

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')

items instance-attribute

items: List[Workflow]

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')

metadata instance-attribute

metadata: v1_1.ListMeta

WorkflowMetadata

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowMetadata(BaseModel):
    annotations: Optional[Dict[str, str]] = None
    labels: Optional[Dict[str, str]] = None
    labels_from: Optional[Dict[str, LabelValueFrom]] = Field(None, alias="labelsFrom")

annotations class-attribute instance-attribute

annotations: Optional[Dict[str, str]] = None

labels class-attribute instance-attribute

labels: Optional[Dict[str, str]] = None

labels_from class-attribute instance-attribute

labels_from: Optional[Dict[str, LabelValueFrom]] = Field(None, alias='labelsFrom')

WorkflowResubmitRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowResubmitRequest(BaseModel):
    memoized: Optional[bool] = None
    name: Optional[str] = None
    namespace: Optional[str] = None
    parameters: Optional[List[str]] = None

memoized class-attribute instance-attribute

memoized: Optional[bool] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

parameters class-attribute instance-attribute

parameters: Optional[List[str]] = None

WorkflowResumeRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowResumeRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None
    node_field_selector: Optional[str] = Field(None, alias="nodeFieldSelector")

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

node_field_selector class-attribute instance-attribute

node_field_selector: Optional[str] = Field(None, alias='nodeFieldSelector')

WorkflowRetryRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowRetryRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None
    node_field_selector: Optional[str] = Field(None, alias="nodeFieldSelector")
    parameters: Optional[List[str]] = None
    restart_successful: Optional[bool] = Field(None, alias="restartSuccessful")

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

node_field_selector class-attribute instance-attribute

node_field_selector: Optional[str] = Field(None, alias='nodeFieldSelector')

parameters class-attribute instance-attribute

parameters: Optional[List[str]] = None

restart_successful class-attribute instance-attribute

restart_successful: Optional[bool] = Field(None, alias='restartSuccessful')

WorkflowSetRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowSetRequest(BaseModel):
    message: Optional[str] = None
    name: Optional[str] = None
    namespace: Optional[str] = None
    node_field_selector: Optional[str] = Field(None, alias="nodeFieldSelector")
    output_parameters: Optional[str] = Field(None, alias="outputParameters")
    phase: Optional[str] = None

message class-attribute instance-attribute

message: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

node_field_selector class-attribute instance-attribute

node_field_selector: Optional[str] = Field(None, alias='nodeFieldSelector')

output_parameters class-attribute instance-attribute

output_parameters: Optional[str] = Field(None, alias='outputParameters')

phase class-attribute instance-attribute

phase: Optional[str] = None

WorkflowSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowSpec(BaseModel):
    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: 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: Optional[bool] = Field(
        None, alias="archiveLogs", description="ArchiveLogs indicates if the container logs should be archived"
    )
    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: 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: Optional[ArtifactRepositoryRef] = Field(
        None,
        alias="artifactRepositoryRef",
        description=(
            "ArtifactRepositoryRef specifies the configMap name and key containing the artifact repository config."
        ),
    )
    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: 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: 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: Optional[str] = Field(
        None,
        description="Entrypoint is a template reference to the starting point of the io.argoproj.workflow.v1alpha1.",
    )
    executor: Optional[ExecutorConfig] = Field(
        None, description="Executor holds configurations of executor containers of the io.argoproj.workflow.v1alpha1."
    )
    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: Optional[List[v1.HostAlias]] = Field(None, alias="hostAliases")
    host_network: Optional[bool] = Field(
        None, alias="hostNetwork", description="Host networking requested for this workflow pod. Default to false."
    )
    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: Optional[Metrics] = Field(None, description="Metrics are a list of metrics emitted from this Workflow")
    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: 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: 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: 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: Optional[PodGC] = Field(
        None, alias="podGC", description="PodGC describes the strategy to use when deleting completed pods"
    )
    pod_metadata: Optional[Metadata] = Field(
        None,
        alias="podMetadata",
        description="PodMetadata defines additional metadata that should be applied to workflow pods",
    )
    pod_priority: Optional[int] = Field(
        None,
        alias="podPriority",
        description="Priority to apply to workflow pods. DEPRECATED: Use PodPriorityClassName instead.",
    )
    pod_priority_class_name: Optional[str] = Field(
        None, alias="podPriorityClassName", description="PriorityClassName to apply to workflow pods."
    )
    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: 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: Optional[RetryStrategy] = Field(
        None,
        alias="retryStrategy",
        description="RetryStrategy for all templates in the io.argoproj.workflow.v1alpha1.",
    )
    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: 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: Optional[str] = Field(
        None,
        alias="serviceAccountName",
        description="ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.",
    )
    shutdown: Optional[str] = Field(
        None, description="Shutdown will shutdown the workflow according to its ShutdownStrategy"
    )
    suspend: Optional[bool] = Field(
        None, description="Suspend will suspend the workflow and prevent execution of any future steps in the workflow"
    )
    synchronization: Optional[Synchronization] = Field(
        None, description="Synchronization holds synchronization lock configuration for this Workflow"
    )
    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: Optional[List[Template]] = Field(
        None, description="Templates is a list of workflow templates used in a workflow"
    )
    tolerations: Optional[List[v1.Toleration]] = Field(None, description="Tolerations to apply to workflow pods.")
    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: Optional[VolumeClaimGC] = Field(
        None,
        alias="volumeClaimGC",
        description="VolumeClaimGC describes the strategy to use when deleting volumes from completed workflows",
    )
    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: 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."
        ),
    )
    workflow_metadata: Optional[WorkflowMetadata] = Field(
        None,
        alias="workflowMetadata",
        description="WorkflowMetadata contains some metadata of the workflow to refer to",
    )
    workflow_template_ref: Optional[WorkflowTemplateRef] = Field(
        None,
        alias="workflowTemplateRef",
        description="WorkflowTemplateRef holds a reference to a WorkflowTemplate for execution",
    )

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_aliases: Optional[List[v1.HostAlias]] = Field(None, alias='hostAliases')

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.')

workflow_metadata class-attribute instance-attribute

workflow_metadata: Optional[WorkflowMetadata] = Field(None, alias='workflowMetadata', description='WorkflowMetadata contains some metadata of the workflow to refer to')

workflow_template_ref class-attribute instance-attribute

workflow_template_ref: Optional[WorkflowTemplateRef] = Field(None, alias='workflowTemplateRef', description='WorkflowTemplateRef holds a reference to a WorkflowTemplate for execution')

WorkflowStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowStatus(BaseModel):
    artifact_gc_status: Optional[ArtGCStatus] = Field(
        None,
        alias="artifactGCStatus",
        description="ArtifactGCStatus maintains the status of Artifact Garbage Collection",
    )
    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: Optional[str] = Field(
        None, alias="compressedNodes", description="Compressed and base64 decoded Nodes map"
    )
    conditions: Optional[List[Condition]] = Field(
        None, description="Conditions is a list of conditions the Workflow may have"
    )
    estimated_duration: Optional[int] = Field(
        None, alias="estimatedDuration", description="EstimatedDuration in seconds."
    )
    finished_at: Optional[v1_1.Time] = Field(
        None, alias="finishedAt", description="Time at which this workflow completed"
    )
    message: Optional[str] = Field(
        None, description="A human readable message indicating details about why the workflow is in this condition."
    )
    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: 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: Optional[Outputs] = Field(
        None,
        description=(
            "Outputs captures output values and artifact locations produced by the workflow via global outputs"
        ),
    )
    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: Optional[str] = Field(
        None, description="Phase a simple, high-level summary of where the workflow is in its lifecycle."
    )
    progress: Optional[str] = Field(None, description="Progress to completion")
    resources_duration: Optional[Dict[str, int]] = Field(
        None, alias="resourcesDuration", description="ResourcesDuration is the total for the workflow"
    )
    started_at: Optional[v1_1.Time] = Field(None, alias="startedAt", description="Time at which this workflow started")
    stored_templates: Optional[Dict[str, Template]] = Field(
        None,
        alias="storedTemplates",
        description="StoredTemplates is a mapping between a template ref and the node's status.",
    )
    stored_workflow_template_spec: Optional[WorkflowSpec] = Field(
        None,
        alias="storedWorkflowTemplateSpec",
        description="StoredWorkflowSpec stores the WorkflowTemplate spec for future execution.",
    )
    synchronization: Optional[SynchronizationStatus] = Field(
        None, description="Synchronization stores the status of synchronization locks"
    )

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

progress: Optional[str] = Field(None, description='Progress to completion')

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.")

stored_workflow_template_spec class-attribute instance-attribute

stored_workflow_template_spec: Optional[WorkflowSpec] = Field(None, alias='storedWorkflowTemplateSpec', description='StoredWorkflowSpec stores the WorkflowTemplate spec for future execution.')

synchronization class-attribute instance-attribute

synchronization: Optional[SynchronizationStatus] = Field(None, description='Synchronization stores the status of synchronization locks')

WorkflowStep

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowStep(BaseModel):
    arguments: Optional[Arguments] = Field(None, description="Arguments hold arguments to the template")
    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: 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: Optional[Template] = Field(
        None, description="Inline is the template. Template must be empty if this is declared (and vice-versa)."
    )
    name: Optional[str] = Field(None, description="Name of the step")
    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: Optional[str] = Field(None, description="Template is the name of the template to execute as the step")
    template_ref: Optional[TemplateRef] = Field(
        None,
        alias="templateRef",
        description="TemplateRef is the reference to the template resource to execute as the step.",
    )
    when: Optional[str] = Field(
        None, description="When is an expression in which the step should conditionally execute"
    )
    with_items: Optional[List[Item]] = Field(
        None,
        alias="withItems",
        description="WithItems expands a step into multiple parallel steps from the items in the list",
    )
    with_param: Optional[str] = Field(
        None,
        alias="withParam",
        description=(
            "WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected"
            " to be a JSON list."
        ),
    )
    with_sequence: Optional[Sequence] = Field(
        None, alias="withSequence", description="WithSequence expands a step into a numeric sequence"
    )

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

name: Optional[str] = Field(None, description='Name of the step')

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')

with_param class-attribute instance-attribute

with_param: Optional[str] = Field(None, alias='withParam', description='WithParam expands a step into multiple parallel steps from the value in the parameter, which is expected to be a JSON list.')

with_sequence class-attribute instance-attribute

with_sequence: Optional[Sequence] = Field(None, alias='withSequence', description='WithSequence expands a step into a numeric sequence')

WorkflowStopRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowStopRequest(BaseModel):
    message: Optional[str] = None
    name: Optional[str] = None
    namespace: Optional[str] = None
    node_field_selector: Optional[str] = Field(None, alias="nodeFieldSelector")

message class-attribute instance-attribute

message: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

node_field_selector class-attribute instance-attribute

node_field_selector: Optional[str] = Field(None, alias='nodeFieldSelector')

WorkflowSubmitRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowSubmitRequest(BaseModel):
    namespace: Optional[str] = None
    resource_kind: Optional[str] = Field(None, alias="resourceKind")
    resource_name: Optional[str] = Field(None, alias="resourceName")
    submit_options: Optional[SubmitOpts] = Field(None, alias="submitOptions")

namespace class-attribute instance-attribute

namespace: Optional[str] = None

resource_kind class-attribute instance-attribute

resource_kind: Optional[str] = Field(None, alias='resourceKind')

resource_name class-attribute instance-attribute

resource_name: Optional[str] = Field(None, alias='resourceName')

submit_options class-attribute instance-attribute

submit_options: Optional[SubmitOpts] = Field(None, alias='submitOptions')

WorkflowSuspendRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowSuspendRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

WorkflowTaskSetSpec

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTaskSetSpec(BaseModel):
    tasks: Optional[Dict[str, Template]] = None

tasks class-attribute instance-attribute

tasks: Optional[Dict[str, Template]] = None

WorkflowTaskSetStatus

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTaskSetStatus(BaseModel):
    nodes: Optional[Dict[str, NodeResult]] = None

nodes class-attribute instance-attribute

nodes: Optional[Dict[str, NodeResult]] = None

WorkflowTemplate

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplate(BaseModel):
    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: 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"
        ),
    )
    metadata: v1_1.ObjectMeta
    spec: WorkflowSpec

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')

metadata instance-attribute

metadata: v1_1.ObjectMeta

spec instance-attribute

spec: WorkflowSpec

WorkflowTemplateCreateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateCreateRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    namespace: Optional[str] = None
    template: Optional[WorkflowTemplate] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

template class-attribute instance-attribute

template: Optional[WorkflowTemplate] = None

WorkflowTemplateDeleteResponse

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateDeleteResponse(BaseModel):
    pass

WorkflowTemplateLintRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateLintRequest(BaseModel):
    create_options: Optional[v1_1.CreateOptions] = Field(None, alias="createOptions")
    namespace: Optional[str] = None
    template: Optional[WorkflowTemplate] = None

create_options class-attribute instance-attribute

create_options: Optional[v1_1.CreateOptions] = Field(None, alias='createOptions')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

template class-attribute instance-attribute

template: Optional[WorkflowTemplate] = None

WorkflowTemplateList

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateList(BaseModel):
    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"
        ),
    )
    items: List[WorkflowTemplate]
    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"
        ),
    )
    metadata: v1_1.ListMeta

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')

items instance-attribute

items: List[WorkflowTemplate]

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')

metadata instance-attribute

metadata: v1_1.ListMeta

WorkflowTemplateRef

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateRef(BaseModel):
    cluster_scope: Optional[bool] = Field(
        None,
        alias="clusterScope",
        description="ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).",
    )
    name: Optional[str] = Field(None, description="Name is the resource name of the workflow template.")

cluster_scope class-attribute instance-attribute

cluster_scope: Optional[bool] = Field(None, alias='clusterScope', description='ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate).')

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='Name is the resource name of the workflow template.')

WorkflowTemplateUpdateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTemplateUpdateRequest(BaseModel):
    name: Optional[str] = Field(None, description="DEPRECATED: This field is ignored.")
    namespace: Optional[str] = None
    template: Optional[WorkflowTemplate] = None

name class-attribute instance-attribute

name: Optional[str] = Field(None, description='DEPRECATED: This field is ignored.')

namespace class-attribute instance-attribute

namespace: Optional[str] = None

template class-attribute instance-attribute

template: Optional[WorkflowTemplate] = None

WorkflowTerminateRequest

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowTerminateRequest(BaseModel):
    name: Optional[str] = None
    namespace: Optional[str] = None

name class-attribute instance-attribute

name: Optional[str] = None

namespace class-attribute instance-attribute

namespace: Optional[str] = None

WorkflowWatchEvent

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class WorkflowWatchEvent(BaseModel):
    object: Optional[Workflow] = Field(None, title="the workflow")
    type: Optional[str] = Field(None, title="the type of change")

object class-attribute instance-attribute

object: Optional[Workflow] = Field(None, title='the workflow')

type class-attribute instance-attribute

type: Optional[str] = Field(None, title='the type of change')

ZipStrategy

Source code in src/hera/workflows/models/io/argoproj/workflow/v1alpha1.py

class ZipStrategy(BaseModel):
    pass

Comments