diff --git a/protos/docs/admin/admin.rst b/protos/docs/admin/admin.rst
index 73433c1a3..e01eb55c8 100644
--- a/protos/docs/admin/admin.rst
+++ b/protos/docs/admin/admin.rst
@@ -2495,32 +2495,31 @@ Note: This is internal to Admin and doesn't need to be exposed to other componen
-.. _ref_flyteidl/admin/project_domain_attributes.proto:
+.. _ref_flyteidl/admin/project.proto:
-flyteidl/admin/project_domain_attributes.proto
+flyteidl/admin/project.proto
==================================================================
-.. _ref_flyteidl.admin.ProjectDomainAttributes:
+.. _ref_flyteidl.admin.Domain:
-ProjectDomainAttributes
+Domain
------------------------------------------------------------------
-Defines a set of custom matching attributes which defines resource defaults for a project and domain.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Namespace within a project commonly used to differentiate between different service instances.
+e.g. "production", "development", etc.
-.. csv-table:: ProjectDomainAttributes type fields
+.. csv-table:: Domain type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
+ "id", ":ref:`ref_string`", "", "Globally unique domain name."
+ "name", ":ref:`ref_string`", "", "Display name."
@@ -2528,23 +2527,25 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
+.. _ref_flyteidl.admin.Project:
-ProjectDomainAttributesDeleteRequest
+Project
------------------------------------------------------------------
-Request to delete a set matchable project domain attribute override.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Top-level namespace used to classify different entities like workflows and executions.
-.. csv-table:: ProjectDomainAttributesDeleteRequest type fields
+.. csv-table:: Project type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
+ "id", ":ref:`ref_string`", "", "Globally unique project name."
+ "name", ":ref:`ref_string`", "", "Display name."
+ "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
+ "description", ":ref:`ref_string`", "", ""
+ "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
+ "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
@@ -2552,37 +2553,46 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
+.. _ref_flyteidl.admin.ProjectListRequest:
-ProjectDomainAttributesDeleteResponse
+ProjectListRequest
------------------------------------------------------------------
-Purposefully empty, may be populated in the future.
+Request to retrieve a list of projects matching specified filters.
+See :ref:`ref_flyteidl.admin.Project` for more details
+.. csv-table:: ProjectListRequest type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
+ "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional"
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : +optional"
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
-.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
-ProjectDomainAttributesGetRequest
+
+
+.. _ref_flyteidl.admin.ProjectRegisterRequest:
+
+ProjectRegisterRequest
------------------------------------------------------------------
-Request to get an individual project domain attribute override.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Adds a new user-project within the Flyte deployment.
+See :ref:`ref_flyteidl.admin.Project` for more details
-.. csv-table:: ProjectDomainAttributesGetRequest type fields
+.. csv-table:: ProjectRegisterRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
+ "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
@@ -2590,63 +2600,73 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
+.. _ref_flyteidl.admin.ProjectRegisterResponse:
-ProjectDomainAttributesGetResponse
+ProjectRegisterResponse
------------------------------------------------------------------
-Response to get an individual project domain attribute override.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Purposefully empty, may be updated in the future.
-.. csv-table:: ProjectDomainAttributesGetResponse type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
+.. _ref_flyteidl.admin.ProjectUpdateResponse:
+ProjectUpdateResponse
+------------------------------------------------------------------
+Purposefully empty, may be updated in the future.
-.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
-ProjectDomainAttributesUpdateRequest
-------------------------------------------------------------------
-Sets custom attributes for a project-domain combination.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
- "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
+.. _ref_flyteidl.admin.Projects:
+
+Projects
+------------------------------------------------------------------
+Represents a list of projects.
+See :ref:`ref_flyteidl.admin.Project` for more details
+.. csv-table:: Projects type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
+ "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
-.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
-ProjectDomainAttributesUpdateResponse
-------------------------------------------------------------------
-Purposefully empty, may be populated in the future.
+
+.. _ref_flyteidl.admin.Project.ProjectState:
-
+Project.ProjectState
+------------------------------------------------------------------
+
+The state of the project is used to control its visibility in the UI and validity.
+
+.. csv-table:: Enum Project.ProjectState values
+ :header: "Name", "Number", "Description"
+ :widths: auto
+
+ "ACTIVE", "0", "By default, all projects are considered active."
+ "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
+ "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
@@ -2657,31 +2677,32 @@ Purposefully empty, may be populated in the future.
-.. _ref_flyteidl/admin/project.proto:
+.. _ref_flyteidl/admin/project_domain_attributes.proto:
-flyteidl/admin/project.proto
+flyteidl/admin/project_domain_attributes.proto
==================================================================
-.. _ref_flyteidl.admin.Domain:
+.. _ref_flyteidl.admin.ProjectDomainAttributes:
-Domain
+ProjectDomainAttributes
------------------------------------------------------------------
-Namespace within a project commonly used to differentiate between different service instances.
-e.g. "production", "development", etc.
+Defines a set of custom matching attributes which defines resource defaults for a project and domain.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: Domain type fields
+.. csv-table:: ProjectDomainAttributes type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_string`", "", "Globally unique domain name."
- "name", ":ref:`ref_string`", "", "Display name."
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
@@ -2689,25 +2710,23 @@ e.g. "production", "development", etc.
-.. _ref_flyteidl.admin.Project:
+.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest:
-Project
+ProjectDomainAttributesDeleteRequest
------------------------------------------------------------------
-Top-level namespace used to classify different entities like workflows and executions.
+Request to delete a set matchable project domain attribute override.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: Project type fields
+.. csv-table:: ProjectDomainAttributesDeleteRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_string`", "", "Globally unique project name."
- "name", ":ref:`ref_string`", "", "Display name."
- "domains", ":ref:`ref_flyteidl.admin.Domain`", "repeated", ""
- "description", ":ref:`ref_string`", "", ""
- "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information."
- "state", ":ref:`ref_flyteidl.admin.Project.ProjectState`", "", ""
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
@@ -2715,46 +2734,37 @@ Top-level namespace used to classify different entities like workflows and execu
-.. _ref_flyteidl.admin.ProjectListRequest:
+.. _ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse:
-ProjectListRequest
+ProjectDomainAttributesDeleteResponse
------------------------------------------------------------------
-Request to retrieve a list of projects matching specified filters.
-See :ref:`ref_flyteidl.admin.Project` for more details
-
-
+Purposefully empty, may be populated in the future.
-.. csv-table:: ProjectListRequest type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of projects to be returned. +required"
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional"
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : +optional"
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering. +optional"
+.. _ref_flyteidl.admin.ProjectDomainAttributesGetRequest:
-.. _ref_flyteidl.admin.ProjectRegisterRequest:
-
-ProjectRegisterRequest
+ProjectDomainAttributesGetRequest
------------------------------------------------------------------
-Adds a new user-project within the Flyte deployment.
-See :ref:`ref_flyteidl.admin.Project` for more details
+Request to get an individual project domain attribute override.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: ProjectRegisterRequest type fields
+.. csv-table:: ProjectDomainAttributesGetRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_flyteidl.admin.Project`", "", "+required"
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
@@ -2762,27 +2772,21 @@ See :ref:`ref_flyteidl.admin.Project` for more details
-.. _ref_flyteidl.admin.ProjectRegisterResponse:
+.. _ref_flyteidl.admin.ProjectDomainAttributesGetResponse:
-ProjectRegisterResponse
+ProjectDomainAttributesGetResponse
------------------------------------------------------------------
-Purposefully empty, may be updated in the future.
-
-
-
-
-
-
+Response to get an individual project domain attribute override.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. _ref_flyteidl.admin.ProjectUpdateResponse:
-ProjectUpdateResponse
-------------------------------------------------------------------
-
-Purposefully empty, may be updated in the future.
+.. csv-table:: ProjectDomainAttributesGetResponse type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", ""
@@ -2790,45 +2794,41 @@ Purposefully empty, may be updated in the future.
-.. _ref_flyteidl.admin.Projects:
+.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest:
-Projects
+ProjectDomainAttributesUpdateRequest
------------------------------------------------------------------
-Represents a list of projects.
-See :ref:`ref_flyteidl.admin.Project` for more details
+Sets custom attributes for a project-domain combination.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: Projects type fields
+.. csv-table:: ProjectDomainAttributesUpdateRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "projects", ":ref:`ref_flyteidl.admin.Project`", "repeated", ""
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
-
+ "attributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributes`", "", "+required"
-
-.. _ref_flyteidl.admin.Project.ProjectState:
+.. _ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse:
-Project.ProjectState
+ProjectDomainAttributesUpdateResponse
------------------------------------------------------------------
-The state of the project is used to control its visibility in the UI and validity.
+Purposefully empty, may be populated in the future.
+
+
-.. csv-table:: Enum Project.ProjectState values
- :header: "Name", "Number", "Description"
- :widths: auto
- "ACTIVE", "0", "By default, all projects are considered active."
- "ARCHIVED", "1", "Archived projects are no longer visible in the UI and no longer valid."
- "SYSTEM_GENERATED", "2", "System generated projects that aren't explicitly created or managed by a user."
+
+
+
@@ -2942,34 +2942,32 @@ Represents a frequency at which to run a schedule.
-.. _ref_flyteidl/admin/task_execution.proto:
+.. _ref_flyteidl/admin/task.proto:
-flyteidl/admin/task_execution.proto
+flyteidl/admin/task.proto
==================================================================
-.. _ref_flyteidl.admin.TaskExecution:
+.. _ref_flyteidl.admin.Task:
-TaskExecution
+Task
------------------------------------------------------------------
-Encapsulates all details for a single task execution entity.
-A task execution represents an instantiated task, including all inputs and additional
-metadata as well as computed results included state, outputs, and duration-based attributes.
+Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
+arranged to process workflow inputs and produce a deterministic set of outputs.
+Tasks can come in many varieties tuned for specialized behavior.
-.. csv-table:: TaskExecution type fields
+.. csv-table:: Task type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
- "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
- "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
- "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
+ "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
@@ -2977,33 +2975,22 @@ metadata as well as computed results included state, outputs, and duration-based
-.. _ref_flyteidl.admin.TaskExecutionClosure:
+.. _ref_flyteidl.admin.TaskClosure:
-TaskExecutionClosure
+TaskClosure
------------------------------------------------------------------
-Container for task execution details and results.
+Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
+and task metadata.
-.. csv-table:: TaskExecutionClosure type fields
+.. csv-table:: TaskClosure type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "output_uri", ":ref:`ref_string`", "", "**Deprecated.** Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
- "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
- "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
- "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
- "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
- "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
- "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
- "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
- "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
- "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
- "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
- "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
- "event_version", ":ref:`ref_int32`", "", "The event version is used to indicate versioned changes in how data is maintained using this proto message. For example, event_verison > 0 means that maps tasks logs use the TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog in this message."
+ "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
@@ -3011,21 +2998,22 @@ Container for task execution details and results.
-.. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
+.. _ref_flyteidl.admin.TaskCreateRequest:
-TaskExecutionGetDataRequest
+TaskCreateRequest
------------------------------------------------------------------
-Request structure to fetch inputs and output for a task execution.
-By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
+Represents a request structure to create a revision of a task.
+See :ref:`ref_flyteidl.admin.Task` for more details
-.. csv-table:: TaskExecutionGetDataRequest type fields
+.. csv-table:: TaskCreateRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
+ "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
@@ -3033,23 +3021,15 @@ By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExec
-.. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
+.. _ref_flyteidl.admin.TaskCreateResponse:
-TaskExecutionGetDataResponse
+TaskCreateResponse
------------------------------------------------------------------
-Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
-
-
+Represents a response structure if task creation succeeds.
-.. csv-table:: TaskExecutionGetDataResponse type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
+Purposefully empty, may be populated in the future.
- "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
- "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
- "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
- "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
@@ -3057,21 +3037,22 @@ Response structure for TaskExecutionGetDataRequest which contains inputs and out
-.. _ref_flyteidl.admin.TaskExecutionGetRequest:
+.. _ref_flyteidl.admin.TaskList:
-TaskExecutionGetRequest
+TaskList
------------------------------------------------------------------
-A message used to fetch a single task execution entity.
-See :ref:`ref_flyteidl.admin.TaskExecution` for more details
+Represents a list of tasks returned from the admin.
+See :ref:`ref_flyteidl.admin.Task` for more details
-.. csv-table:: TaskExecutionGetRequest type fields
+.. csv-table:: TaskList type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
+ "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
+ "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
@@ -3079,90 +3060,98 @@ See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-.. _ref_flyteidl.admin.TaskExecutionList:
+.. _ref_flyteidl.admin.TaskSpec:
-TaskExecutionList
+TaskSpec
------------------------------------------------------------------
-Response structure for a query to list of task execution entities.
-See :ref:`ref_flyteidl.admin.TaskExecution` for more details
+Represents a structure that encapsulates the user-configured specification of the task.
-.. csv-table:: TaskExecutionList type fields
+.. csv-table:: TaskSpec type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
+ "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
+
+
-.. _ref_flyteidl.admin.TaskExecutionListRequest:
+
-TaskExecutionListRequest
-------------------------------------------------------------------
+
-Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
-See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-.. csv-table:: TaskExecutionListRequest type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
+.. _ref_flyteidl/admin/task_execution.proto:
- "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
- "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
- "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : +optional"
- "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
+flyteidl/admin/task_execution.proto
+==================================================================
-
+.. _ref_flyteidl.admin.TaskExecution:
-
+TaskExecution
+------------------------------------------------------------------
-
+Encapsulates all details for a single task execution entity.
+A task execution represents an instantiated task, including all inputs and additional
+metadata as well as computed results included state, outputs, and duration-based attributes.
-
+.. csv-table:: TaskExecution type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution."
+ "input_uri", ":ref:`ref_string`", "", "Path to remote data store where input blob is stored."
+ "closure", ":ref:`ref_flyteidl.admin.TaskExecutionClosure`", "", "Task execution details and results."
+ "is_parent", ":ref:`ref_bool`", "", "Whether this task spawned nodes."
-.. _ref_flyteidl/admin/task.proto:
-flyteidl/admin/task.proto
-==================================================================
-.. _ref_flyteidl.admin.Task:
+.. _ref_flyteidl.admin.TaskExecutionClosure:
-Task
+TaskExecutionClosure
------------------------------------------------------------------
-Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
-arranged to process workflow inputs and produce a deterministic set of outputs.
-Tasks can come in many varieties tuned for specialized behavior.
+Container for task execution details and results.
-.. csv-table:: Task type fields
+.. csv-table:: TaskExecutionClosure type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task."
- "closure", ":ref:`ref_flyteidl.admin.TaskClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the task."
+ "output_uri", ":ref:`ref_string`", "", "**Deprecated.** Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
+ "error", ":ref:`ref_flyteidl.core.ExecutionError`", "", "Error information for the task execution. Populated if the execution failed."
+ "output_data", ":ref:`ref_flyteidl.core.LiteralMap`", "", "**Deprecated.** Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead."
+ "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "The last recorded phase for this task execution."
+ "logs", ":ref:`ref_flyteidl.core.TaskLog`", "repeated", "Detailed log information output by the task execution."
+ "started_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution began running."
+ "duration", ":ref:`ref_google.protobuf.Duration`", "", "The amount of time the task execution spent running."
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was created."
+ "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task execution was last updated."
+ "custom_info", ":ref:`ref_google.protobuf.Struct`", "", "Custom data specific to the task plugin."
+ "reason", ":ref:`ref_string`", "", "If there is an explanation for the most recent phase transition, the reason will capture it."
+ "task_type", ":ref:`ref_string`", "", "A predefined yet extensible Task type identifier."
+ "metadata", ":ref:`ref_flyteidl.event.TaskExecutionMetadata`", "", "Metadata around how a task was executed."
+ "event_version", ":ref:`ref_int32`", "", "The event version is used to indicate versioned changes in how data is maintained using this proto message. For example, event_verison > 0 means that maps tasks logs use the TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog in this message."
@@ -3170,22 +3159,21 @@ Tasks can come in many varieties tuned for specialized behavior.
-.. _ref_flyteidl.admin.TaskClosure:
+.. _ref_flyteidl.admin.TaskExecutionGetDataRequest:
-TaskClosure
+TaskExecutionGetDataRequest
------------------------------------------------------------------
-Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
-and task metadata.
+Request structure to fetch inputs and output for a task execution.
+By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
-.. csv-table:: TaskClosure type fields
+.. csv-table:: TaskExecutionGetDataRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "compiled_task", ":ref:`ref_flyteidl.core.CompiledTask`", "", "Represents the compiled representation of the task from the specification provided."
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the task was created."
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "The identifier of the task execution for which to fetch inputs and outputs. +required"
@@ -3193,22 +3181,23 @@ and task metadata.
-.. _ref_flyteidl.admin.TaskCreateRequest:
+.. _ref_flyteidl.admin.TaskExecutionGetDataResponse:
-TaskCreateRequest
+TaskExecutionGetDataResponse
------------------------------------------------------------------
-Represents a request structure to create a revision of a task.
-See :ref:`ref_flyteidl.admin.Task` for more details
+Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
-.. csv-table:: TaskCreateRequest type fields
+.. csv-table:: TaskExecutionGetDataResponse type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the task. +required"
- "spec", ":ref:`ref_flyteidl.admin.TaskSpec`", "", "Represents the specification for task. +required"
+ "inputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead."
+ "outputs", ":ref:`ref_flyteidl.admin.UrlBlob`", "", "**Deprecated.** Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead."
+ "full_inputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_inputs will only be populated if they are under a configured size threshold."
+ "full_outputs", ":ref:`ref_flyteidl.core.LiteralMap`", "", "Full_outputs will only be populated if they are under a configured size threshold."
@@ -3216,37 +3205,43 @@ See :ref:`ref_flyteidl.admin.Task` for more details
-.. _ref_flyteidl.admin.TaskCreateResponse:
+.. _ref_flyteidl.admin.TaskExecutionGetRequest:
-TaskCreateResponse
+TaskExecutionGetRequest
------------------------------------------------------------------
-Represents a response structure if task creation succeeds.
+A message used to fetch a single task execution entity.
+See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-Purposefully empty, may be populated in the future.
+.. csv-table:: TaskExecutionGetRequest type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "id", ":ref:`ref_flyteidl.core.TaskExecutionIdentifier`", "", "Unique identifier for the task execution. +required"
-.. _ref_flyteidl.admin.TaskList:
-TaskList
+
+.. _ref_flyteidl.admin.TaskExecutionList:
+
+TaskExecutionList
------------------------------------------------------------------
-Represents a list of tasks returned from the admin.
-See :ref:`ref_flyteidl.admin.Task` for more details
+Response structure for a query to list of task execution entities.
+See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-.. csv-table:: TaskList type fields
+.. csv-table:: TaskExecutionList type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "tasks", ":ref:`ref_flyteidl.admin.Task`", "repeated", "A list of tasks returned based on the request."
+ "task_executions", ":ref:`ref_flyteidl.admin.TaskExecution`", "repeated", ""
"token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
@@ -3255,20 +3250,25 @@ See :ref:`ref_flyteidl.admin.Task` for more details
-.. _ref_flyteidl.admin.TaskSpec:
+.. _ref_flyteidl.admin.TaskExecutionListRequest:
-TaskSpec
+TaskExecutionListRequest
------------------------------------------------------------------
-Represents a structure that encapsulates the user-configured specification of the task.
+Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
+See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-.. csv-table:: TaskSpec type fields
+.. csv-table:: TaskExecutionListRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
+ "node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "Indicates the node execution to filter by. +required"
+ "limit", ":ref:`ref_uint32`", "", "Indicates the number of resources to be returned. +required"
+ "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional"
+ "filters", ":ref:`ref_string`", "", "Indicates a list of filters passed as string. More info on constructing filters : +optional"
+ "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
@@ -3361,33 +3361,32 @@ Provides Version information for a component
-.. _ref_flyteidl/admin/workflow_attributes.proto:
+.. _ref_flyteidl/admin/workflow.proto:
-flyteidl/admin/workflow_attributes.proto
+flyteidl/admin/workflow.proto
==================================================================
-.. _ref_flyteidl.admin.WorkflowAttributes:
+.. _ref_flyteidl.admin.Workflow:
-WorkflowAttributes
+Workflow
------------------------------------------------------------------
-Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Represents the workflow structure stored in the Admin
+A workflow is created by ordering tasks and associating outputs to inputs
+in order to produce a directed-acyclic execution graph.
-.. csv-table:: WorkflowAttributes type fields
+.. csv-table:: Workflow type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
- "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
- "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
- "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
+ "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
@@ -3395,24 +3394,21 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
+.. _ref_flyteidl.admin.WorkflowClosure:
-WorkflowAttributesDeleteRequest
+WorkflowClosure
------------------------------------------------------------------
-Request to delete a set matchable workflow attribute override.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
-.. csv-table:: WorkflowAttributesDeleteRequest type fields
+.. csv-table:: WorkflowClosure type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
+ "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
+ "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
@@ -3420,38 +3416,36 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
+.. _ref_flyteidl.admin.WorkflowCreateRequest:
-WorkflowAttributesDeleteResponse
+WorkflowCreateRequest
------------------------------------------------------------------
-Purposefully empty, may be populated in the future.
+Represents a request structure to create a revision of a workflow.
+See :ref:`ref_flyteidl.admin.Workflow` for more details
+.. csv-table:: WorkflowCreateRequest type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
+ "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
-.. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
-WorkflowAttributesGetRequest
-------------------------------------------------------------------
-Request to get an individual workflow attribute override.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+.. _ref_flyteidl.admin.WorkflowCreateResponse:
+WorkflowCreateResponse
+------------------------------------------------------------------
-.. csv-table:: WorkflowAttributesGetRequest type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
+Purposefully empty, may be populated in the future.
- "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
- "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
- "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
- "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
@@ -3459,20 +3453,22 @@ For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAtt
-.. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
+.. _ref_flyteidl.admin.WorkflowList:
-WorkflowAttributesGetResponse
+WorkflowList
------------------------------------------------------------------
-Response to get an individual workflow attribute override.
+Represents a list of workflows returned from the admin.
+See :ref:`ref_flyteidl.admin.Workflow` for more details
-.. csv-table:: WorkflowAttributesGetResponse type fields
+.. csv-table:: WorkflowList type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
+ "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
+ "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
@@ -3480,35 +3476,21 @@ Response to get an individual workflow attribute override.
-.. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
+.. _ref_flyteidl.admin.WorkflowSpec:
-WorkflowAttributesUpdateRequest
+WorkflowSpec
------------------------------------------------------------------
-Sets custom attributes for a project, domain and workflow combination.
-For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
+Represents a structure that encapsulates the specification of the workflow.
-.. csv-table:: WorkflowAttributesUpdateRequest type fields
+.. csv-table:: WorkflowSpec type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
-
-
-
-
-
-
-
-.. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
-
-WorkflowAttributesUpdateResponse
-------------------------------------------------------------------
-
-Purposefully empty, may be populated in the future.
-
+ "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
+ "sub_workflows", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "repeated", "Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered."
@@ -3525,32 +3507,33 @@ Purposefully empty, may be populated in the future.
-.. _ref_flyteidl/admin/workflow.proto:
+.. _ref_flyteidl/admin/workflow_attributes.proto:
-flyteidl/admin/workflow.proto
+flyteidl/admin/workflow_attributes.proto
==================================================================
-.. _ref_flyteidl.admin.Workflow:
+.. _ref_flyteidl.admin.WorkflowAttributes:
-Workflow
+WorkflowAttributes
------------------------------------------------------------------
-Represents the workflow structure stored in the Admin
-A workflow is created by ordering tasks and associating outputs to inputs
-in order to produce a directed-acyclic execution graph.
+Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: Workflow type fields
+.. csv-table:: WorkflowAttributes type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow."
- "closure", ":ref:`ref_flyteidl.admin.WorkflowClosure`", "", "closure encapsulates all the fields that maps to a compiled version of the workflow."
+ "project", ":ref:`ref_string`", "", "Unique project id for which this set of attributes will be applied."
+ "domain", ":ref:`ref_string`", "", "Unique domain id for which this set of attributes will be applied."
+ "workflow", ":ref:`ref_string`", "", "Workflow name for which this set of attributes will be applied."
+ "matching_attributes", ":ref:`ref_flyteidl.admin.MatchingAttributes`", "", ""
@@ -3558,21 +3541,24 @@ in order to produce a directed-acyclic execution graph.
-.. _ref_flyteidl.admin.WorkflowClosure:
+.. _ref_flyteidl.admin.WorkflowAttributesDeleteRequest:
-WorkflowClosure
+WorkflowAttributesDeleteRequest
------------------------------------------------------------------
-A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
+Request to delete a set matchable workflow attribute override.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: WorkflowClosure type fields
+.. csv-table:: WorkflowAttributesDeleteRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "compiled_workflow", ":ref:`ref_flyteidl.core.CompiledWorkflowClosure`", "", "Represents the compiled representation of the workflow from the specification provided."
- "created_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the workflow was created."
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to delete. +required"
@@ -3580,36 +3566,38 @@ A container holding the compiled workflow produced from the WorkflowSpec and add
-.. _ref_flyteidl.admin.WorkflowCreateRequest:
+.. _ref_flyteidl.admin.WorkflowAttributesDeleteResponse:
-WorkflowCreateRequest
+WorkflowAttributesDeleteResponse
------------------------------------------------------------------
-Represents a request structure to create a revision of a workflow.
-See :ref:`ref_flyteidl.admin.Workflow` for more details
+Purposefully empty, may be populated in the future.
-.. csv-table:: WorkflowCreateRequest type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
- "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the workflow. +required"
- "spec", ":ref:`ref_flyteidl.admin.WorkflowSpec`", "", "Represents the specification for workflow. +required"
+.. _ref_flyteidl.admin.WorkflowAttributesGetRequest:
+WorkflowAttributesGetRequest
+------------------------------------------------------------------
+Request to get an individual workflow attribute override.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. _ref_flyteidl.admin.WorkflowCreateResponse:
-WorkflowCreateResponse
-------------------------------------------------------------------
-Purposefully empty, may be populated in the future.
+.. csv-table:: WorkflowAttributesGetRequest type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+ "project", ":ref:`ref_string`", "", "Unique project id which this set of attributes references. +required"
+ "domain", ":ref:`ref_string`", "", "Unique domain id which this set of attributes references. +required"
+ "workflow", ":ref:`ref_string`", "", "Workflow name which this set of attributes references. +required"
+ "resource_type", ":ref:`ref_flyteidl.admin.MatchableResource`", "", "Which type of matchable attributes to return. +required"
@@ -3617,22 +3605,20 @@ Purposefully empty, may be populated in the future.
-.. _ref_flyteidl.admin.WorkflowList:
+.. _ref_flyteidl.admin.WorkflowAttributesGetResponse:
-WorkflowList
+WorkflowAttributesGetResponse
------------------------------------------------------------------
-Represents a list of workflows returned from the admin.
-See :ref:`ref_flyteidl.admin.Workflow` for more details
+Response to get an individual workflow attribute override.
-.. csv-table:: WorkflowList type fields
+.. csv-table:: WorkflowAttributesGetResponse type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "workflows", ":ref:`ref_flyteidl.admin.Workflow`", "repeated", "A list of workflows returned based on the request."
- "token", ":ref:`ref_string`", "", "In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty."
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
@@ -3640,21 +3626,35 @@ See :ref:`ref_flyteidl.admin.Workflow` for more details
-.. _ref_flyteidl.admin.WorkflowSpec:
+.. _ref_flyteidl.admin.WorkflowAttributesUpdateRequest:
-WorkflowSpec
+WorkflowAttributesUpdateRequest
------------------------------------------------------------------
-Represents a structure that encapsulates the specification of the workflow.
+Sets custom attributes for a project, domain and workflow combination.
+For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-.. csv-table:: WorkflowSpec type fields
+.. csv-table:: WorkflowAttributesUpdateRequest type fields
:header: "Field", "Type", "Label", "Description"
:widths: auto
- "template", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "Template of the task that encapsulates all the metadata of the workflow."
- "sub_workflows", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "repeated", "Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered."
+ "attributes", ":ref:`ref_flyteidl.admin.WorkflowAttributes`", "", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.admin.WorkflowAttributesUpdateResponse:
+
+WorkflowAttributesUpdateResponse
+------------------------------------------------------------------
+
+Purposefully empty, may be populated in the future.
+
diff --git a/protos/docs/core/core.rst b/protos/docs/core/core.rst
index 3349a3768..31e8d3f3c 100644
--- a/protos/docs/core/core.rst
+++ b/protos/docs/core/core.rst
@@ -2697,46 +2697,6 @@ Define a set of simple types.
-.. _ref_flyteidl/core/workflow_closure.proto:
-
-flyteidl/core/workflow_closure.proto
-==================================================================
-
-
-
-
-
-.. _ref_flyteidl.core.WorkflowClosure:
-
-WorkflowClosure
-------------------------------------------------------------------
-
-Defines an enclosed package of workflow and tasks it references.
-
-
-
-.. csv-table:: WorkflowClosure type fields
- :header: "Field", "Type", "Label", "Description"
- :widths: auto
-
- "workflow", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "required. Workflow template."
- "tasks", ":ref:`ref_flyteidl.core.TaskTemplate`", "repeated", "optional. A collection of tasks referenced by the workflow. Only needed if the workflow references tasks."
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
.. _ref_flyteidl/core/workflow.proto:
flyteidl/core/workflow.proto
@@ -3057,6 +3017,46 @@ Failure Handling Strategy
+.. _ref_flyteidl/core/workflow_closure.proto:
+
+flyteidl/core/workflow_closure.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.core.WorkflowClosure:
+
+WorkflowClosure
+------------------------------------------------------------------
+
+Defines an enclosed package of workflow and tasks it references.
+
+
+
+.. csv-table:: WorkflowClosure type fields
+ :header: "Field", "Type", "Label", "Description"
+ :widths: auto
+
+ "workflow", ":ref:`ref_flyteidl.core.WorkflowTemplate`", "", "required. Workflow template."
+ "tasks", ":ref:`ref_flyteidl.core.TaskTemplate`", "repeated", "optional. A collection of tasks referenced by the workflow. Only needed if the workflow references tasks."
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
.. _ref_google/protobuf/timestamp.proto:
google/protobuf/timestamp.proto