Skip to content

workflow.v1alpha1.nodeStatus

"NodeStatus contains status information about an individual node in the workflow"

Index

Fields

fn withBoundaryID

withBoundaryID(boundaryID)

"BoundaryID indicates the node ID of the associated template root node in which this node belongs to"

fn withChildren

withChildren(children)

"Children is a list of child node IDs"

fn withChildrenMixin

withChildrenMixin(children)

"Children is a list of child node IDs"

Note: This function appends passed data to existing values

fn withDaemoned

withDaemoned(daemoned)

"Daemoned tracks whether or not this node was daemoned and need to be terminated"

fn withDisplayName

withDisplayName(displayName)

"DisplayName is a human readable representation of the node. Unique within a template boundary"

fn withEstimatedDuration

withEstimatedDuration(estimatedDuration)

"EstimatedDuration in seconds."

fn withFinishedAt

withFinishedAt(finishedAt)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn withHostNodeName

withHostNodeName(hostNodeName)

"HostNodeName name of the Kubernetes node on which the Pod is running, if applicable"

fn withId

withId(id)

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

fn withMessage

withMessage(message)

"A human readable message indicating details about why the node is in this condition."

fn withName

withName(name)

"Name is unique name in the node tree used to generate the node ID"

fn withOutboundNodes

withOutboundNodes(outboundNodes)

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

fn withOutboundNodesMixin

withOutboundNodesMixin(outboundNodes)

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

Note: This function appends passed data to existing values

fn withPhase

withPhase(phase)

"Phase a simple, high-level summary of where the node is in its lifecycle. Can be used as a state machine. Will be one of these values \"Pending\", \"Running\" before the node is completed, or \"Succeeded\", \"Skipped\", \"Failed\", \"Error\", or \"Omitted\" as a final state."

fn withPodIP

withPodIP(podIP)

"PodIP captures the IP of the pod for daemoned steps"

fn withProgress

withProgress(progress)

"Progress to completion"

fn withResourcesDuration

withResourcesDuration(resourcesDuration)

"ResourcesDuration is indicative, but not accurate, resource duration. This is populated when the nodes completes."

fn withResourcesDurationMixin

withResourcesDurationMixin(resourcesDuration)

"ResourcesDuration is indicative, but not accurate, resource duration. This is populated when the nodes completes."

Note: This function appends passed data to existing values

fn withStartedAt

withStartedAt(startedAt)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn withTemplateName

withTemplateName(templateName)

"TemplateName is the template name which this node corresponds to. Not applicable to virtual nodes (e.g. Retry, StepGroup)"

fn withTemplateScope

withTemplateScope(templateScope)

"TemplateScope is the template scope in which the template of this node was retrieved."

fn withType

withType(type)

"Type indicates type of node"

obj inputs

"Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another"

fn inputs.withArtifacts

withArtifacts(artifacts)

"Artifact are a list of artifacts passed as inputs"

fn inputs.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifact are a list of artifacts passed as inputs"

Note: This function appends passed data to existing values

fn inputs.withParameters

withParameters(parameters)

"Parameters are a list of parameters passed as inputs"

fn inputs.withParametersMixin

withParametersMixin(parameters)

"Parameters are a list of parameters passed as inputs"

Note: This function appends passed data to existing values

obj memoizationStatus

"MemoizationStatus is the status of this memoized node"

fn memoizationStatus.withCacheName

withCacheName(cacheName)

"Cache is the name of the cache that was used"

fn memoizationStatus.withHit

withHit(hit)

"Hit indicates whether this node was created from a cache entry"

fn memoizationStatus.withKey

withKey(key)

"Key is the name of the key used for this node's cache"

obj nodeFlag

fn nodeFlag.withHooked

withHooked(hooked)

"Hooked tracks whether or not this node was triggered by hook or onExit"

fn nodeFlag.withRetried

withRetried(retried)

"Retried tracks whether or not this node was retried by retryStrategy"

obj outputs

"Outputs hold parameters, artifacts, and results from a step"

fn outputs.withArtifacts

withArtifacts(artifacts)

"Artifacts holds the list of output artifacts produced by a step"

fn outputs.withArtifactsMixin

withArtifactsMixin(artifacts)

"Artifacts holds the list of output artifacts produced by a step"

Note: This function appends passed data to existing values

fn outputs.withExitCode

withExitCode(exitCode)

"ExitCode holds the exit code of a script template"

fn outputs.withParameters

withParameters(parameters)

"Parameters holds the list of output parameters produced by a step"

fn outputs.withParametersMixin

withParametersMixin(parameters)

"Parameters holds the list of output parameters produced by a step"

Note: This function appends passed data to existing values

fn outputs.withResult

withResult(result)

"Result holds the result (stdout) of a script template"

obj synchronizationStatus

"NodeSynchronizationStatus stores the status of a node"

fn synchronizationStatus.withWaiting

withWaiting(waiting)

"Waiting is the name of the lock that this node is waiting for"

obj templateRef

"TemplateRef is a reference of template resource."

fn templateRef.withClusterScope

withClusterScope(clusterScope)

"ClusterScope indicates the referred template is cluster scoped (i.e. a ClusterWorkflowTemplate)."

fn templateRef.withName

withName(name)

"Name is the resource name of the template."

fn templateRef.withTemplate

withTemplate(template)

"Template is the name of referred template in the resource."