@flyteorg/flyteidl 0.24.21 → 1.1.0

package/package.json

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

package/protos/docs/admin/admin.rst

@@ -1179,6 +1179,7 @@ of an execution as it progresses across phase changes.
    "max_parallelism", ":ref:`ref_int32`", "", "Controls the maximum number of task nodes 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."
    "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."
 
 
 
@@ -1706,6 +1707,7 @@ User-provided launch plan definition and configuration values.
    "quality_of_service", ":ref:`ref_flyteidl.core.QualityOfService`", "", "Indicates the runtime priority of the execution."
    "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."
 
 
 
@@ -2084,6 +2086,7 @@ Adds defaults for customizable workflow-execution specifications and overrides.
    "raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
    "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."
 
 
 
@@ -3754,6 +3757,231 @@ microsecond should be expressed in JSON format as "3.000001s".
 
 
 
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_google/protobuf/wrappers.proto:
+
+google/protobuf/wrappers.proto
+==================================================================
+
+
+
+
+
+.. _ref_google.protobuf.BoolValue:
+
+BoolValue
+------------------------------------------------------------------
+
+Wrapper message for `bool`.
+
+The JSON representation for `BoolValue` is JSON `true` and `false`.
+
+
+
+.. csv-table:: BoolValue type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_bool`", "", "The bool value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.BytesValue:
+
+BytesValue
+------------------------------------------------------------------
+
+Wrapper message for `bytes`.
+
+The JSON representation for `BytesValue` is JSON string.
+
+
+
+.. csv-table:: BytesValue type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_bytes`", "", "The bytes value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.DoubleValue:
+
+DoubleValue
+------------------------------------------------------------------
+
+Wrapper message for `double`.
+
+The JSON representation for `DoubleValue` is JSON number.
+
+
+
+.. csv-table:: DoubleValue type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_double`", "", "The double value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.FloatValue:
+
+FloatValue
+------------------------------------------------------------------
+
+Wrapper message for `float`.
+
+The JSON representation for `FloatValue` is JSON number.
+
+
+
+.. csv-table:: FloatValue type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_float`", "", "The float value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.Int32Value:
+
+Int32Value
+------------------------------------------------------------------
+
+Wrapper message for `int32`.
+
+The JSON representation for `Int32Value` is JSON number.
+
+
+
+.. csv-table:: Int32Value type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_int32`", "", "The int32 value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.Int64Value:
+
+Int64Value
+------------------------------------------------------------------
+
+Wrapper message for `int64`.
+
+The JSON representation for `Int64Value` is JSON string.
+
+
+
+.. csv-table:: Int64Value type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_int64`", "", "The int64 value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.StringValue:
+
+StringValue
+------------------------------------------------------------------
+
+Wrapper message for `string`.
+
+The JSON representation for `StringValue` is JSON string.
+
+
+
+.. csv-table:: StringValue type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_string`", "", "The string value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.UInt32Value:
+
+UInt32Value
+------------------------------------------------------------------
+
+Wrapper message for `uint32`.
+
+The JSON representation for `UInt32Value` is JSON number.
+
+
+
+.. csv-table:: UInt32Value type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_uint32`", "", "The uint32 value."
+
+
+
+
+
+
+
+.. _ref_google.protobuf.UInt64Value:
+
+UInt64Value
+------------------------------------------------------------------
+
+Wrapper message for `uint64`.
+
+The JSON representation for `UInt64Value` is JSON string.
+
+
+
+.. csv-table:: UInt64Value type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "value", ":ref:`ref_uint64`", "", "The uint64 value."
+
+
+
+
+
  <!-- end messages -->
 
  <!-- end enums -->

package/protos/flyteidl/admin/execution.proto

@@ -11,6 +11,7 @@ import "flyteidl/core/identifier.proto";
 import "flyteidl/core/security.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
 
 // Request to launch an execution with the given project, domain and optionally-assigned name.
 message ExecutionCreateRequest {
@@ -289,6 +290,12 @@ message ExecutionSpec {
 
     // Controls how to select an available cluster on which this execution should run.
     ClusterAssignment cluster_assignment = 20;
+
+    // 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.
+    google.protobuf.BoolValue interruptible = 21;
 }
 
 // Request to terminate an in-progress execution.  This action is irreversible.

package/protos/flyteidl/admin/launch_plan.proto

@@ -11,6 +11,7 @@ import "flyteidl/core/security.proto";
 import "flyteidl/admin/schedule.proto";
 import "flyteidl/admin/common.proto";
 import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
 
 // Request to register a launch plan. The included LaunchPlanSpec may have a complete or incomplete set of inputs required
 // to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to
@@ -118,6 +119,12 @@ message LaunchPlanSpec {
     // This is useful to achieve fairness. Note: MapTasks are regarded as one unit,
     // and parallelism/concurrency of MapTasks is independent from this.
     int32 max_parallelism = 18;
+
+    // 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.
+    google.protobuf.BoolValue interruptible = 19;
 }
 
 // Values computed by the flyte platform after launch plan registration.

package/protos/flyteidl/admin/matchable_resource.proto

@@ -7,6 +7,7 @@ import "flyteidl/admin/common.proto";
 import "flyteidl/admin/cluster_assignment.proto";
 import "flyteidl/core/execution.proto";
 import "flyteidl/core/security.proto";
+import "google/protobuf/wrappers.proto";
 
 // Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes
 // based on matching tags.
@@ -116,6 +117,12 @@ message WorkflowExecutionConfig {
 
   // Custom annotations to be applied to a triggered execution resource.
   Annotations annotations = 5;
+
+  // 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.
+  google.protobuf.BoolValue interruptible = 6;
 }
 
 // Generic container for encapsulating all types of the above attributes messages.