# Reference This section provides the reference material for all Flyte APIs, SDKs and CLIs. To get started, add `flytekit` to your project ```shell $ uv add flytekit ``` This will install the Flytekit SDKs and the `pyflyte` CLI. ### [Flytekit SDK](https://www.union.ai/docs/v1/flyte/api-reference/flytekit-sdk/page.md) The Flytekit SDK provides the core Python API for building Flyte workflows. ### [Pyflyte CLI](https://www.union.ai/docs/v1/flyte/api-reference/pyflyte-cli/page.md) The Pyflyte CLI is the command-line interface for interacting with your Flyte instance. ### [Flytectl CLI](https://www.union.ai/docs/v1/flyte/api-reference/flytectl-cli/page.md) The Flytectl CLI is an alternative CLI for performing administrative tasks and for use in CI/CD environments. ### [Flyteidl](https://www.union.ai/docs/v1/flyte/api-reference/flyteidl/page.md) Flyteidl is the specification for the Flyte language in protobuf. ## Subpages - [LLM-optimized documentation](https://www.union.ai/docs/v1/flyte/api-reference/flyte-context/page.md) - Per-page Markdown (`page.md`) - Section bundles (`section.md`) - Page index (`llms.txt`) - Full documentation (`llms-full.txt`) - [Pyflyte CLI](https://www.union.ai/docs/v1/flyte/api-reference/pyflyte-cli/page.md) - Installation - Configure the `pyflyte` CLI - Overriding the configuration file location - `pyflyte` CLI configuration search path - `pyflyte` CLI commands - backfill - build - execution - fetch - get - info - init - launchplan - local-cache - metrics - package - register - run - serve - [Flytectl CLI](https://www.union.ai/docs/v1/flyte/api-reference/flytectl-cli/page.md) - Installation - macOS - Linux - Windows - Configuration - Configuration file location hierarchy - Options - Commands - Entities - [Flyteidl](https://www.union.ai/docs/v1/flyte/api-reference/flyteidl/page.md) - flyteidl/core/compiler.proto - CompiledLaunchPlan {#flyteidl-core-CompiledLaunchPlan} - CompiledTask {#flyteidl-core-CompiledTask} - CompiledWorkflow {#flyteidl-core-CompiledWorkflow} - CompiledWorkflowClosure {#flyteidl-core-CompiledWorkflowClosure} - ConnectionSet {#flyteidl-core-ConnectionSet} - ConnectionSet.DownstreamEntry {#flyteidl-core-ConnectionSet-DownstreamEntry} - ConnectionSet.IdList {#flyteidl-core-ConnectionSet-IdList} - ConnectionSet.UpstreamEntry {#flyteidl-core-ConnectionSet-UpstreamEntry} - flyteidl/core/interface.proto - Parameter {#flyteidl-core-Parameter} - ParameterMap {#flyteidl-core-ParameterMap} - ParameterMap.ParametersEntry {#flyteidl-core-ParameterMap-ParametersEntry} - TypedInterface {#flyteidl-core-TypedInterface} - Variable {#flyteidl-core-Variable} - VariableMap {#flyteidl-core-VariableMap} - VariableMap.VariablesEntry {#flyteidl-core-VariableMap-VariablesEntry} - flyteidl/core/catalog.proto - CatalogArtifactTag {#flyteidl-core-CatalogArtifactTag} - CatalogMetadata {#flyteidl-core-CatalogMetadata} - CatalogReservation {#flyteidl-core-CatalogReservation} - CatalogCacheStatus {#flyteidl-core-CatalogCacheStatus} - CatalogReservation.Status {#flyteidl-core-CatalogReservation-Status} - flyteidl/core/literals.proto - Binary {#flyteidl-core-Binary} - Binding {#flyteidl-core-Binding} - BindingData {#flyteidl-core-BindingData} - BindingDataCollection {#flyteidl-core-BindingDataCollection} - BindingDataMap {#flyteidl-core-BindingDataMap} - BindingDataMap.BindingsEntry {#flyteidl-core-BindingDataMap-BindingsEntry} - Blob {#flyteidl-core-Blob} - BlobMetadata {#flyteidl-core-BlobMetadata} - KeyValuePair {#flyteidl-core-KeyValuePair} - Literal {#flyteidl-core-Literal} - Literal.MetadataEntry {#flyteidl-core-Literal-MetadataEntry} - LiteralCollection {#flyteidl-core-LiteralCollection} - LiteralMap {#flyteidl-core-LiteralMap} - LiteralMap.LiteralsEntry {#flyteidl-core-LiteralMap-LiteralsEntry} - LiteralOffloadedMetadata {#flyteidl-core-LiteralOffloadedMetadata} - Primitive {#flyteidl-core-Primitive} - RetryStrategy {#flyteidl-core-RetryStrategy} - Scalar {#flyteidl-core-Scalar} - Schema {#flyteidl-core-Schema} - StructuredDataset {#flyteidl-core-StructuredDataset} - StructuredDatasetMetadata {#flyteidl-core-StructuredDatasetMetadata} - Union {#flyteidl-core-Union} - UnionInfo {#flyteidl-core-UnionInfo} - Void {#flyteidl-core-Void} - flyteidl/core/tasks.proto - Container {#flyteidl-core-Container} - ContainerPort {#flyteidl-core-ContainerPort} - DataLoadingConfig {#flyteidl-core-DataLoadingConfig} - ExtendedResources {#flyteidl-core-ExtendedResources} - GPUAccelerator {#flyteidl-core-GPUAccelerator} - IOStrategy {#flyteidl-core-IOStrategy} - K8sObjectMetadata {#flyteidl-core-K8sObjectMetadata} - K8sObjectMetadata.AnnotationsEntry {#flyteidl-core-K8sObjectMetadata-AnnotationsEntry} - K8sObjectMetadata.LabelsEntry {#flyteidl-core-K8sObjectMetadata-LabelsEntry} - K8sPod {#flyteidl-core-K8sPod} - Resources {#flyteidl-core-Resources} - Resources.ResourceEntry {#flyteidl-core-Resources-ResourceEntry} - RuntimeMetadata {#flyteidl-core-RuntimeMetadata} - SharedMemory {#flyteidl-core-SharedMemory} - Sql {#flyteidl-core-Sql} - TaskMetadata {#flyteidl-core-TaskMetadata} - TaskMetadata.TagsEntry {#flyteidl-core-TaskMetadata-TagsEntry} - TaskTemplate {#flyteidl-core-TaskTemplate} - TaskTemplate.ConfigEntry {#flyteidl-core-TaskTemplate-ConfigEntry} - Container.Architecture {#flyteidl-core-Container-Architecture} - DataLoadingConfig.LiteralMapFormat {#flyteidl-core-DataLoadingConfig-LiteralMapFormat} - IOStrategy.DownloadMode {#flyteidl-core-IOStrategy-DownloadMode} - IOStrategy.UploadMode {#flyteidl-core-IOStrategy-UploadMode} - Resources.ResourceName {#flyteidl-core-Resources-ResourceName} - RuntimeMetadata.RuntimeType {#flyteidl-core-RuntimeMetadata-RuntimeType} - Sql.Dialect {#flyteidl-core-Sql-Dialect} - flyteidl/core/metrics.proto - ExecutionMetricResult {#flyteidl-core-ExecutionMetricResult} - Span {#flyteidl-core-Span} - flyteidl/core/errors.proto - ContainerError {#flyteidl-core-ContainerError} - ErrorDocument {#flyteidl-core-ErrorDocument} - ContainerError.Kind {#flyteidl-core-ContainerError-Kind} - flyteidl/core/identifier.proto - Identifier {#flyteidl-core-Identifier} - NodeExecutionIdentifier {#flyteidl-core-NodeExecutionIdentifier} - SignalIdentifier {#flyteidl-core-SignalIdentifier} - TaskExecutionIdentifier {#flyteidl-core-TaskExecutionIdentifier} - WorkflowExecutionIdentifier {#flyteidl-core-WorkflowExecutionIdentifier} - ResourceType {#flyteidl-core-ResourceType} - flyteidl/core/artifact_id.proto - ArtifactBindingData {#flyteidl-core-ArtifactBindingData} - ArtifactID {#flyteidl-core-ArtifactID} - ArtifactKey {#flyteidl-core-ArtifactKey} - ArtifactQuery {#flyteidl-core-ArtifactQuery} - ArtifactTag {#flyteidl-core-ArtifactTag} - InputBindingData {#flyteidl-core-InputBindingData} - LabelValue {#flyteidl-core-LabelValue} - Partitions {#flyteidl-core-Partitions} - Partitions.ValueEntry {#flyteidl-core-Partitions-ValueEntry} - RuntimeBinding {#flyteidl-core-RuntimeBinding} - TimePartition {#flyteidl-core-TimePartition} - TimeTransform {#flyteidl-core-TimeTransform} - Granularity {#flyteidl-core-Granularity} - Operator {#flyteidl-core-Operator} - flyteidl/core/types.proto - BlobType {#flyteidl-core-BlobType} - EnumType {#flyteidl-core-EnumType} - Error {#flyteidl-core-Error} - LiteralType {#flyteidl-core-LiteralType} - OutputReference {#flyteidl-core-OutputReference} - PromiseAttribute {#flyteidl-core-PromiseAttribute} - SchemaType {#flyteidl-core-SchemaType} - SchemaType.SchemaColumn {#flyteidl-core-SchemaType-SchemaColumn} - StructuredDatasetType {#flyteidl-core-StructuredDatasetType} - StructuredDatasetType.DatasetColumn {#flyteidl-core-StructuredDatasetType-DatasetColumn} - TypeAnnotation {#flyteidl-core-TypeAnnotation} - TypeStructure {#flyteidl-core-TypeStructure} - TypeStructure.DataclassTypeEntry {#flyteidl-core-TypeStructure-DataclassTypeEntry} - UnionType {#flyteidl-core-UnionType} - BlobType.BlobDimensionality {#flyteidl-core-BlobType-BlobDimensionality} - SchemaType.SchemaColumn.SchemaColumnType {#flyteidl-core-SchemaType-SchemaColumn-SchemaColumnType} - SimpleType {#flyteidl-core-SimpleType} - flyteidl/core/execution_envs.proto - ExecutionEnv {#flyteidl-core-ExecutionEnv} - ExecutionEnvAssignment {#flyteidl-core-ExecutionEnvAssignment} - flyteidl/core/execution.proto - ExecutionError {#flyteidl-core-ExecutionError} - NodeExecution {#flyteidl-core-NodeExecution} - QualityOfService {#flyteidl-core-QualityOfService} - QualityOfServiceSpec {#flyteidl-core-QualityOfServiceSpec} - TaskExecution {#flyteidl-core-TaskExecution} - TaskLog {#flyteidl-core-TaskLog} - WorkflowExecution {#flyteidl-core-WorkflowExecution} - ExecutionError.ErrorKind {#flyteidl-core-ExecutionError-ErrorKind} - NodeExecution.Phase {#flyteidl-core-NodeExecution-Phase} - QualityOfService.Tier {#flyteidl-core-QualityOfService-Tier} - TaskExecution.Phase {#flyteidl-core-TaskExecution-Phase} - TaskLog.MessageFormat {#flyteidl-core-TaskLog-MessageFormat} - WorkflowExecution.Phase {#flyteidl-core-WorkflowExecution-Phase} - flyteidl/core/security.proto - Identity {#flyteidl-core-Identity} - OAuth2Client {#flyteidl-core-OAuth2Client} - OAuth2TokenRequest {#flyteidl-core-OAuth2TokenRequest} - Secret {#flyteidl-core-Secret} - SecurityContext {#flyteidl-core-SecurityContext} - OAuth2TokenRequest.Type {#flyteidl-core-OAuth2TokenRequest-Type} - Secret.MountType {#flyteidl-core-Secret-MountType} - flyteidl/core/workflow.proto - Alias {#flyteidl-core-Alias} - ApproveCondition {#flyteidl-core-ApproveCondition} - ArrayNode {#flyteidl-core-ArrayNode} - BranchNode {#flyteidl-core-BranchNode} - GateNode {#flyteidl-core-GateNode} - IfBlock {#flyteidl-core-IfBlock} - IfElseBlock {#flyteidl-core-IfElseBlock} - LaunchPlanTemplate {#flyteidl-core-LaunchPlanTemplate} - Node {#flyteidl-core-Node} - NodeMetadata {#flyteidl-core-NodeMetadata} - NodeMetadata.ConfigEntry {#flyteidl-core-NodeMetadata-ConfigEntry} - SignalCondition {#flyteidl-core-SignalCondition} - SleepCondition {#flyteidl-core-SleepCondition} - TaskNode {#flyteidl-core-TaskNode} - TaskNodeOverrides {#flyteidl-core-TaskNodeOverrides} - WorkflowMetadata {#flyteidl-core-WorkflowMetadata} - WorkflowMetadata.TagsEntry {#flyteidl-core-WorkflowMetadata-TagsEntry} - WorkflowMetadataDefaults {#flyteidl-core-WorkflowMetadataDefaults} - WorkflowNode {#flyteidl-core-WorkflowNode} - WorkflowTemplate {#flyteidl-core-WorkflowTemplate} - ArrayNode.DataMode {#flyteidl-core-ArrayNode-DataMode} - ArrayNode.ExecutionMode {#flyteidl-core-ArrayNode-ExecutionMode} - WorkflowMetadata.OnFailurePolicy {#flyteidl-core-WorkflowMetadata-OnFailurePolicy} - flyteidl/core/workflow_closure.proto - WorkflowClosure {#flyteidl-core-WorkflowClosure} - flyteidl/core/condition.proto - BooleanExpression {#flyteidl-core-BooleanExpression} - ComparisonExpression {#flyteidl-core-ComparisonExpression} - ConjunctionExpression {#flyteidl-core-ConjunctionExpression} - Operand {#flyteidl-core-Operand} - ComparisonExpression.Operator {#flyteidl-core-ComparisonExpression-Operator} - ConjunctionExpression.LogicalOperator {#flyteidl-core-ConjunctionExpression-LogicalOperator} - flyteidl/core/dynamic_job.proto - DynamicJobSpec {#flyteidl-core-DynamicJobSpec} - flyteidl/plugins/presto.proto - PrestoQuery {#flyteidl-plugins-PrestoQuery} - flyteidl/plugins/qubole.proto - HiveQuery {#flyteidl-plugins-HiveQuery} - HiveQueryCollection {#flyteidl-plugins-HiveQueryCollection} - QuboleHiveJob {#flyteidl-plugins-QuboleHiveJob} - flyteidl/plugins/ray.proto - HeadGroupSpec {#flyteidl-plugins-HeadGroupSpec} - HeadGroupSpec.RayStartParamsEntry {#flyteidl-plugins-HeadGroupSpec-RayStartParamsEntry} - RayCluster {#flyteidl-plugins-RayCluster} - RayJob {#flyteidl-plugins-RayJob} - WorkerGroupSpec {#flyteidl-plugins-WorkerGroupSpec} - WorkerGroupSpec.RayStartParamsEntry {#flyteidl-plugins-WorkerGroupSpec-RayStartParamsEntry} - flyteidl/plugins/spark.proto - SparkApplication {#flyteidl-plugins-SparkApplication} - SparkJob {#flyteidl-plugins-SparkJob} - SparkJob.HadoopConfEntry {#flyteidl-plugins-SparkJob-HadoopConfEntry} - SparkJob.SparkConfEntry {#flyteidl-plugins-SparkJob-SparkConfEntry} - SparkApplication.Type {#flyteidl-plugins-SparkApplication-Type} - flyteidl/plugins/array_job.proto - ArrayJob {#flyteidl-plugins-ArrayJob} - flyteidl/plugins/waitable.proto - Waitable {#flyteidl-plugins-Waitable} - flyteidl/plugins/dask.proto - DaskJob {#flyteidl-plugins-DaskJob} - DaskScheduler {#flyteidl-plugins-DaskScheduler} - DaskWorkerGroup {#flyteidl-plugins-DaskWorkerGroup} - flyteidl/plugins/mpi.proto - DistributedMPITrainingTask {#flyteidl-plugins-DistributedMPITrainingTask} - flyteidl/plugins/pytorch.proto - DistributedPyTorchTrainingTask {#flyteidl-plugins-DistributedPyTorchTrainingTask} - ElasticConfig {#flyteidl-plugins-ElasticConfig} - flyteidl/plugins/kubeflow/mpi.proto - DistributedMPITrainingReplicaSpec {#flyteidl-plugins-kubeflow-DistributedMPITrainingReplicaSpec} - DistributedMPITrainingTask {#flyteidl-plugins-kubeflow-DistributedMPITrainingTask} - flyteidl/plugins/kubeflow/pytorch.proto - DistributedPyTorchTrainingReplicaSpec {#flyteidl-plugins-kubeflow-DistributedPyTorchTrainingReplicaSpec} - DistributedPyTorchTrainingTask {#flyteidl-plugins-kubeflow-DistributedPyTorchTrainingTask} - ElasticConfig {#flyteidl-plugins-kubeflow-ElasticConfig} - flyteidl/plugins/kubeflow/tensorflow.proto - DistributedTensorflowTrainingReplicaSpec {#flyteidl-plugins-kubeflow-DistributedTensorflowTrainingReplicaSpec} - DistributedTensorflowTrainingTask {#flyteidl-plugins-kubeflow-DistributedTensorflowTrainingTask} - flyteidl/plugins/kubeflow/common.proto - RunPolicy {#flyteidl-plugins-kubeflow-RunPolicy} - CleanPodPolicy {#flyteidl-plugins-kubeflow-CleanPodPolicy} - flyteidl/plugins/tensorflow.proto - DistributedTensorflowTrainingTask {#flyteidl-plugins-DistributedTensorflowTrainingTask} - flyteidl/plugins/common.proto - CommonReplicaSpec {#flyteidl-plugins-CommonReplicaSpec} - RestartPolicy {#flyteidl-plugins-RestartPolicy} - flyteidl/admin/schedule.proto - CronSchedule {#flyteidl-admin-CronSchedule} - FixedRate {#flyteidl-admin-FixedRate} - Schedule {#flyteidl-admin-Schedule} - FixedRateUnit {#flyteidl-admin-FixedRateUnit} - flyteidl/admin/project.proto - Domain {#flyteidl-admin-Domain} - GetDomainRequest {#flyteidl-admin-GetDomainRequest} - GetDomainsResponse {#flyteidl-admin-GetDomainsResponse} - InactiveProject {#flyteidl-admin-InactiveProject} - Project {#flyteidl-admin-Project} - ProjectGetRequest {#flyteidl-admin-ProjectGetRequest} - ProjectListRequest {#flyteidl-admin-ProjectListRequest} - ProjectRegisterRequest {#flyteidl-admin-ProjectRegisterRequest} - ProjectRegisterResponse {#flyteidl-admin-ProjectRegisterResponse} - ProjectUpdateResponse {#flyteidl-admin-ProjectUpdateResponse} - Projects {#flyteidl-admin-Projects} - Project.ProjectState {#flyteidl-admin-Project-ProjectState} - flyteidl/admin/cluster_assignment.proto - ClusterAssignment {#flyteidl-admin-ClusterAssignment} - flyteidl/admin/notification.proto - EmailMessage {#flyteidl-admin-EmailMessage} - flyteidl/admin/task.proto - Task {#flyteidl-admin-Task} - TaskClosure {#flyteidl-admin-TaskClosure} - TaskCreateRequest {#flyteidl-admin-TaskCreateRequest} - TaskCreateResponse {#flyteidl-admin-TaskCreateResponse} - TaskList {#flyteidl-admin-TaskList} - TaskSpec {#flyteidl-admin-TaskSpec} - flyteidl/admin/launch_plan.proto - ActiveLaunchPlanListRequest {#flyteidl-admin-ActiveLaunchPlanListRequest} - ActiveLaunchPlanRequest {#flyteidl-admin-ActiveLaunchPlanRequest} - Auth {#flyteidl-admin-Auth} - LaunchPlan {#flyteidl-admin-LaunchPlan} - LaunchPlanClosure {#flyteidl-admin-LaunchPlanClosure} - LaunchPlanCreateRequest {#flyteidl-admin-LaunchPlanCreateRequest} - LaunchPlanCreateResponse {#flyteidl-admin-LaunchPlanCreateResponse} - LaunchPlanList {#flyteidl-admin-LaunchPlanList} - LaunchPlanMetadata {#flyteidl-admin-LaunchPlanMetadata} - LaunchPlanSpec {#flyteidl-admin-LaunchPlanSpec} - LaunchPlanUpdateRequest {#flyteidl-admin-LaunchPlanUpdateRequest} - LaunchPlanUpdateResponse {#flyteidl-admin-LaunchPlanUpdateResponse} - LaunchPlanState {#flyteidl-admin-LaunchPlanState} - flyteidl/admin/signal.proto - Signal {#flyteidl-admin-Signal} - SignalGetOrCreateRequest {#flyteidl-admin-SignalGetOrCreateRequest} - SignalList {#flyteidl-admin-SignalList} - SignalListRequest {#flyteidl-admin-SignalListRequest} - SignalSetRequest {#flyteidl-admin-SignalSetRequest} - SignalSetResponse {#flyteidl-admin-SignalSetResponse} - flyteidl/admin/task_execution.proto - Reason {#flyteidl-admin-Reason} - TaskExecution {#flyteidl-admin-TaskExecution} - TaskExecutionClosure {#flyteidl-admin-TaskExecutionClosure} - TaskExecutionGetDataRequest {#flyteidl-admin-TaskExecutionGetDataRequest} - TaskExecutionGetDataResponse {#flyteidl-admin-TaskExecutionGetDataResponse} - TaskExecutionGetRequest {#flyteidl-admin-TaskExecutionGetRequest} - TaskExecutionList {#flyteidl-admin-TaskExecutionList} - TaskExecutionListRequest {#flyteidl-admin-TaskExecutionListRequest} - flyteidl/admin/node_execution.proto - DynamicNodeWorkflowResponse {#flyteidl-admin-DynamicNodeWorkflowResponse} - DynamicWorkflowNodeMetadata {#flyteidl-admin-DynamicWorkflowNodeMetadata} - GetDynamicNodeWorkflowRequest {#flyteidl-admin-GetDynamicNodeWorkflowRequest} - NodeExecution {#flyteidl-admin-NodeExecution} - NodeExecutionClosure {#flyteidl-admin-NodeExecutionClosure} - NodeExecutionForTaskListRequest {#flyteidl-admin-NodeExecutionForTaskListRequest} - NodeExecutionGetDataRequest {#flyteidl-admin-NodeExecutionGetDataRequest} - NodeExecutionGetDataResponse {#flyteidl-admin-NodeExecutionGetDataResponse} - NodeExecutionGetRequest {#flyteidl-admin-NodeExecutionGetRequest} - NodeExecutionList {#flyteidl-admin-NodeExecutionList} - NodeExecutionListRequest {#flyteidl-admin-NodeExecutionListRequest} - NodeExecutionMetaData {#flyteidl-admin-NodeExecutionMetaData} - TaskNodeMetadata {#flyteidl-admin-TaskNodeMetadata} - WorkflowNodeMetadata {#flyteidl-admin-WorkflowNodeMetadata} - flyteidl/admin/execution.proto - AbortMetadata {#flyteidl-admin-AbortMetadata} - Execution {#flyteidl-admin-Execution} - ExecutionClosure {#flyteidl-admin-ExecutionClosure} - ExecutionCreateRequest {#flyteidl-admin-ExecutionCreateRequest} - ExecutionCreateResponse {#flyteidl-admin-ExecutionCreateResponse} - ExecutionList {#flyteidl-admin-ExecutionList} - ExecutionMetadata {#flyteidl-admin-ExecutionMetadata} - ExecutionRecoverRequest {#flyteidl-admin-ExecutionRecoverRequest} - ExecutionRelaunchRequest {#flyteidl-admin-ExecutionRelaunchRequest} - ExecutionSpec {#flyteidl-admin-ExecutionSpec} - ExecutionStateChangeDetails {#flyteidl-admin-ExecutionStateChangeDetails} - ExecutionTerminateRequest {#flyteidl-admin-ExecutionTerminateRequest} - ExecutionTerminateResponse {#flyteidl-admin-ExecutionTerminateResponse} - ExecutionUpdateRequest {#flyteidl-admin-ExecutionUpdateRequest} - ExecutionUpdateResponse {#flyteidl-admin-ExecutionUpdateResponse} - LiteralMapBlob {#flyteidl-admin-LiteralMapBlob} - NotificationList {#flyteidl-admin-NotificationList} - SystemMetadata {#flyteidl-admin-SystemMetadata} - WorkflowExecutionGetDataRequest {#flyteidl-admin-WorkflowExecutionGetDataRequest} - WorkflowExecutionGetDataResponse {#flyteidl-admin-WorkflowExecutionGetDataResponse} - WorkflowExecutionGetMetricsRequest {#flyteidl-admin-WorkflowExecutionGetMetricsRequest} - WorkflowExecutionGetMetricsResponse {#flyteidl-admin-WorkflowExecutionGetMetricsResponse} - WorkflowExecutionGetRequest {#flyteidl-admin-WorkflowExecutionGetRequest} - ExecutionMetadata.ExecutionMode {#flyteidl-admin-ExecutionMetadata-ExecutionMode} - ExecutionState {#flyteidl-admin-ExecutionState} - flyteidl/admin/workflow_attributes.proto - WorkflowAttributes {#flyteidl-admin-WorkflowAttributes} - WorkflowAttributesDeleteRequest {#flyteidl-admin-WorkflowAttributesDeleteRequest} - WorkflowAttributesDeleteResponse {#flyteidl-admin-WorkflowAttributesDeleteResponse} - WorkflowAttributesGetRequest {#flyteidl-admin-WorkflowAttributesGetRequest} - WorkflowAttributesGetResponse {#flyteidl-admin-WorkflowAttributesGetResponse} - WorkflowAttributesUpdateRequest {#flyteidl-admin-WorkflowAttributesUpdateRequest} - WorkflowAttributesUpdateResponse {#flyteidl-admin-WorkflowAttributesUpdateResponse} - flyteidl/admin/event.proto - EventErrorAlreadyInTerminalState {#flyteidl-admin-EventErrorAlreadyInTerminalState} - EventErrorIncompatibleCluster {#flyteidl-admin-EventErrorIncompatibleCluster} - EventFailureReason {#flyteidl-admin-EventFailureReason} - NodeExecutionEventRequest {#flyteidl-admin-NodeExecutionEventRequest} - NodeExecutionEventResponse {#flyteidl-admin-NodeExecutionEventResponse} - TaskExecutionEventRequest {#flyteidl-admin-TaskExecutionEventRequest} - TaskExecutionEventResponse {#flyteidl-admin-TaskExecutionEventResponse} - WorkflowExecutionEventRequest {#flyteidl-admin-WorkflowExecutionEventRequest} - WorkflowExecutionEventResponse {#flyteidl-admin-WorkflowExecutionEventResponse} - flyteidl/admin/matchable_resource.proto - ClusterResourceAttributes {#flyteidl-admin-ClusterResourceAttributes} - ClusterResourceAttributes.AttributesEntry {#flyteidl-admin-ClusterResourceAttributes-AttributesEntry} - ExecutionClusterLabel {#flyteidl-admin-ExecutionClusterLabel} - ExecutionQueueAttributes {#flyteidl-admin-ExecutionQueueAttributes} - ListMatchableAttributesRequest {#flyteidl-admin-ListMatchableAttributesRequest} - ListMatchableAttributesResponse {#flyteidl-admin-ListMatchableAttributesResponse} - MatchableAttributesConfiguration {#flyteidl-admin-MatchableAttributesConfiguration} - MatchingAttributes {#flyteidl-admin-MatchingAttributes} - PluginOverride {#flyteidl-admin-PluginOverride} - PluginOverrides {#flyteidl-admin-PluginOverrides} - TaskResourceAttributes {#flyteidl-admin-TaskResourceAttributes} - TaskResourceSpec {#flyteidl-admin-TaskResourceSpec} - WorkflowExecutionConfig {#flyteidl-admin-WorkflowExecutionConfig} - MatchableResource {#flyteidl-admin-MatchableResource} - PluginOverride.MissingPluginBehavior {#flyteidl-admin-PluginOverride-MissingPluginBehavior} - flyteidl/admin/project_attributes.proto - ProjectAttributes {#flyteidl-admin-ProjectAttributes} - ProjectAttributesDeleteRequest {#flyteidl-admin-ProjectAttributesDeleteRequest} - ProjectAttributesDeleteResponse {#flyteidl-admin-ProjectAttributesDeleteResponse} - ProjectAttributesGetRequest {#flyteidl-admin-ProjectAttributesGetRequest} - ProjectAttributesGetResponse {#flyteidl-admin-ProjectAttributesGetResponse} - ProjectAttributesUpdateRequest {#flyteidl-admin-ProjectAttributesUpdateRequest} - ProjectAttributesUpdateResponse {#flyteidl-admin-ProjectAttributesUpdateResponse} - flyteidl/admin/version.proto - GetVersionRequest {#flyteidl-admin-GetVersionRequest} - GetVersionResponse {#flyteidl-admin-GetVersionResponse} - Version {#flyteidl-admin-Version} - flyteidl/admin/workflow.proto - CreateWorkflowFailureReason {#flyteidl-admin-CreateWorkflowFailureReason} - Workflow {#flyteidl-admin-Workflow} - WorkflowClosure {#flyteidl-admin-WorkflowClosure} - WorkflowCreateRequest {#flyteidl-admin-WorkflowCreateRequest} - WorkflowCreateResponse {#flyteidl-admin-WorkflowCreateResponse} - WorkflowErrorExistsDifferentStructure {#flyteidl-admin-WorkflowErrorExistsDifferentStructure} - WorkflowErrorExistsIdenticalStructure {#flyteidl-admin-WorkflowErrorExistsIdenticalStructure} - WorkflowList {#flyteidl-admin-WorkflowList} - WorkflowSpec {#flyteidl-admin-WorkflowSpec} - flyteidl/admin/description_entity.proto - Description {#flyteidl-admin-Description} - DescriptionEntity {#flyteidl-admin-DescriptionEntity} - DescriptionEntityList {#flyteidl-admin-DescriptionEntityList} - DescriptionEntityListRequest {#flyteidl-admin-DescriptionEntityListRequest} - SourceCode {#flyteidl-admin-SourceCode} - DescriptionFormat {#flyteidl-admin-DescriptionFormat} - flyteidl/admin/project_domain_attributes.proto - ProjectDomainAttributes {#flyteidl-admin-ProjectDomainAttributes} - ProjectDomainAttributesDeleteRequest {#flyteidl-admin-ProjectDomainAttributesDeleteRequest} - ProjectDomainAttributesDeleteResponse {#flyteidl-admin-ProjectDomainAttributesDeleteResponse} - ProjectDomainAttributesGetRequest {#flyteidl-admin-ProjectDomainAttributesGetRequest} - ProjectDomainAttributesGetResponse {#flyteidl-admin-ProjectDomainAttributesGetResponse} - ProjectDomainAttributesUpdateRequest {#flyteidl-admin-ProjectDomainAttributesUpdateRequest} - ProjectDomainAttributesUpdateResponse {#flyteidl-admin-ProjectDomainAttributesUpdateResponse} - flyteidl/admin/agent.proto - Agent {#flyteidl-admin-Agent} - AgentError {#flyteidl-admin-AgentError} - CreateRequestHeader {#flyteidl-admin-CreateRequestHeader} - CreateTaskRequest {#flyteidl-admin-CreateTaskRequest} - CreateTaskResponse {#flyteidl-admin-CreateTaskResponse} - DeleteTaskRequest {#flyteidl-admin-DeleteTaskRequest} - DeleteTaskResponse {#flyteidl-admin-DeleteTaskResponse} - ExecuteTaskSyncRequest {#flyteidl-admin-ExecuteTaskSyncRequest} - ExecuteTaskSyncResponse {#flyteidl-admin-ExecuteTaskSyncResponse} - ExecuteTaskSyncResponseHeader {#flyteidl-admin-ExecuteTaskSyncResponseHeader} - GetAgentRequest {#flyteidl-admin-GetAgentRequest} - GetAgentResponse {#flyteidl-admin-GetAgentResponse} - GetTaskLogsRequest {#flyteidl-admin-GetTaskLogsRequest} - GetTaskLogsResponse {#flyteidl-admin-GetTaskLogsResponse} - GetTaskLogsResponseBody {#flyteidl-admin-GetTaskLogsResponseBody} - GetTaskLogsResponseHeader {#flyteidl-admin-GetTaskLogsResponseHeader} - GetTaskMetricsRequest {#flyteidl-admin-GetTaskMetricsRequest} - GetTaskMetricsResponse {#flyteidl-admin-GetTaskMetricsResponse} - GetTaskRequest {#flyteidl-admin-GetTaskRequest} - GetTaskResponse {#flyteidl-admin-GetTaskResponse} - ListAgentsRequest {#flyteidl-admin-ListAgentsRequest} - ListAgentsResponse {#flyteidl-admin-ListAgentsResponse} - LogLine {#flyteidl-admin-LogLine} - Resource {#flyteidl-admin-Resource} - TaskCategory {#flyteidl-admin-TaskCategory} - TaskExecutionMetadata {#flyteidl-admin-TaskExecutionMetadata} - TaskExecutionMetadata.AnnotationsEntry {#flyteidl-admin-TaskExecutionMetadata-AnnotationsEntry} - TaskExecutionMetadata.EnvironmentVariablesEntry {#flyteidl-admin-TaskExecutionMetadata-EnvironmentVariablesEntry} - TaskExecutionMetadata.LabelsEntry {#flyteidl-admin-TaskExecutionMetadata-LabelsEntry} - AgentError.Kind {#flyteidl-admin-AgentError-Kind} - LogLineOriginator {#flyteidl-admin-LogLineOriginator} - State {#flyteidl-admin-State} - flyteidl/admin/common.proto - Annotations {#flyteidl-admin-Annotations} - Annotations.ValuesEntry {#flyteidl-admin-Annotations-ValuesEntry} - AuthRole {#flyteidl-admin-AuthRole} - EmailNotification {#flyteidl-admin-EmailNotification} - Envs {#flyteidl-admin-Envs} - FlyteURLs {#flyteidl-admin-FlyteURLs} - Labels {#flyteidl-admin-Labels} - Labels.ValuesEntry {#flyteidl-admin-Labels-ValuesEntry} - NamedEntity {#flyteidl-admin-NamedEntity} - NamedEntityGetRequest {#flyteidl-admin-NamedEntityGetRequest} - NamedEntityIdentifier {#flyteidl-admin-NamedEntityIdentifier} - NamedEntityIdentifierList {#flyteidl-admin-NamedEntityIdentifierList} - NamedEntityIdentifierListRequest {#flyteidl-admin-NamedEntityIdentifierListRequest} - NamedEntityList {#flyteidl-admin-NamedEntityList} - NamedEntityListRequest {#flyteidl-admin-NamedEntityListRequest} - NamedEntityMetadata {#flyteidl-admin-NamedEntityMetadata} - NamedEntityUpdateRequest {#flyteidl-admin-NamedEntityUpdateRequest} - NamedEntityUpdateResponse {#flyteidl-admin-NamedEntityUpdateResponse} - Notification {#flyteidl-admin-Notification} - ObjectGetRequest {#flyteidl-admin-ObjectGetRequest} - PagerDutyNotification {#flyteidl-admin-PagerDutyNotification} - RawOutputDataConfig {#flyteidl-admin-RawOutputDataConfig} - ResourceListRequest {#flyteidl-admin-ResourceListRequest} - SlackNotification {#flyteidl-admin-SlackNotification} - Sort {#flyteidl-admin-Sort} - UrlBlob {#flyteidl-admin-UrlBlob} - NamedEntityState {#flyteidl-admin-NamedEntityState} - Sort.Direction {#flyteidl-admin-Sort-Direction} - flyteidl/cacheservice/cacheservice.proto - CachedOutput {#flyteidl-cacheservice-CachedOutput} - DeleteCacheRequest {#flyteidl-cacheservice-DeleteCacheRequest} - DeleteCacheResponse {#flyteidl-cacheservice-DeleteCacheResponse} - GetCacheRequest {#flyteidl-cacheservice-GetCacheRequest} - GetCacheResponse {#flyteidl-cacheservice-GetCacheResponse} - GetOrExtendReservationRequest {#flyteidl-cacheservice-GetOrExtendReservationRequest} - GetOrExtendReservationResponse {#flyteidl-cacheservice-GetOrExtendReservationResponse} - KeyMapMetadata {#flyteidl-cacheservice-KeyMapMetadata} - KeyMapMetadata.ValuesEntry {#flyteidl-cacheservice-KeyMapMetadata-ValuesEntry} - Metadata {#flyteidl-cacheservice-Metadata} - PutCacheRequest {#flyteidl-cacheservice-PutCacheRequest} - PutCacheResponse {#flyteidl-cacheservice-PutCacheResponse} - ReleaseReservationRequest {#flyteidl-cacheservice-ReleaseReservationRequest} - ReleaseReservationResponse {#flyteidl-cacheservice-ReleaseReservationResponse} - Reservation {#flyteidl-cacheservice-Reservation} - CacheService {#flyteidl-cacheservice-CacheService} - flyteidl/service/signal.proto - SignalService {#flyteidl-service-SignalService} - flyteidl/service/external_plugin_service.proto - TaskCreateRequest {#flyteidl-service-TaskCreateRequest} - TaskCreateResponse {#flyteidl-service-TaskCreateResponse} - TaskDeleteRequest {#flyteidl-service-TaskDeleteRequest} - TaskDeleteResponse {#flyteidl-service-TaskDeleteResponse} - TaskGetRequest {#flyteidl-service-TaskGetRequest} - TaskGetResponse {#flyteidl-service-TaskGetResponse} - State {#flyteidl-service-State} - ExternalPluginService {#flyteidl-service-ExternalPluginService} - flyteidl/service/dataproxy.proto - CreateDownloadLinkRequest {#flyteidl-service-CreateDownloadLinkRequest} - CreateDownloadLinkResponse {#flyteidl-service-CreateDownloadLinkResponse} - CreateDownloadLocationRequest {#flyteidl-service-CreateDownloadLocationRequest} - CreateDownloadLocationResponse {#flyteidl-service-CreateDownloadLocationResponse} - CreateUploadLocationRequest {#flyteidl-service-CreateUploadLocationRequest} - CreateUploadLocationResponse {#flyteidl-service-CreateUploadLocationResponse} - CreateUploadLocationResponse.HeadersEntry {#flyteidl-service-CreateUploadLocationResponse-HeadersEntry} - GetDataRequest {#flyteidl-service-GetDataRequest} - GetDataResponse {#flyteidl-service-GetDataResponse} - PreSignedURLs {#flyteidl-service-PreSignedURLs} - ArtifactType {#flyteidl-service-ArtifactType} - DataProxyService {#flyteidl-service-DataProxyService} - flyteidl/service/identity.proto - UserInfoRequest {#flyteidl-service-UserInfoRequest} - UserInfoResponse {#flyteidl-service-UserInfoResponse} - IdentityService {#flyteidl-service-IdentityService} - flyteidl/service/auth.proto - OAuth2MetadataRequest {#flyteidl-service-OAuth2MetadataRequest} - OAuth2MetadataResponse {#flyteidl-service-OAuth2MetadataResponse} - PublicClientAuthConfigRequest {#flyteidl-service-PublicClientAuthConfigRequest} - PublicClientAuthConfigResponse {#flyteidl-service-PublicClientAuthConfigResponse} - AuthMetadataService {#flyteidl-service-AuthMetadataService} - flyteidl/service/agent.proto - AgentMetadataService {#flyteidl-service-AgentMetadataService} - AsyncAgentService {#flyteidl-service-AsyncAgentService} - SyncAgentService {#flyteidl-service-SyncAgentService} - flyteidl/service/admin.proto - AdminService {#flyteidl-service-AdminService} - flyteidl/event/cloudevents.proto - CloudEventExecutionStart {#flyteidl-event-CloudEventExecutionStart} - CloudEventNodeExecution {#flyteidl-event-CloudEventNodeExecution} - CloudEventNodeExecution.LabelsEntry {#flyteidl-event-CloudEventNodeExecution-LabelsEntry} - CloudEventTaskExecution {#flyteidl-event-CloudEventTaskExecution} - CloudEventTaskExecution.LabelsEntry {#flyteidl-event-CloudEventTaskExecution-LabelsEntry} - CloudEventWorkflowExecution {#flyteidl-event-CloudEventWorkflowExecution} - CloudEventWorkflowExecution.LabelsEntry {#flyteidl-event-CloudEventWorkflowExecution-LabelsEntry} - flyteidl/event/event.proto - DynamicWorkflowNodeMetadata {#flyteidl-event-DynamicWorkflowNodeMetadata} - EventReason {#flyteidl-event-EventReason} - ExternalResourceInfo {#flyteidl-event-ExternalResourceInfo} - NodeExecutionEvent {#flyteidl-event-NodeExecutionEvent} - ParentNodeExecutionMetadata {#flyteidl-event-ParentNodeExecutionMetadata} - ParentTaskExecutionMetadata {#flyteidl-event-ParentTaskExecutionMetadata} - ResourcePoolInfo {#flyteidl-event-ResourcePoolInfo} - TaskExecutionEvent {#flyteidl-event-TaskExecutionEvent} - TaskExecutionMetadata {#flyteidl-event-TaskExecutionMetadata} - TaskNodeMetadata {#flyteidl-event-TaskNodeMetadata} - WorkflowExecutionEvent {#flyteidl-event-WorkflowExecutionEvent} - WorkflowNodeMetadata {#flyteidl-event-WorkflowNodeMetadata} - TaskExecutionMetadata.InstanceClass {#flyteidl-event-TaskExecutionMetadata-InstanceClass} - flyteidl/datacatalog/datacatalog.proto - AddTagRequest {#datacatalog-AddTagRequest} - AddTagResponse {#datacatalog-AddTagResponse} - Artifact {#datacatalog-Artifact} - ArtifactData {#datacatalog-ArtifactData} - ArtifactPropertyFilter {#datacatalog-ArtifactPropertyFilter} - CreateArtifactRequest {#datacatalog-CreateArtifactRequest} - CreateArtifactResponse {#datacatalog-CreateArtifactResponse} - CreateDatasetRequest {#datacatalog-CreateDatasetRequest} - CreateDatasetResponse {#datacatalog-CreateDatasetResponse} - Dataset {#datacatalog-Dataset} - DatasetID {#datacatalog-DatasetID} - DatasetPropertyFilter {#datacatalog-DatasetPropertyFilter} - FilterExpression {#datacatalog-FilterExpression} - GetArtifactRequest {#datacatalog-GetArtifactRequest} - GetArtifactResponse {#datacatalog-GetArtifactResponse} - GetDatasetRequest {#datacatalog-GetDatasetRequest} - GetDatasetResponse {#datacatalog-GetDatasetResponse} - GetOrExtendReservationRequest {#datacatalog-GetOrExtendReservationRequest} - GetOrExtendReservationResponse {#datacatalog-GetOrExtendReservationResponse} - KeyValuePair {#datacatalog-KeyValuePair} - ListArtifactsRequest {#datacatalog-ListArtifactsRequest} - ListArtifactsResponse {#datacatalog-ListArtifactsResponse} - ListDatasetsRequest {#datacatalog-ListDatasetsRequest} - ListDatasetsResponse {#datacatalog-ListDatasetsResponse} - Metadata {#datacatalog-Metadata} - Metadata.KeyMapEntry {#datacatalog-Metadata-KeyMapEntry} - PaginationOptions {#datacatalog-PaginationOptions} - Partition {#datacatalog-Partition} - PartitionPropertyFilter {#datacatalog-PartitionPropertyFilter} - ReleaseReservationRequest {#datacatalog-ReleaseReservationRequest} - ReleaseReservationResponse {#datacatalog-ReleaseReservationResponse} - Reservation {#datacatalog-Reservation} - ReservationID {#datacatalog-ReservationID} - SinglePropertyFilter {#datacatalog-SinglePropertyFilter} - Tag {#datacatalog-Tag} - TagPropertyFilter {#datacatalog-TagPropertyFilter} - UpdateArtifactRequest {#datacatalog-UpdateArtifactRequest} - UpdateArtifactResponse {#datacatalog-UpdateArtifactResponse} - PaginationOptions.SortKey {#datacatalog-PaginationOptions-SortKey} - PaginationOptions.SortOrder {#datacatalog-PaginationOptions-SortOrder} - SinglePropertyFilter.ComparisonOperator {#datacatalog-SinglePropertyFilter-ComparisonOperator} - DataCatalog {#datacatalog-DataCatalog} - Scalar Value Types - [FlyteKit Plugins](https://www.union.ai/docs/v1/flyte/api-reference/plugins/page.md) - [Flytekit SDK](https://www.union.ai/docs/v1/flyte/api-reference/flytekit-sdk/page.md) - Developing on Flyte - Developing on Union - Directory - Classes - Protocols - Functions - Packages --- **Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/_index.md **HTML**: https://www.union.ai/docs/v1/flyte/api-reference/