@flyteorg/flyteidl 1.2.1 → 1.2.3

package/package.json

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

package/protos/docs/admin/admin.rst

@@ -1084,6 +1084,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 +1120,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 +1657,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 +2045,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."
 
 
 

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/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/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/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.
  */