FlyteIDL API Reference

The protocol buffers defined here provide a high level specification of various entities in Flyte control plane and data plane. It provides detailed definitions and documentation of all these entities.

• Flyte Core Language Specification
  • flyteidl/core/catalog.proto
  • flyteidl/core/compiler.proto
  • flyteidl/core/condition.proto
  • flyteidl/core/dynamic_job.proto
  • flyteidl/core/errors.proto
  • flyteidl/core/execution.proto
  • flyteidl/core/identifier.proto
  • flyteidl/core/interface.proto
  • flyteidl/core/literals.proto
  • flyteidl/core/security.proto
  • flyteidl/core/tasks.proto
  • flyteidl/core/types.proto
  • flyteidl/core/workflow.proto
  • flyteidl/core/workflow_closure.proto
  • google/protobuf/timestamp.proto
  • google/protobuf/duration.proto
  • google/protobuf/struct.proto
  • Scalar Value Types
• FlyteAdmin Service
  • flyteidl/admin/cluster_assignment.proto
  • flyteidl/admin/common.proto
  • flyteidl/admin/description_entity.proto
  • flyteidl/admin/event.proto
  • flyteidl/admin/execution.proto
  • flyteidl/admin/launch_plan.proto
  • flyteidl/admin/matchable_resource.proto
  • flyteidl/admin/node_execution.proto
  • flyteidl/admin/notification.proto
  • flyteidl/admin/project.proto
  • flyteidl/admin/project_attributes.proto
  • flyteidl/admin/project_domain_attributes.proto
  • flyteidl/admin/schedule.proto
  • flyteidl/admin/signal.proto
  • flyteidl/admin/task.proto
  • flyteidl/admin/task_execution.proto
  • flyteidl/admin/version.proto
  • flyteidl/admin/workflow.proto
  • flyteidl/admin/workflow_attributes.proto
  • google/protobuf/duration.proto
  • google/protobuf/wrappers.proto
• FlyteAdmin REST and gRPC Interface
  • flyteidl/service/admin.proto
  • flyteidl/service/auth.proto
  • flyteidl/service/dataproxy.proto
  • flyteidl/service/identity.proto
  • flyteidl/service/signal.proto
• Data Catalog Service
  • flyteidl/datacatalog/datacatalog.proto
  • google/protobuf/timestamp.proto
  • google/protobuf/duration.proto
  • google/protobuf/struct.proto
• Internal and External Eventing Interface
  • flyteidl/event/event.proto
  • google/protobuf/timestamp.proto
  • google/protobuf/duration.proto
  • google/protobuf/struct.proto
• Flyte Task Plugin Specification
  • flyteidl/plugins/array_job.proto
  • flyteidl/plugins/dask.proto
  • flyteidl/plugins/mpi.proto
  • flyteidl/plugins/presto.proto
  • flyteidl/plugins/pytorch.proto
  • flyteidl/plugins/qubole.proto
  • flyteidl/plugins/ray.proto
  • flyteidl/plugins/spark.proto
  • flyteidl/plugins/tensorflow.proto
  • flyteidl/plugins/waitable.proto
• Contributing Guide
  • Contributing to Flyteidl
  • Tooling for Flyteidl
  • Docs structure
  • Generating Documentation