@flyteorg/flyteidl 1.16.0 → 1.16.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -16622,6 +16622,9 @@ export namespace flyteidl {
16622
16622
 
16623
16623
  /** LaunchPlanSpec clusterAssignment */
16624
16624
  clusterAssignment?: (flyteidl.admin.IClusterAssignment|null);
16625
+
16626
+ /** LaunchPlanSpec concurrencyPolicy */
16627
+ concurrencyPolicy?: (flyteidl.admin.IConcurrencyPolicy|null);
16625
16628
  }
16626
16629
 
16627
16630
  /** Represents a LaunchPlanSpec. */
@@ -16687,6 +16690,9 @@ export namespace flyteidl {
16687
16690
  /** LaunchPlanSpec clusterAssignment. */
16688
16691
  public clusterAssignment?: (flyteidl.admin.IClusterAssignment|null);
16689
16692
 
16693
+ /** LaunchPlanSpec concurrencyPolicy. */
16694
+ public concurrencyPolicy?: (flyteidl.admin.IConcurrencyPolicy|null);
16695
+
16690
16696
  /**
16691
16697
  * Creates a new LaunchPlanSpec instance using the specified properties.
16692
16698
  * @param [properties] Properties to set
@@ -16720,6 +16726,70 @@ export namespace flyteidl {
16720
16726
  public static verify(message: { [k: string]: any }): (string|null);
16721
16727
  }
16722
16728
 
16729
+ /** Properties of a ConcurrencyPolicy. */
16730
+ interface IConcurrencyPolicy {
16731
+
16732
+ /** ConcurrencyPolicy max */
16733
+ max?: (number|null);
16734
+
16735
+ /** ConcurrencyPolicy behavior */
16736
+ behavior?: (flyteidl.admin.ConcurrencyLimitBehavior|null);
16737
+ }
16738
+
16739
+ /** Represents a ConcurrencyPolicy. */
16740
+ class ConcurrencyPolicy implements IConcurrencyPolicy {
16741
+
16742
+ /**
16743
+ * Constructs a new ConcurrencyPolicy.
16744
+ * @param [properties] Properties to set
16745
+ */
16746
+ constructor(properties?: flyteidl.admin.IConcurrencyPolicy);
16747
+
16748
+ /** ConcurrencyPolicy max. */
16749
+ public max: number;
16750
+
16751
+ /** ConcurrencyPolicy behavior. */
16752
+ public behavior: flyteidl.admin.ConcurrencyLimitBehavior;
16753
+
16754
+ /**
16755
+ * Creates a new ConcurrencyPolicy instance using the specified properties.
16756
+ * @param [properties] Properties to set
16757
+ * @returns ConcurrencyPolicy instance
16758
+ */
16759
+ public static create(properties?: flyteidl.admin.IConcurrencyPolicy): flyteidl.admin.ConcurrencyPolicy;
16760
+
16761
+ /**
16762
+ * Encodes the specified ConcurrencyPolicy message. Does not implicitly {@link flyteidl.admin.ConcurrencyPolicy.verify|verify} messages.
16763
+ * @param message ConcurrencyPolicy message or plain object to encode
16764
+ * @param [writer] Writer to encode to
16765
+ * @returns Writer
16766
+ */
16767
+ public static encode(message: flyteidl.admin.IConcurrencyPolicy, writer?: $protobuf.Writer): $protobuf.Writer;
16768
+
16769
+ /**
16770
+ * Decodes a ConcurrencyPolicy message from the specified reader or buffer.
16771
+ * @param reader Reader or buffer to decode from
16772
+ * @param [length] Message length if known beforehand
16773
+ * @returns ConcurrencyPolicy
16774
+ * @throws {Error} If the payload is not a reader or valid buffer
16775
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
16776
+ */
16777
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ConcurrencyPolicy;
16778
+
16779
+ /**
16780
+ * Verifies a ConcurrencyPolicy message.
16781
+ * @param message Plain object to verify
16782
+ * @returns `null` if valid, otherwise the reason why it is not
16783
+ */
16784
+ public static verify(message: { [k: string]: any }): (string|null);
16785
+ }
16786
+
16787
+ /** ConcurrencyLimitBehavior enum. */
16788
+ enum ConcurrencyLimitBehavior {
16789
+ CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED = 0,
16790
+ CONCURRENCY_LIMIT_BEHAVIOR_SKIP = 1
16791
+ }
16792
+
16723
16793
  /** Properties of a LaunchPlanClosure. */
16724
16794
  interface ILaunchPlanClosure {
16725
16795
 
@@ -40292,6 +40292,7 @@
40292
40292
  * @property {flyteidl.admin.IEnvs|null} [envs] LaunchPlanSpec envs
40293
40293
  * @property {Array.<flyteidl.core.IExecutionEnvAssignment>|null} [executionEnvAssignments] LaunchPlanSpec executionEnvAssignments
40294
40294
  * @property {flyteidl.admin.IClusterAssignment|null} [clusterAssignment] LaunchPlanSpec clusterAssignment
40295
+ * @property {flyteidl.admin.IConcurrencyPolicy|null} [concurrencyPolicy] LaunchPlanSpec concurrencyPolicy
40295
40296
  */
40296
40297
 
40297
40298
  /**
@@ -40454,6 +40455,14 @@
40454
40455
  */
40455
40456
  LaunchPlanSpec.prototype.clusterAssignment = null;
40456
40457
 
40458
+ /**
40459
+ * LaunchPlanSpec concurrencyPolicy.
40460
+ * @member {flyteidl.admin.IConcurrencyPolicy|null|undefined} concurrencyPolicy
40461
+ * @memberof flyteidl.admin.LaunchPlanSpec
40462
+ * @instance
40463
+ */
40464
+ LaunchPlanSpec.prototype.concurrencyPolicy = null;
40465
+
40457
40466
  /**
40458
40467
  * Creates a new LaunchPlanSpec instance using the specified properties.
40459
40468
  * @function create
@@ -40515,6 +40524,8 @@
40515
40524
  $root.flyteidl.core.ExecutionEnvAssignment.encode(message.executionEnvAssignments[i], writer.uint32(/* id 22, wireType 2 =*/178).fork()).ldelim();
40516
40525
  if (message.clusterAssignment != null && message.hasOwnProperty("clusterAssignment"))
40517
40526
  $root.flyteidl.admin.ClusterAssignment.encode(message.clusterAssignment, writer.uint32(/* id 23, wireType 2 =*/186).fork()).ldelim();
40527
+ if (message.concurrencyPolicy != null && message.hasOwnProperty("concurrencyPolicy"))
40528
+ $root.flyteidl.admin.ConcurrencyPolicy.encode(message.concurrencyPolicy, writer.uint32(/* id 24, wireType 2 =*/194).fork()).ldelim();
40518
40529
  return writer;
40519
40530
  };
40520
40531
 
@@ -40592,6 +40603,9 @@
40592
40603
  case 23:
40593
40604
  message.clusterAssignment = $root.flyteidl.admin.ClusterAssignment.decode(reader, reader.uint32());
40594
40605
  break;
40606
+ case 24:
40607
+ message.concurrencyPolicy = $root.flyteidl.admin.ConcurrencyPolicy.decode(reader, reader.uint32());
40608
+ break;
40595
40609
  default:
40596
40610
  reader.skipType(tag & 7);
40597
40611
  break;
@@ -40699,12 +40713,163 @@
40699
40713
  if (error)
40700
40714
  return "clusterAssignment." + error;
40701
40715
  }
40716
+ if (message.concurrencyPolicy != null && message.hasOwnProperty("concurrencyPolicy")) {
40717
+ var error = $root.flyteidl.admin.ConcurrencyPolicy.verify(message.concurrencyPolicy);
40718
+ if (error)
40719
+ return "concurrencyPolicy." + error;
40720
+ }
40702
40721
  return null;
40703
40722
  };
40704
40723
 
40705
40724
  return LaunchPlanSpec;
40706
40725
  })();
40707
40726
 
40727
+ admin.ConcurrencyPolicy = (function() {
40728
+
40729
+ /**
40730
+ * Properties of a ConcurrencyPolicy.
40731
+ * @memberof flyteidl.admin
40732
+ * @interface IConcurrencyPolicy
40733
+ * @property {number|null} [max] ConcurrencyPolicy max
40734
+ * @property {flyteidl.admin.ConcurrencyLimitBehavior|null} [behavior] ConcurrencyPolicy behavior
40735
+ */
40736
+
40737
+ /**
40738
+ * Constructs a new ConcurrencyPolicy.
40739
+ * @memberof flyteidl.admin
40740
+ * @classdesc Represents a ConcurrencyPolicy.
40741
+ * @implements IConcurrencyPolicy
40742
+ * @constructor
40743
+ * @param {flyteidl.admin.IConcurrencyPolicy=} [properties] Properties to set
40744
+ */
40745
+ function ConcurrencyPolicy(properties) {
40746
+ if (properties)
40747
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
40748
+ if (properties[keys[i]] != null)
40749
+ this[keys[i]] = properties[keys[i]];
40750
+ }
40751
+
40752
+ /**
40753
+ * ConcurrencyPolicy max.
40754
+ * @member {number} max
40755
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40756
+ * @instance
40757
+ */
40758
+ ConcurrencyPolicy.prototype.max = 0;
40759
+
40760
+ /**
40761
+ * ConcurrencyPolicy behavior.
40762
+ * @member {flyteidl.admin.ConcurrencyLimitBehavior} behavior
40763
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40764
+ * @instance
40765
+ */
40766
+ ConcurrencyPolicy.prototype.behavior = 0;
40767
+
40768
+ /**
40769
+ * Creates a new ConcurrencyPolicy instance using the specified properties.
40770
+ * @function create
40771
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40772
+ * @static
40773
+ * @param {flyteidl.admin.IConcurrencyPolicy=} [properties] Properties to set
40774
+ * @returns {flyteidl.admin.ConcurrencyPolicy} ConcurrencyPolicy instance
40775
+ */
40776
+ ConcurrencyPolicy.create = function create(properties) {
40777
+ return new ConcurrencyPolicy(properties);
40778
+ };
40779
+
40780
+ /**
40781
+ * Encodes the specified ConcurrencyPolicy message. Does not implicitly {@link flyteidl.admin.ConcurrencyPolicy.verify|verify} messages.
40782
+ * @function encode
40783
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40784
+ * @static
40785
+ * @param {flyteidl.admin.IConcurrencyPolicy} message ConcurrencyPolicy message or plain object to encode
40786
+ * @param {$protobuf.Writer} [writer] Writer to encode to
40787
+ * @returns {$protobuf.Writer} Writer
40788
+ */
40789
+ ConcurrencyPolicy.encode = function encode(message, writer) {
40790
+ if (!writer)
40791
+ writer = $Writer.create();
40792
+ if (message.max != null && message.hasOwnProperty("max"))
40793
+ writer.uint32(/* id 1, wireType 0 =*/8).int32(message.max);
40794
+ if (message.behavior != null && message.hasOwnProperty("behavior"))
40795
+ writer.uint32(/* id 2, wireType 0 =*/16).int32(message.behavior);
40796
+ return writer;
40797
+ };
40798
+
40799
+ /**
40800
+ * Decodes a ConcurrencyPolicy message from the specified reader or buffer.
40801
+ * @function decode
40802
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40803
+ * @static
40804
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
40805
+ * @param {number} [length] Message length if known beforehand
40806
+ * @returns {flyteidl.admin.ConcurrencyPolicy} ConcurrencyPolicy
40807
+ * @throws {Error} If the payload is not a reader or valid buffer
40808
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
40809
+ */
40810
+ ConcurrencyPolicy.decode = function decode(reader, length) {
40811
+ if (!(reader instanceof $Reader))
40812
+ reader = $Reader.create(reader);
40813
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.ConcurrencyPolicy();
40814
+ while (reader.pos < end) {
40815
+ var tag = reader.uint32();
40816
+ switch (tag >>> 3) {
40817
+ case 1:
40818
+ message.max = reader.int32();
40819
+ break;
40820
+ case 2:
40821
+ message.behavior = reader.int32();
40822
+ break;
40823
+ default:
40824
+ reader.skipType(tag & 7);
40825
+ break;
40826
+ }
40827
+ }
40828
+ return message;
40829
+ };
40830
+
40831
+ /**
40832
+ * Verifies a ConcurrencyPolicy message.
40833
+ * @function verify
40834
+ * @memberof flyteidl.admin.ConcurrencyPolicy
40835
+ * @static
40836
+ * @param {Object.<string,*>} message Plain object to verify
40837
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
40838
+ */
40839
+ ConcurrencyPolicy.verify = function verify(message) {
40840
+ if (typeof message !== "object" || message === null)
40841
+ return "object expected";
40842
+ if (message.max != null && message.hasOwnProperty("max"))
40843
+ if (!$util.isInteger(message.max))
40844
+ return "max: integer expected";
40845
+ if (message.behavior != null && message.hasOwnProperty("behavior"))
40846
+ switch (message.behavior) {
40847
+ default:
40848
+ return "behavior: enum value expected";
40849
+ case 0:
40850
+ case 1:
40851
+ break;
40852
+ }
40853
+ return null;
40854
+ };
40855
+
40856
+ return ConcurrencyPolicy;
40857
+ })();
40858
+
40859
+ /**
40860
+ * ConcurrencyLimitBehavior enum.
40861
+ * @name flyteidl.admin.ConcurrencyLimitBehavior
40862
+ * @enum {string}
40863
+ * @property {number} CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED=0 CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED value
40864
+ * @property {number} CONCURRENCY_LIMIT_BEHAVIOR_SKIP=1 CONCURRENCY_LIMIT_BEHAVIOR_SKIP value
40865
+ */
40866
+ admin.ConcurrencyLimitBehavior = (function() {
40867
+ var valuesById = {}, values = Object.create(valuesById);
40868
+ values[valuesById[0] = "CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED"] = 0;
40869
+ values[valuesById[1] = "CONCURRENCY_LIMIT_BEHAVIOR_SKIP"] = 1;
40870
+ return values;
40871
+ })();
40872
+
40708
40873
  admin.LaunchPlanClosure = (function() {
40709
40874
 
40710
40875
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flyteorg/flyteidl",
3
- "version": "1.16.0",
3
+ "version": "1.16.2",
4
4
  "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -144,6 +144,24 @@ message LaunchPlanSpec {
144
144
  // ClusterAssignment controls how to select an available cluster on which executions of this LaunchPlan should run.
145
145
  // This can be overwritten at execution creation level.
146
146
  ClusterAssignment cluster_assignment = 23;
147
+
148
+ // Concurrency setting for a given workflow to determine concurrency limits and behavior when the limit is breached
149
+ ConcurrencyPolicy concurrency_policy = 24;
150
+ }
151
+
152
+ message ConcurrencyPolicy {
153
+ // A setting for the maximum number of concurrent workflows
154
+ int32 max = 1;
155
+
156
+ // Descriptor for workflow execution behavior after the concurrency limit is hit
157
+ ConcurrencyLimitBehavior behavior = 2;
158
+ }
159
+
160
+ enum ConcurrencyLimitBehavior {
161
+ CONCURRENCY_LIMIT_BEHAVIOR_UNSPECIFIED = 0;
162
+
163
+ // A workflow that will be skipped because the limit has been hit.
164
+ CONCURRENCY_LIMIT_BEHAVIOR_SKIP = 1;
147
165
  }
148
166
 
149
167
  // Values computed by the flyte platform after launch plan registration.