workflow.v1alpha1.parameter

"Parameter indicate a passed string parameter to a service template with an optional default value"

Index

• fn withDefault(default)
• fn withEnum(enum)
• fn withEnumMixin(enum)
• fn withGlobalName(globalName)
• fn withName(name)
• fn withValue(value)
• obj valueFrom
  • fn withDefault(default)
  • fn withEvent(event)
  • fn withExpression(expression)
  • fn withJqFilter(jqFilter)
  • fn withJsonPath(jsonPath)
  • fn withParameter(parameter)
  • fn withPath(path)
  • fn withSupplied(supplied)
  • fn withSuppliedMixin(supplied)
  • obj valueFrom.configMapKeyRef
    • fn withKey(key)
    • fn withName(name)
    • fn withOptional(optional)

Fields

fn withDefault

withDefault(default)

"Default is the default value to use for an input parameter if a value was not supplied"

fn withEnum

withEnum(enum)

"Enum holds a list of string values to choose from, for the actual value of the parameter"

fn withEnumMixin

withEnumMixin(enum)

"Enum holds a list of string values to choose from, for the actual value of the parameter"

Note: This function appends passed data to existing values

fn withGlobalName

withGlobalName(globalName)

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

fn withName

withName(name)

"Name is the parameter name"

fn withValue

withValue(value)

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

obj valueFrom

"ValueFrom describes a location in which to obtain the value to a parameter"

fn valueFrom.withDefault

withDefault(default)

"Default specifies a value to be used if retrieving the value from the specified source fails"

fn valueFrom.withEvent

withEvent(event)

"Selector (https://github.com/antonmedv/expr) that is evaluated against the event to get the value of the parameter. E.g. payload.message"

fn valueFrom.withExpression

withExpression(expression)

"Expression, if defined, is evaluated to specify the value for the parameter"

fn valueFrom.withJqFilter

withJqFilter(jqFilter)

"JQFilter expression against the resource object in resource templates"

fn valueFrom.withJsonPath

withJsonPath(jsonPath)

"JSONPath of a resource to retrieve an output parameter value from in resource templates"

fn valueFrom.withParameter

withParameter(parameter)

"Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. '{{steps.mystep.outputs.myparam}}')"

fn valueFrom.withPath

withPath(path)

"Path in the container to retrieve an output parameter value from in container templates"

fn valueFrom.withSupplied

withSupplied(supplied)

"SuppliedValueFrom is a placeholder for a value to be filled in directly, either through the CLI, API, etc."

fn valueFrom.withSuppliedMixin

withSuppliedMixin(supplied)

"SuppliedValueFrom is a placeholder for a value to be filled in directly, either through the CLI, API, etc."

Note: This function appends passed data to existing values

obj valueFrom.configMapKeyRef

"Selects a key from a ConfigMap."

fn valueFrom.configMapKeyRef.withKey

withKey(key)

"The key to select."

fn valueFrom.configMapKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn valueFrom.configMapKeyRef.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"