interface.proto

flyteidl.core.Variable

[flyteidl.core.Variable proto]

Defines a strongly typed variable.

{
  "type": "{...}",
  "description": "..."
}
type

(flyteidl.core.LiteralType) Variable literal type.

description

(string) optional string describing input variable

flyteidl.core.VariableMap

[flyteidl.core.VariableMap proto]

A map of Variables

{
  "variables": "{...}"
}
variables

(map<string, flyteidl.core.Variable>) Defines a map of variable names to variables.

flyteidl.core.TypedInterface

[flyteidl.core.TypedInterface proto]

Defines strongly typed inputs and outputs.

{
  "inputs": "{...}",
  "outputs": "{...}"
}
inputs

(flyteidl.core.VariableMap)

outputs

(flyteidl.core.VariableMap)

flyteidl.core.Parameter

[flyteidl.core.Parameter proto]

A parameter is used as input to a launch plan and has the special ability to have a default value or mark itself as required.

{
  "var": "{...}",
  "default": "{...}",
  "required": "..."
}
var

(flyteidl.core.Variable) required Variable. Defines the type of the variable backing this parameter.

default

(flyteidl.core.Literal) Defines a default value that has to match the variable type defined.

optional

Only one of default, required may be set.

required

(bool) optional, is this value required to be filled.

optional

Only one of default, required may be set.

flyteidl.core.ParameterMap

[flyteidl.core.ParameterMap proto]

A map of Parameters.

{
  "parameters": "{...}"
}
parameters

(map<string, flyteidl.core.Parameter>) Defines a map of parameter names to parameters.