Hera Workflows
hera.workflows
Hera classes
AWSElasticBlockStoreVolumeVolume
Source code in src/hera/workflows/volume.py
AccessMode
A representations of the volume access modes for Kubernetes.
Notes
See: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes for more information.
Source code in src/hera/workflows/volume.py
read_only_many
class-attribute
instance-attribute
The volume can be mounted as read-only by many nodes
read_write_many
class-attribute
instance-attribute
The volume can be mounted as read-write by many nodes
read_write_once
class-attribute
instance-attribute
The volume can be mounted as read-write by a single node. ReadWriteOnce access mode still can allow multiple pods to access the volume when the pods are running on the same node
read_write_once_pod
class-attribute
instance-attribute
The volume can be mounted as read-write by a single Pod. Use ReadWriteOncePod access mode if you want to ensure that only one pod across whole cluster can read that PVC or write to it. This is only supported for CSI volumes and Kubernetes version 1.22+.
ArchiveStrategy
Artifact
Source code in src/hera/workflows/artifact.py
archive
class-attribute
instance-attribute
ArtifactoryArtifact
Source code in src/hera/workflows/artifact.py
AzureArtifact
Source code in src/hera/workflows/artifact.py
AzureDiskVolumeVolume
Source code in src/hera/workflows/volume.py
AzureFileVolumeVolume
Source code in src/hera/workflows/volume.py
CSIVolume
Source code in src/hera/workflows/volume.py
CephFSVolumeVolume
Source code in src/hera/workflows/volume.py
CinderVolume
Source code in src/hera/workflows/volume.py
ConfigMapEnv
Source code in src/hera/workflows/env.py
build
Constructs and returns the Argo environment specification
Source code in src/hera/workflows/env.py
ConfigMapEnvFrom
Source code in src/hera/workflows/env_from.py
build
Constructs and returns the Argo EnvFrom specification
Source code in src/hera/workflows/env_from.py
ConfigMapVolume
Source code in src/hera/workflows/volume.py
Container
The Container template type defines a container to run on Argo.
Source code in src/hera/workflows/container.py
security_context
class-attribute
instance-attribute
ContainerNode
A regular container that can be used as part of a hera.workflows.ContainerSet
.
See Also
https://argoproj.github.io/argo-workflows/container-set-template/
Source code in src/hera/workflows/container_set.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|
security_context
class-attribute
instance-attribute
next
Sets the given container as a dependency of this container and returns the given container.
Examples
from hera.workflows import ContainerNode
normally, you use the following within a
hera.workflows.ContainerSet
context.a, b = ContainerNode(name=”a”), ContainerNode(name=”b”) a.next(b) b.dependencies [‘a’]
Source code in src/hera/workflows/container_set.py
ContainerSet
Source code in src/hera/workflows/container_set.py
Counter
Counter metric component used to count specific events based on the given value.
Notes
See: https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
CronWorkflow
CronWorkflow allows a user to run a Workflow on a recurring basis.
NB: Hera’s CronWorkflow is a subclass of Workflow which means certain fields are renamed
for compatibility, see cron_suspend
and cron_status
which are different from the Argo
spec. See https://argoproj.github.io/argo-workflows/fields/#cronworkflow
Source code in src/hera/workflows/cron_workflow.py
failed_jobs_history_limit
class-attribute
instance-attribute
starting_deadline_seconds
class-attribute
instance-attribute
successful_jobs_history_limit
class-attribute
instance-attribute
build
Builds the CronWorkflow and its components into an Argo schema CronWorkflow object.
Source code in src/hera/workflows/cron_workflow.py
create
Creates the CronWorkflow on the Argo cluster.
Source code in src/hera/workflows/cron_workflow.py
lint
Lints the CronWorkflow using the Argo cluster.
Source code in src/hera/workflows/cron_workflow.py
DAG
A DAG template invocator is used to define Task dependencies as an acyclic graph.
DAG implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.task.Task
objects instantiated will be added to the DAG’s list of Tasks.
Source code in src/hera/workflows/dag.py
Data
Source code in src/hera/workflows/data.py
DownwardAPIVolume
Source code in src/hera/workflows/volume.py
EmptyDirVolume
Env
Source code in src/hera/workflows/env.py
value_from_input
class-attribute
instance-attribute
build
Constructs and returns the Argo environment specification
Source code in src/hera/workflows/env.py
EphemeralVolume
ExistingVolume
Source code in src/hera/workflows/volume.py
FCVolume
Source code in src/hera/workflows/volume.py
FieldEnv
Source code in src/hera/workflows/env.py
build
Constructs and returns the Argo environment specification
Source code in src/hera/workflows/env.py
FlexVolume
Source code in src/hera/workflows/volume.py
FlockerVolume
Source code in src/hera/workflows/volume.py
GCEPersistentDiskVolume
Source code in src/hera/workflows/volume.py
GCSArtifact
Source code in src/hera/workflows/artifact.py
Gauge
Gauge metric component used to record intervals based on the given value.
Notes
See: https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
GitArtifact
Source code in src/hera/workflows/artifact.py
GitRepoVolume
Source code in src/hera/workflows/volume.py
GlusterfsVolume
Source code in src/hera/workflows/volume.py
HDFSArtifact
Source code in src/hera/workflows/artifact.py
krb_c_cache_secret
class-attribute
instance-attribute
krb_config_config_map
class-attribute
instance-attribute
krb_keytab_secret
class-attribute
instance-attribute
krb_service_principal_name
class-attribute
instance-attribute
HTTP
Source code in src/hera/workflows/http_template.py
HTTPArtifact
Source code in src/hera/workflows/artifact.py
Histogram
Histogram metric that records the value at the specified bucket intervals.
Notes
See: https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
HostPathVolume
ISCSIVolume
Source code in src/hera/workflows/volume.py
InlineScriptConstructor
Source code in src/hera/workflows/script.py
generate_source
Assembles and returns a script representation of the given function, along with the extra script material prefixed to the string. The script is expected to be a callable function the client is interested in submitting for execution on Argo and the script_extra material represents the parameter loading part obtained, likely, through get_param_script_portion.
Returns
str Final formatted script.
Source code in src/hera/workflows/script.py
InvalidDispatchType
InvalidTemplateCall
Metric
Prometheus metric that can be used at the workflow or task/template level.
Notes
See: https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
Metrics
A collection of Prometheus metrics.
Notes
See: https://argoproj.github.io/argo-workflows/metrics/#grafana-dashboard-for-argo-controller-metrics
Source code in src/hera/workflows/metrics.py
NFSVolume
NoneArchiveStrategy
OSSArtifact
Source code in src/hera/workflows/artifact.py
Operator
Operator is a representation of mathematical comparison symbols. This can be used on tasks that execute conditionally based on the output of another task. Notes
The task that outputs its result needs to do so using stdout. See examples
for a sample workflow.
Source code in src/hera/workflows/operator.py
Parallel
Parallel is used to add a list of steps which will run in parallel.
Parallel implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.steps.Step
objects instantiated will be added to Parallel’s list of sub_steps.
Source code in src/hera/workflows/steps.py
Parameter
A Parameter
is used to pass values in and out of templates.
They are to declare input and output parameters in the case of templates, and are used for Steps and Tasks to assign values.
Source code in src/hera/workflows/parameter.py
as_argument
Assembles the parameter for use as an argument of a step or a task
Source code in src/hera/workflows/parameter.py
as_input
Assembles the parameter for use as an input of a template
Source code in src/hera/workflows/parameter.py
as_output
Assembles the parameter for use as an output of a template
Source code in src/hera/workflows/parameter.py
with_name
PhotonPersistentDiskVolume
Source code in src/hera/workflows/volume.py
PortworxVolume
Source code in src/hera/workflows/volume.py
ProjectedVolume
QuobyteVolume
Source code in src/hera/workflows/volume.py
RBDVolume
Source code in src/hera/workflows/volume.py
RawArtifact
Resource
Source code in src/hera/workflows/resource.py
manifest
class-attribute
instance-attribute
ResourceEnv
Source code in src/hera/workflows/env.py
build
Source code in src/hera/workflows/env.py
Resources
A representation of a collection of resources that are requested to be consumed by a task for execution.
This follow the K8S definition for resources.
Parameters
Optional[Union[float, int, str]] = None
The number of CPUs to request, either as a fraction (millicpu), whole number, or a string.
Optional[Union[int, str]] = None
The limit of CPUs to request, either as a fraction (millicpu), whole number, or a string.
Optional[str] = None
The amount of memory to request.
Optional[str] = None
The memory limit of the pod.
Optional[str] = None
The amount of ephemeral storage to request.
Optional[str] = None
The emphemeral storage limit of the pod.
Optional[int] = None
The number of GPUs to request.
Optional[str] = “nvidia.com/gpu”
The GPU flag to use for identifying how many GPUs to mount to a pod. This is dependent on the cloud provider.
Optional[Dict] = None
Any custom resources to request. This is dependent on the cloud provider.
Source code in src/hera/workflows/resources.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
|
build
Builds the resource requirements of the pod
Source code in src/hera/workflows/resources.py
RetryPolicy
Source code in src/hera/workflows/retry_strategy.py
on_error
class-attribute
instance-attribute
Retry steps that encounter Argo controller errors, or whose init or wait containers fail
on_failure
class-attribute
instance-attribute
Retry steps whose main container is marked as failed in Kubernetes
RetryStrategy
Source code in src/hera/workflows/retry_strategy.py
retry_policy
class-attribute
instance-attribute
RunnerScriptConstructor
Source code in src/hera/workflows/script.py
generate_source
transform_values
Source code in src/hera/workflows/script.py
S3Artifact
Source code in src/hera/workflows/artifact.py
ScaleIOVolume
Source code in src/hera/workflows/volume.py
Script
A Script acts as a wrapper around a container. In Hera this defaults to a “python:3.8” image
specified by global_config.image, which runs a python source specified by Script.source
.
Source code in src/hera/workflows/script.py
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
|
constructor
class-attribute
instance-attribute
security_context
class-attribute
instance-attribute
ScriptConstructor
A ScriptConstructor is responsible for generating the source code for a Script given a python callable.
This allows users to customize the behaviour of the template that hera generates when a python callable is passed to the Script class.
In order to use your custom ScriptConstructor implementation, you can set it as the Script.constructor field.
Source code in src/hera/workflows/script.py
generate_source
abstractmethod
A function that can inspect the Script instance and generate the source field.
transform_script_template_post_build
A hook to transform the generated script template.
transform_template_post_build
transform_values
SecretEnv
Source code in src/hera/workflows/env.py
build
Constructs and returns the Argo environment specification
Source code in src/hera/workflows/env.py
SecretEnvFrom
Source code in src/hera/workflows/env_from.py
build
Constructs and returns the Argo EnvFrom specification
SecretVolume
Source code in src/hera/workflows/volume.py
Step
Step is used to run a given template. Must be instantiated under a Steps or Parallel context, or outside a Workflow.
Source code in src/hera/workflows/steps.py
Steps
A Steps template invocator is used to define a sequence of steps which can run sequentially or in parallel.
Steps implements the contextmanager interface so allows usage of with
, under which any
hera.workflows.steps.Step
objects instantiated will be added to the Steps’ list of sub_steps.
- Step and Parallel objects initialised within a Steps context will be added to the list of sub_steps in the order they are initialised.
- All Step objects initialised within a Parallel context will run in parallel.
Source code in src/hera/workflows/steps.py
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|
StorageOSVolume
Source code in src/hera/workflows/volume.py
Suspend
The Suspend template allows the user to pause a workflow for a specified length of time
given by duration
or indefinitely (i.e. until manually resumed). The Suspend template also
allows you to specify intermediate_parameters
which will replicate the given parameters to
the “inputs” and “outputs” of the template, resulting in a Suspend template that pauses and
waits for values from the user for the given list of parameters.
Source code in src/hera/workflows/suspend.py
TarArchiveStrategy
Source code in src/hera/workflows/archive.py
Task
Task is used to run a given template within a DAG. Must be instantiated under a DAG context.
Dependencies
Any Tasks
without a dependency defined will start immediately.
Dependencies between Tasks can be described using the convenience syntax >>
, for example:
describes the relationships:
- “A has no dependencies (so starts immediately)
- “B depends on A”.
As a diagram:
A >> B
is equivalent to A.next(B)
.
Lists of Tasks
A list of Tasks used with the rshift syntax describes an “AND” dependency between the single Task on the left of
>>
and the list Tasks to the right of >>
(or vice versa). A list of Tasks on both sides of >>
is not supported.
For example:
describes the relationships:
- “A has no dependencies
- “B AND C depend on A”
- “D depends on B AND C”
As a diagram:
Dependencies can be described over multiple statements:
describes the relationships:
- “A and B have no dependencies
- “C depends on A AND B”
- “D depends on A AND B”
As a diagram:
Source code in src/hera/workflows/task.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
|
next
Set self as a dependency of other
.
Source code in src/hera/workflows/task.py
on_error
on_failure
on_other_result
Source code in src/hera/workflows/task.py
on_success
on_workflow_status
Source code in src/hera/workflows/task.py
when_all_failed
Source code in src/hera/workflows/task.py
when_any_succeeded
Source code in src/hera/workflows/task.py
TaskResult
The enumeration of Task Results specified at https://argoproj.github.io/argo-workflows/enhanced-depends-logic/#depends
Source code in src/hera/workflows/task.py
UserContainer
Source code in src/hera/workflows/user_container.py
env_from
class-attribute
instance-attribute
image_pull_policy
class-attribute
instance-attribute
resources
class-attribute
instance-attribute
build
Source code in src/hera/workflows/user_container.py
Volume
Source code in src/hera/workflows/volume.py
access_modes
class-attribute
instance-attribute
VsphereVirtualDiskVolume
Source code in src/hera/workflows/volume.py
Workflow
The base Workflow class for Hera.
Workflow implements the contextmanager interface so allows usage of with
, under which
any hera.workflows.protocol.Templatable
object instantiated under the context will be
added to the Workflow’s list of templates.
Workflows can be created directly on your Argo cluster via create
. They can also be dumped
to yaml via to_yaml
or built according to the Argo schema via build
to get an OpenAPI model
object.
Source code in src/hera/workflows/workflow.py
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
|
active_deadline_seconds
class-attribute
instance-attribute
artifact_repository_ref
class-attribute
instance-attribute
automount_service_account_token
class-attribute
instance-attribute
deletion_grace_period_seconds
class-attribute
instance-attribute
managed_fields
class-attribute
instance-attribute
owner_references
class-attribute
instance-attribute
pod_disruption_budget
class-attribute
instance-attribute
pod_priority_class_name
class-attribute
instance-attribute
security_context
class-attribute
instance-attribute
synchronization
class-attribute
instance-attribute
template_defaults
class-attribute
instance-attribute
templates
class-attribute
instance-attribute
volume_claim_templates
class-attribute
instance-attribute
workflow_metadata
class-attribute
instance-attribute
workflow_template_ref
class-attribute
instance-attribute
workflows_service
class-attribute
instance-attribute
build
Builds the Workflow and its components into an Argo schema Workflow object.
Source code in src/hera/workflows/workflow.py
create
Creates the Workflow on the Argo cluster.
Parameters
bool = False
If true then the workflow is created asynchronously and the function returns immediately. If false then the workflow is created and the function blocks until the workflow is done executing.
int = 5
The interval in seconds to poll the workflow status if wait is true. Ignored when wait is true.
Source code in src/hera/workflows/workflow.py
get_parameter
Source code in src/hera/workflows/workflow.py
lint
Lints the Workflow using the Argo cluster.
Source code in src/hera/workflows/workflow.py
to_dict
Builds the Workflow as an Argo schema Workflow object and returns it as a dictionary.
to_file
Writes the Workflow as an Argo schema Workflow object to a YAML file and returns the path to the file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[Path, str]
|
The directory to write the file to. Defaults to the current working directory. |
'.'
|
name |
str
|
The name of the file to write without the file extension. Defaults to the Workflow’s name or a generated name. |
''
|
*args |
Additional arguments to pass to |
()
|
|
**kwargs |
Additional keyword arguments to pass to |
{}
|
Source code in src/hera/workflows/workflow.py
to_yaml
Builds the Workflow as an Argo schema Workflow object and returns it as yaml string.
Source code in src/hera/workflows/workflow.py
wait
Waits for the Workflow to complete execution.
Parameters
int = 5
The interval in seconds to poll the workflow status.
Source code in src/hera/workflows/workflow.py
WorkflowStatus
Placeholder for workflow statuses
Source code in src/hera/workflows/workflow_status.py
from_argo_status
classmethod
Turns an Argo status into a Hera workflow status representation
Source code in src/hera/workflows/workflow_status.py
WorkflowTemplate
WorkflowTemplates are definitions of Workflows that live in your cluster. This allows you to create a library of frequently-used templates and reuse them by referencing them from your Workflows.
Source code in src/hera/workflows/workflow_template.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
|
build
Builds the WorkflowTemplate and its components into an Argo schema WorkflowTemplate object.
Source code in src/hera/workflows/workflow_template.py
create
Creates the WorkflowTemplate on the Argo cluster.
Source code in src/hera/workflows/workflow_template.py
get
Attempts to get a workflow template based on the parameters of this template e.g. name + namespace
Source code in src/hera/workflows/workflow_template.py
lint
Lints the WorkflowTemplate using the Argo cluster.
Source code in src/hera/workflows/workflow_template.py
update
Attempts to perform a workflow template update based on the parameters of this template
e.g. name, namespace. Note that this creates the template if it does not exist. In addition, this performs
a get prior to updating to get the resource version to update in the first place. If you know the template
does not exist ahead of time, it is more efficient to use create()
directly to avoid one round trip.
Source code in src/hera/workflows/workflow_template.py
WorkflowsService
Source code in src/hera/workflows/service.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
|
verify_ssl
instance-attribute
create_cluster_workflow_template
Source code in src/hera/workflows/service.py
create_cron_workflow
Source code in src/hera/workflows/service.py
create_workflow
Source code in src/hera/workflows/service.py
create_workflow_template
Source code in src/hera/workflows/service.py
delete_archived_workflow
Source code in src/hera/workflows/service.py
delete_cluster_workflow_template
delete_cluster_workflow_template(name, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
Source code in src/hera/workflows/service.py
delete_cron_workflow
delete_cron_workflow(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
Source code in src/hera/workflows/service.py
delete_workflow
delete_workflow(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None, force=None)
Source code in src/hera/workflows/service.py
delete_workflow_template
delete_workflow_template(name, namespace=None, grace_period_seconds=None, uid=None, resource_version=None, orphan_dependents=None, propagation_policy=None, dry_run=None)
Source code in src/hera/workflows/service.py
get_archived_workflow
Source code in src/hera/workflows/service.py
get_artifact_file
get_artifact_file(id_discriminator, id_, node_id, artifact_name, artifact_discriminator, namespace=None)
Get an artifact.
Source code in src/hera/workflows/service.py
get_cluster_workflow_template
Source code in src/hera/workflows/service.py
get_cron_workflow
Source code in src/hera/workflows/service.py
get_info
Source code in src/hera/workflows/service.py
get_input_artifact
Get an input artifact.
Source code in src/hera/workflows/service.py
get_input_artifact_by_uid
Get an input artifact by UID.
Source code in src/hera/workflows/service.py
get_output_artifact
Get an output artifact.
Source code in src/hera/workflows/service.py
get_output_artifact_by_uid
Get an output artifact by UID.
Source code in src/hera/workflows/service.py
get_user_info
Source code in src/hera/workflows/service.py
get_version
Source code in src/hera/workflows/service.py
get_workflow
Source code in src/hera/workflows/service.py
get_workflow_template
Source code in src/hera/workflows/service.py
lint_cluster_workflow_template
Source code in src/hera/workflows/service.py
lint_cron_workflow
Source code in src/hera/workflows/service.py
lint_workflow
Source code in src/hera/workflows/service.py
lint_workflow_template
Source code in src/hera/workflows/service.py
list_archived_workflow_label_keys
Source code in src/hera/workflows/service.py
list_archived_workflow_label_values
list_archived_workflow_label_values(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
Source code in src/hera/workflows/service.py
list_archived_workflows
list_archived_workflows(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None, name_prefix=None)
Source code in src/hera/workflows/service.py
list_cluster_workflow_templates
list_cluster_workflow_templates(label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
Source code in src/hera/workflows/service.py
list_cron_workflows
list_cron_workflows(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
Source code in src/hera/workflows/service.py
list_workflow_templates
list_workflow_templates(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None)
Source code in src/hera/workflows/service.py
list_workflows
list_workflows(namespace=None, label_selector=None, field_selector=None, watch=None, allow_watch_bookmarks=None, resource_version=None, resource_version_match=None, timeout_seconds=None, limit=None, continue_=None, fields=None)
Source code in src/hera/workflows/service.py
pod_logs
pod_logs(name, pod_name, namespace=None, container=None, follow=None, previous=None, since_seconds=None, seconds=None, nanos=None, timestamps=None, tail_lines=None, limit_bytes=None, insecure_skip_tls_verify_backend=None, grep=None, selector=None)
DEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.
Source code in src/hera/workflows/service.py
resubmit_archived_workflow
Source code in src/hera/workflows/service.py
resubmit_workflow
Source code in src/hera/workflows/service.py
resume_cron_workflow
Source code in src/hera/workflows/service.py
resume_workflow
Source code in src/hera/workflows/service.py
retry_archived_workflow
Source code in src/hera/workflows/service.py
retry_workflow
Source code in src/hera/workflows/service.py
set_workflow
Source code in src/hera/workflows/service.py
stop_workflow
Source code in src/hera/workflows/service.py
submit_workflow
Source code in src/hera/workflows/service.py
suspend_cron_workflow
Source code in src/hera/workflows/service.py
suspend_workflow
Source code in src/hera/workflows/service.py
terminate_workflow
Source code in src/hera/workflows/service.py
update_cluster_workflow_template
Source code in src/hera/workflows/service.py
update_cron_workflow
Source code in src/hera/workflows/service.py
update_workflow_template
Source code in src/hera/workflows/service.py
workflow_logs
workflow_logs(name, namespace=None, pod_name=None, container=None, follow=None, previous=None, since_seconds=None, seconds=None, nanos=None, timestamps=None, tail_lines=None, limit_bytes=None, insecure_skip_tls_verify_backend=None, grep=None, selector=None)