literals.proto

flyteidl.core.Primitive

[flyteidl.core.Primitive proto]

Primitive Types

{
  "integer": "...",
  "float_value": "...",
  "string_value": "...",
  "boolean": "...",
  "datetime": "{...}",
  "duration": "{...}"
}
integer

(int64) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

float_value

(double) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

string_value

(string) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

boolean

(bool) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

datetime

(google.protobuf.Timestamp) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

duration

(google.protobuf.Duration) Defines one of simple primitive types. These types will get translated into different programming languages as described in https://developers.google.com/protocol-buffers/docs/proto#scalar.

Only one of integer, float_value, string_value, boolean, datetime, duration may be set.

flyteidl.core.Void

[flyteidl.core.Void proto]

Used to denote a nil/null/None assignment to a scalar value. The underlying LiteralType for Void is intentionally undefined since it can be assigned to a scalar of any LiteralType.

{}

flyteidl.core.Blob

[flyteidl.core.Blob proto]

Refers to an offloaded set of files. It encapsulates the type of the store and a unique uri for where the data is. There are no restrictions on how the uri is formatted since it will depend on how to interact with the store.

{
  "metadata": "{...}",
  "uri": "..."
}
metadata

(flyteidl.core.BlobMetadata)

uri

(string)

flyteidl.core.BlobMetadata

[flyteidl.core.BlobMetadata proto]

{
  "type": "{...}"
}
type

(flyteidl.core.BlobType)

flyteidl.core.Binary

[flyteidl.core.Binary proto]

A simple byte array with a tag to help different parts of the system communicate about what is in the byte array. It’s strongly advisable that consumers of this type define a unique tag and validate the tag before parsing the data.

{
  "value": "...",
  "tag": "..."
}
value

(bytes)

tag

(string)

flyteidl.core.Schema

[flyteidl.core.Schema proto]

A strongly typed schema that defines the interface of data retrieved from the underlying storage medium.

{
  "uri": "...",
  "type": "{...}"
}
uri

(string)

type

(flyteidl.core.SchemaType)

flyteidl.core.Scalar

[flyteidl.core.Scalar proto]

{
  "primitive": "{...}",
  "blob": "{...}",
  "binary": "{...}",
  "schema": "{...}",
  "none_type": "{...}",
  "error": "{...}",
  "generic": "{...}"
}
primitive

(flyteidl.core.Primitive)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

blob

(flyteidl.core.Blob)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

binary

(flyteidl.core.Binary)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

schema

(flyteidl.core.Schema)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

none_type

(flyteidl.core.Void)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

error

(flyteidl.core.Error)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

generic

(google.protobuf.Struct)

Only one of primitive, blob, binary, schema, none_type, error, generic may be set.

flyteidl.core.Literal

[flyteidl.core.Literal proto]

A simple value. This supports any level of nesting (e.g. array of array of array of Blobs) as well as simple primitives.

{
  "scalar": "{...}",
  "collection": "{...}",
  "map": "{...}"
}
scalar

(flyteidl.core.Scalar) A simple value.

Only one of scalar, collection, map may be set.

collection

(flyteidl.core.LiteralCollection) A collection of literals to allow nesting.

Only one of scalar, collection, map may be set.

map

(flyteidl.core.LiteralMap) A map of strings to literals.

Only one of scalar, collection, map may be set.

flyteidl.core.LiteralCollection

[flyteidl.core.LiteralCollection proto]

A collection of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field.

{
  "literals": []
}
literals

(flyteidl.core.Literal)

flyteidl.core.LiteralMap

[flyteidl.core.LiteralMap proto]

A map of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field.

{
  "literals": "{...}"
}
literals

(map<string, flyteidl.core.Literal>)

flyteidl.core.BindingDataCollection

[flyteidl.core.BindingDataCollection proto]

A collection of BindingData items.

{
  "bindings": []
}
bindings

(flyteidl.core.BindingData)

flyteidl.core.BindingDataMap

[flyteidl.core.BindingDataMap proto]

A map of BindingData items.

{
  "bindings": "{...}"
}
bindings

(map<string, flyteidl.core.BindingData>)

flyteidl.core.BindingData

[flyteidl.core.BindingData proto]

Specifies either a simple value or a reference to another output.

{
  "scalar": "{...}",
  "collection": "{...}",
  "promise": "{...}",
  "map": "{...}"
}
scalar

(flyteidl.core.Scalar) A simple scalar value.

Only one of scalar, collection, promise, map may be set.

collection

(flyteidl.core.BindingDataCollection) A collection of binding data. This allows nesting of binding data to any number of levels.

Only one of scalar, collection, promise, map may be set.

promise

(flyteidl.core.OutputReference) References an output promised by another node.

Only one of scalar, collection, promise, map may be set.

map

(flyteidl.core.BindingDataMap) A map of bindings. The key is always a string.

Only one of scalar, collection, promise, map may be set.

flyteidl.core.Binding

[flyteidl.core.Binding proto]

An input/output binding of a variable to either static value or a node output.

{
  "var": "...",
  "binding": "{...}"
}
var

(string) Variable name must match an input/output variable of the node.

binding

(flyteidl.core.BindingData) Data to use to bind this variable.

flyteidl.core.KeyValuePair

[flyteidl.core.KeyValuePair proto]

A generic key value pair.

{
  "key": "...",
  "value": "..."
}
key

(string) equired.

value

(string) optional.

flyteidl.core.RetryStrategy

[flyteidl.core.RetryStrategy proto]

Retry strategy associated with an executable unit.

{
  "retries": "..."
}
retries

(uint32) Number of retries. Retries will be consumed when the job fails with a recoverable error. The number of retries must be less than or equals to 10.