types.proto

flyteidl.core.SchemaType

[flyteidl.core.SchemaType proto]

Defines schema columns and types to strongly type-validate schemas interoperability.

{
  "columns": []
}
columns

(flyteidl.core.SchemaType.SchemaColumn) A list of ordered columns this schema comprises of.

flyteidl.core.SchemaType.SchemaColumn

[flyteidl.core.SchemaType.SchemaColumn proto]

{
  "name": "...",
  "type": "..."
}
name

(string) A unique name -within the schema type- for the column

type

(flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType) The column type. This allows a limited set of types currently.

Enum flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType

[flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType proto]

INTEGER

(DEFAULT)

FLOAT

STRING

BOOLEAN

DATETIME

DURATION

flyteidl.core.BlobType

[flyteidl.core.BlobType proto]

Defines type behavior for blob objects

{
  "format": "...",
  "dimensionality": "..."
}
format

(string) Format can be a free form string understood by SDK/UI etc like csv, parquet etc

dimensionality

(flyteidl.core.BlobType.BlobDimensionality)

Enum flyteidl.core.BlobType.BlobDimensionality

[flyteidl.core.BlobType.BlobDimensionality proto]

SINGLE

(DEFAULT)

MULTIPART

flyteidl.core.LiteralType

[flyteidl.core.LiteralType proto]

Defines a strong type to allow type checking between interfaces.

{
  "simple": "...",
  "schema": "{...}",
  "collection_type": "{...}",
  "map_value_type": "{...}",
  "blob": "{...}",
  "metadata": "{...}"
}
simple

(flyteidl.core.SimpleType) A simple type that can be compared one-to-one with another.

Only one of simple, schema, collection_type, map_value_type, blob may be set.

schema

(flyteidl.core.SchemaType) A complex type that requires matching of inner fields.

Only one of simple, schema, collection_type, map_value_type, blob may be set.

collection_type

(flyteidl.core.LiteralType) Defines the type of the value of a collection. Only homogeneous collections are allowed.

Only one of simple, schema, collection_type, map_value_type, blob may be set.

map_value_type

(flyteidl.core.LiteralType) Defines the type of the value of a map type. The type of the key is always a string.

Only one of simple, schema, collection_type, map_value_type, blob may be set.

blob

(flyteidl.core.BlobType) A blob might have specialized implementation details depending on associated metadata.

Only one of simple, schema, collection_type, map_value_type, blob may be set.

metadata

(google.protobuf.Struct) This field contains type metadata that is descriptive of the type, but is NOT considered in type-checking. This might be used by consumers to identify special behavior or display extended information for the type.

flyteidl.core.OutputReference

[flyteidl.core.OutputReference proto]

A reference to an output produced by a node. The type can be retrieved -and validated- from the underlying interface of the node.

{
  "node_id": "...",
  "var": "..."
}
node_id

(string) Node id must exist at the graph layer.

var

(string) Variable name must refer to an output variable for the node.

flyteidl.core.Error

[flyteidl.core.Error proto]

Represents an error thrown from a node.

{
  "failed_node_id": "...",
  "message": "..."
}
failed_node_id

(string) The node id that threw the error.

message

(string) Error message thrown.

Enum flyteidl.core.SimpleType

[flyteidl.core.SimpleType proto]

Define a set of simple types.

NONE

(DEFAULT)

INTEGER

FLOAT

STRING

BOOLEAN

DATETIME

DURATION

BINARY

ERROR

STRUCT