@flyteorg/flyteidl 1.2.2 → 1.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/docs/admin/admin.rst

@@ -657,6 +657,173 @@ Sort.Direction
 
 
 
+.. _ref_flyteidl/admin/description_entity.proto:
+
+flyteidl/admin/description_entity.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.admin.Description:
+
+Description
+------------------------------------------------------------------
+
+Full user description with formatting preserved. This can be rendered
+by clients, such as the console or command line tools with in-tact
+formatting.
+
+
+
+.. csv-table:: Description type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_string`", "", "long description - no more than 4KB"
+   "uri", ":ref:`ref_string`", "", "if the description sizes exceed some threshold we can offload the entire description proto altogether to an external data store, like S3 rather than store inline in the db"
+   "format", ":ref:`ref_flyteidl.admin.DescriptionFormat`", "", "Format of the long description"
+   "icon_link", ":ref:`ref_string`", "", "Optional link to an icon for the entity"
+
+
+
+
+
+
+
+.. _ref_flyteidl.admin.DescriptionEntity:
+
+DescriptionEntity
+------------------------------------------------------------------
+
+DescriptionEntity contains detailed description for the task/workflow.
+Documentation could provide insight into the algorithms, business use case, etc.
+
+
+
+.. csv-table:: DescriptionEntity type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "id", ":ref:`ref_flyteidl.core.Identifier`", "", "id represents the unique identifier of the description entity."
+   "short_description", ":ref:`ref_string`", "", "One-liner overview of the entity."
+   "long_description", ":ref:`ref_flyteidl.admin.Description`", "", "Full user description with formatting preserved."
+   "source_code", ":ref:`ref_flyteidl.admin.SourceCode`", "", "Optional link to source code used to define this entity."
+   "tags", ":ref:`ref_string`", "repeated", "User-specified tags. These are arbitrary and can be used for searching filtering and discovering tasks."
+
+
+
+
+
+
+
+.. _ref_flyteidl.admin.DescriptionEntityList:
+
+DescriptionEntityList
+------------------------------------------------------------------
+
+Represents a list of DescriptionEntities returned from the admin.
+See :ref:`ref_flyteidl.admin.DescriptionEntity` for more details
+
+
+
+.. csv-table:: DescriptionEntityList type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "descriptionEntities", ":ref:`ref_flyteidl.admin.DescriptionEntity`", "repeated", "A list of DescriptionEntities 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."
+
+
+
+
+
+
+
+.. _ref_flyteidl.admin.DescriptionEntityListRequest:
+
+DescriptionEntityListRequest
+------------------------------------------------------------------
+
+Represents a request structure to retrieve a list of DescriptionEntities.
+See :ref:`ref_flyteidl.admin.DescriptionEntity` for more details
+
+
+
+.. csv-table:: DescriptionEntityListRequest type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "resource_type", ":ref:`ref_flyteidl.core.ResourceType`", "", "Identifies the specific type of resource that this identifier corresponds to."
+   "id", ":ref:`ref_flyteidl.admin.NamedEntityIdentifier`", "", "The identifier for the description entity. +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 : <Link> +optional"
+   "sort_by", ":ref:`ref_flyteidl.admin.Sort`", "", "Sort ordering for returned list. +optional"
+
+
+
+
+
+
+
+.. _ref_flyteidl.admin.SourceCode:
+
+SourceCode
+------------------------------------------------------------------
+
+Link to source code used to define this entity
+
+
+
+.. csv-table:: SourceCode type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "link", ":ref:`ref_string`", "", ""
+
+
+
+
+
+
+..
+   end messages
+
+
+
+.. _ref_flyteidl.admin.DescriptionFormat:
+
+DescriptionFormat
+------------------------------------------------------------------
+
+The format of the long description
+
+.. csv-table:: Enum DescriptionFormat values
+   :header: "Name", "Number", "Description"
+   :widths: auto
+
+   "DESCRIPTION_FORMAT_UNKNOWN", "0", ""
+   "DESCRIPTION_FORMAT_MARKDOWN", "1", ""
+   "DESCRIPTION_FORMAT_HTML", "2", ""
+   "DESCRIPTION_FORMAT_RST", "3", "python default documentation - comments is rst"
+
+
+..
+   end enums
+
+
+..
+   end HasExtensions
+
+
+..
+   end services
+
+
+
+
 .. _ref_flyteidl/admin/event.proto:
 
 flyteidl/admin/event.proto
@@ -1084,6 +1251,7 @@ Request to relaunch the referenced execution.
 
    "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the workflow execution to relaunch. +required"
    "name", ":ref:`ref_string`", "", "User provided value for the relaunched execution. If none is provided the system will generate a unique string. +optional"
+   "overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
 
 
 
@@ -1119,6 +1287,7 @@ of an execution as it progresses across phase changes.
    "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data"
    "cluster_assignment", ":ref:`ref_flyteidl.admin.ClusterAssignment`", "", "Controls how to select an available cluster on which this execution should run."
    "interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
+   "overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
 
 
 
@@ -1655,6 +1824,7 @@ User-provided launch plan definition and configuration values.
    "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
    "max_parallelism", ":ref:`ref_int32`", "", "Controls the maximum number of tasknodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this."
    "interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
+   "overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
 
 
 
@@ -2042,6 +2212,7 @@ Adds defaults for customizable workflow-execution specifications and overrides.
    "labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Custom labels to be applied to a triggered execution resource."
    "annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Custom annotations to be applied to a triggered execution resource."
    "interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
+   "overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
 
 
 
@@ -3303,6 +3474,7 @@ Tasks can come in many varieties tuned for specialized behavior.
 
    "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."
+   "short_description", ":ref:`ref_string`", "", "One-liner overview of the entity."
 
 
 
@@ -3409,6 +3581,7 @@ Represents a structure that encapsulates the user-configured specification of th
    :widths: auto
 
    "template", ":ref:`ref_flyteidl.core.TaskTemplate`", "", "Template of the task that encapsulates all the metadata of the task."
+   "description", ":ref:`ref_flyteidl.admin.DescriptionEntity`", "", "Represents the specification for description entity."
 
 
 
@@ -3768,6 +3941,7 @@ in order to produce a directed-acyclic execution graph.
 
    "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."
+   "short_description", ":ref:`ref_string`", "", "One-liner overview of the entity."
 
 
 
@@ -3914,6 +4088,7 @@ Represents a structure that encapsulates the specification of the workflow.
 
    "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."
+   "description", ":ref:`ref_flyteidl.admin.DescriptionEntity`", "", "Represents the specification for description entity."
 
 
 

package/protos/docs/core/core.rst

@@ -94,6 +94,7 @@ Indicates the status of CatalogCaching. The reason why this is not embedded in T
    "CACHE_POPULATED", "3", "used to indicate that the resultant artifact was added to the cache"
    "CACHE_LOOKUP_FAILURE", "4", "Used to indicate that cache lookup failed because of an error"
    "CACHE_PUT_FAILURE", "5", "Used to indicate that cache lookup failed because of an error"
+   "CACHE_SKIPPED", "6", "Used to indicate the cache lookup was skipped"
 
 
 

package/protos/docs/datacatalog/datacatalog.rst

@@ -790,6 +790,51 @@ Tag properties we can filter by
 
 
 
+
+.. _ref_datacatalog.UpdateArtifactRequest:
+
+UpdateArtifactRequest
+------------------------------------------------------------------
+
+Request message for updating an Artifact and overwriting its associated ArtifactData.
+
+
+
+.. csv-table:: UpdateArtifactRequest type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "dataset", ":ref:`ref_datacatalog.DatasetID`", "", "ID of dataset the artifact is associated with"
+   "artifact_id", ":ref:`ref_string`", "", ""
+   "tag_name", ":ref:`ref_string`", "", ""
+   "data", ":ref:`ref_datacatalog.ArtifactData`", "repeated", "List of data to overwrite stored artifact data with. Must contain ALL data for updated Artifact as any missing ArtifactData entries will be removed from the underlying blob storage and database."
+
+
+
+
+
+
+
+.. _ref_datacatalog.UpdateArtifactResponse:
+
+UpdateArtifactResponse
+------------------------------------------------------------------
+
+Response message for updating an Artifact.
+
+
+
+.. csv-table:: UpdateArtifactResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "artifact_id", ":ref:`ref_string`", "", "The unique ID of the artifact updated"
+
+
+
+
+
+
 ..
    end messages
 
@@ -869,6 +914,7 @@ Artifacts are associated with a Dataset, and can be tagged for retrieval.
    "AddTag", ":ref:`ref_datacatalog.AddTagRequest`", ":ref:`ref_datacatalog.AddTagResponse`", "Associate a tag with an artifact. Tags are unique within a Dataset."
    "ListArtifacts", ":ref:`ref_datacatalog.ListArtifactsRequest`", ":ref:`ref_datacatalog.ListArtifactsResponse`", "Return a paginated list of artifacts"
    "ListDatasets", ":ref:`ref_datacatalog.ListDatasetsRequest`", ":ref:`ref_datacatalog.ListDatasetsResponse`", "Return a paginated list of datasets"
+   "UpdateArtifact", ":ref:`ref_datacatalog.UpdateArtifactRequest`", ":ref:`ref_datacatalog.UpdateArtifactResponse`", "Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage."
    "GetOrExtendReservation", ":ref:`ref_datacatalog.GetOrExtendReservationRequest`", ":ref:`ref_datacatalog.GetOrExtendReservationResponse`", "Attempts to get or extend a reservation for the corresponding artifact. If one already exists (ie. another entity owns the reservation) then that reservation is retrieved. Once you acquire a reservation, you need to periodically extend the reservation with an identical call. If the reservation is not extended before the defined expiration, it may be acquired by another task. Note: We may have multiple concurrent tasks with the same signature and the same input that try to populate the same artifact at the same time. Thus with reservation, only one task can run at a time, until the reservation expires. Note: If task A does not extend the reservation in time and the reservation expires, another task B may take over the reservation, resulting in two tasks A and B running in parallel. So a third task C may get the Artifact from A or B, whichever writes last."
    "ReleaseReservation", ":ref:`ref_datacatalog.ReleaseReservationRequest`", ":ref:`ref_datacatalog.ReleaseReservationResponse`", "Release the reservation when the task holding the spot fails so that the other tasks can grab the spot."
 

package/protos/docs/service/service.rst

@@ -88,6 +88,8 @@ Standard response codes for both are defined here: https://github.com/grpc-ecosy
    "GetNamedEntity", ":ref:`ref_flyteidl.admin.NamedEntityGetRequest`", ":ref:`ref_flyteidl.admin.NamedEntity`", "Returns a :ref:`ref_flyteidl.admin.NamedEntity` object."
    "UpdateNamedEntity", ":ref:`ref_flyteidl.admin.NamedEntityUpdateRequest`", ":ref:`ref_flyteidl.admin.NamedEntityUpdateResponse`", "Updates a :ref:`ref_flyteidl.admin.NamedEntity` object."
    "GetVersion", ":ref:`ref_flyteidl.admin.GetVersionRequest`", ":ref:`ref_flyteidl.admin.GetVersionResponse`", ""
+   "GetDescriptionEntity", ":ref:`ref_flyteidl.admin.ObjectGetRequest`", ":ref:`ref_flyteidl.admin.DescriptionEntity`", "Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object."
+   "ListDescriptionEntities", ":ref:`ref_flyteidl.admin.DescriptionEntityListRequest`", ":ref:`ref_flyteidl.admin.DescriptionEntityList`", "Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions."
 
 ..
    end services

package/protos/flyteidl/admin/description_entity.proto

@@ -0,0 +1,95 @@
+syntax = "proto3";
+
+package flyteidl.admin;
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
+
+import "flyteidl/core/identifier.proto";
+import "flyteidl/admin/common.proto";
+
+// DescriptionEntity contains detailed description for the task/workflow.
+// Documentation could provide insight into the algorithms, business use case, etc.
+message DescriptionEntity {
+  // id represents the unique identifier of the description entity.
+  core.Identifier id = 1;
+  // One-liner overview of the entity.
+  string short_description = 2;
+  // Full user description with formatting preserved.
+  Description long_description = 3;
+  // Optional link to source code used to define this entity.
+  SourceCode source_code = 4;
+  // User-specified tags. These are arbitrary and can be used for searching
+  // filtering and discovering tasks.
+  repeated string tags = 5;
+}
+
+// The format of the long description
+enum DescriptionFormat {
+  DESCRIPTION_FORMAT_UNKNOWN = 0;
+  DESCRIPTION_FORMAT_MARKDOWN = 1;
+  DESCRIPTION_FORMAT_HTML = 2;
+  // python default documentation - comments is rst
+  DESCRIPTION_FORMAT_RST = 3;
+}
+
+// Full user description with formatting preserved. This can be rendered
+// by clients, such as the console or command line tools with in-tact
+// formatting.
+message Description {
+  oneof content {
+    // long description - no more than 4KB
+    string value = 1;
+    // if the description sizes exceed some threshold we can offload the entire
+    // description proto altogether to an external data store, like S3 rather than store inline in the db
+    string uri = 2;
+  }
+
+  // Format of the long description
+  DescriptionFormat format = 3;
+  // Optional link to an icon for the entity
+  string icon_link = 4;
+}
+
+// Link to source code used to define this entity
+message SourceCode {
+  string link = 1;
+}
+
+// Represents a list of DescriptionEntities returned from the admin.
+// See :ref:`ref_flyteidl.admin.DescriptionEntity` for more details
+message DescriptionEntityList {
+  // A list of DescriptionEntities returned based on the request.
+  repeated DescriptionEntity descriptionEntities = 1;
+
+  // 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.
+  string token                = 2;
+}
+
+// Represents a request structure to retrieve a list of DescriptionEntities.
+// See :ref:`ref_flyteidl.admin.DescriptionEntity` for more details
+message DescriptionEntityListRequest {
+  // Identifies the specific type of resource that this identifier corresponds to.
+  flyteidl.core.ResourceType resource_type  = 1;
+
+  // The identifier for the description entity.
+  // +required
+  NamedEntityIdentifier id = 2;
+
+  // Indicates the number of resources to be returned.
+  // +required
+  uint32 limit    = 3;
+
+  // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
+  // in a query.
+  // +optional
+  string token    = 4;
+
+  // Indicates a list of filters passed as string.
+  // More info on constructing filters : <Link>
+  // +optional
+  string filters  = 5;
+
+  // Sort ordering for returned list.
+  // +optional
+  Sort sort_by    = 6;
+}

package/protos/flyteidl/admin/execution.proto

@@ -45,10 +45,18 @@ message ExecutionRelaunchRequest {
     // +required
     core.WorkflowExecutionIdentifier id = 1;
 
+    // Deprecated field, do not use.
+    reserved 2;
+
     // User provided value for the relaunched execution.
     // If none is provided the system will generate a unique string.
     // +optional
     string name = 3;
+
+    // Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
+    // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
+    // data once execution finishes successfully.
+    bool overwrite_cache = 4;
 }
 
 // Request to recover the referenced execution.
@@ -296,6 +304,11 @@ message ExecutionSpec {
     // As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
     // around the bool field.
     google.protobuf.BoolValue interruptible = 21;
+
+    // Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
+    // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
+    // data once execution finishes successfully.
+    bool overwrite_cache = 22;
 }
 
 // Request to terminate an in-progress execution.  This action is irreversible.

package/protos/flyteidl/admin/launch_plan.proto

@@ -125,6 +125,11 @@ message LaunchPlanSpec {
     // As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
     // around the bool field.
     google.protobuf.BoolValue interruptible = 19;
+
+    // Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
+    // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
+    // data once execution finishes successfully.
+    bool overwrite_cache = 20;
 }
 
 // Values computed by the flyte platform after launch plan registration.

package/protos/flyteidl/admin/matchable_resource.proto

@@ -123,6 +123,11 @@ message WorkflowExecutionConfig {
   // As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
   // around the bool field.
   google.protobuf.BoolValue interruptible = 6;
+
+  // Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
+  // If enabled, all calculations are performed even if cached results would be available, overwriting the stored
+  // data once execution finishes successfully.
+  bool overwrite_cache = 7;
 }
 
 // Generic container for encapsulating all types of the above attributes messages.

package/protos/flyteidl/admin/task.proto

@@ -6,6 +6,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 import "flyteidl/core/identifier.proto";
 import "flyteidl/core/tasks.proto";
 import "flyteidl/core/compiler.proto";
+import "flyteidl/admin/description_entity.proto";
 import "google/protobuf/timestamp.proto";
 
 // Represents a request structure to create a revision of a task.
@@ -34,6 +35,9 @@ message Task {
 
     // closure encapsulates all the fields that maps to a compiled version of the task.
     TaskClosure closure      = 2;
+
+    // One-liner overview of the entity.
+    string short_description = 3;
 }
 
 // Represents a list of tasks returned from the admin.
@@ -51,6 +55,9 @@ message TaskList {
 message TaskSpec {
     // Template of the task that encapsulates all the metadata of the task.
     core.TaskTemplate template = 1;
+
+    // Represents the specification for description entity.
+    DescriptionEntity description        = 2;
 }
 
 // Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data

package/protos/flyteidl/admin/workflow.proto

@@ -6,6 +6,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin";
 import "flyteidl/core/compiler.proto";
 import "flyteidl/core/identifier.proto";
 import "flyteidl/core/workflow.proto";
+import "flyteidl/admin/description_entity.proto";
 import "google/protobuf/timestamp.proto";
 
 // Represents a request structure to create a revision of a workflow.
@@ -33,6 +34,9 @@ message Workflow {
     
     // closure encapsulates all the fields that maps to a compiled version of the workflow.
     WorkflowClosure closure  = 2;
+
+    // One-liner overview of the entity.
+    string short_description = 3;
 }
 
 // Represents a list of workflows returned from the admin.
@@ -55,6 +59,9 @@ message WorkflowSpec {
     // 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.
     repeated core.WorkflowTemplate sub_workflows = 2;
+
+    // Represents the specification for description entity.
+    DescriptionEntity description        = 3;
 }
 
 // A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.

package/protos/flyteidl/core/catalog.proto

@@ -20,6 +20,8 @@ enum CatalogCacheStatus {
   CACHE_LOOKUP_FAILURE = 4;
   // Used to indicate that cache lookup failed because of an error
   CACHE_PUT_FAILURE = 5;
+  // Used to indicate the cache lookup was skipped
+  CACHE_SKIPPED = 6;
 };
 
 message CatalogArtifactTag {

package/protos/flyteidl/core/identifier.proto

@@ -19,7 +19,7 @@ enum ResourceType {
 // Encapsulation of fields that uniquely identifies a Flyte resource.
 message Identifier {
     // Identifies the specific type of resource that this identifier corresponds to.
-    ResourceType resource_type  = 1;
+    core.ResourceType resource_type  = 1;
 
     // Name of the project the resource belongs to.
     string project              = 2;

package/protos/flyteidl/datacatalog/datacatalog.proto

@@ -37,6 +37,9 @@ service DataCatalog {
     // Return a paginated list of datasets
     rpc ListDatasets (ListDatasetsRequest) returns (ListDatasetsResponse);
 
+    // Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage.
+    rpc UpdateArtifact (UpdateArtifactRequest) returns (UpdateArtifactResponse);
+
     // Attempts to get or extend a reservation for the corresponding artifact. If one already exists
     // (ie. another entity owns the reservation) then that reservation is retrieved.
     // Once you acquire a reservation, you need to  periodically extend the reservation with an
@@ -170,6 +173,32 @@ message ListDatasetsResponse {
     string next_token = 2;
 }
 
+/*
+ * Request message for updating an Artifact and overwriting its associated ArtifactData.
+ */
+message UpdateArtifactRequest {
+    // ID of dataset the artifact is associated with
+    DatasetID dataset = 1;
+
+    // Either ID of artifact or name of tag to retrieve existing artifact from
+    oneof query_handle {
+        string artifact_id = 2;
+        string tag_name = 3;
+    }
+
+    // List of data to overwrite stored artifact data with. Must contain ALL data for updated Artifact as any missing
+    // ArtifactData entries will be removed from the underlying blob storage and database.
+    repeated ArtifactData data = 4;
+}
+
+/*
+ * Response message for updating an Artifact.
+ */
+message UpdateArtifactResponse {
+    // The unique ID of the artifact updated
+    string artifact_id = 1;
+}
+
 /*
  * ReservationID message that is composed of several string fields.
  */

package/protos/flyteidl/service/admin.proto

@@ -18,6 +18,8 @@ import "flyteidl/admin/node_execution.proto";
 import "flyteidl/admin/task_execution.proto";
 import "flyteidl/admin/version.proto";
 import "flyteidl/admin/common.proto";
+import "flyteidl/admin/description_entity.proto";
+import "flyteidl/core/identifier.proto";
 import "protoc-gen-swagger/options/annotations.proto";
 
 // The following defines an RPC service that is also served over HTTP via grpc-gateway.
@@ -603,5 +605,26 @@ service AdminService {
       };
   }
 
-}
+  // Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.
+  rpc GetDescriptionEntity (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.DescriptionEntity) {
+    option (google.api.http) = {
+      get: "/api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}"
+    };
+    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
+      description: "Retrieve an existing description entity description."
+    };
+  }
 
+  // Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
+  rpc ListDescriptionEntities (flyteidl.admin.DescriptionEntityListRequest) returns (flyteidl.admin.DescriptionEntityList) {
+    option (google.api.http) = {
+      get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
+      additional_bindings {
+        get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}"
+      }
+    };
+    option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
+      description: "Fetch existing description entity definitions matching input filters."
+    };
+  }
+}