@flyteorg/flyteidl 1.3.11 → 1.3.13

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.
@@ -5635,6 +5635,9 @@ export namespace flyteidl {
5635
5635
 
5636
5636
  /** K8sPod podSpec */
5637
5637
  podSpec?: (google.protobuf.IStruct|null);
5638
+
5639
+ /** K8sPod dataConfig */
5640
+ dataConfig?: (flyteidl.core.IDataLoadingConfig|null);
5638
5641
  }
5639
5642
 
5640
5643
  /** Represents a K8sPod. */
@@ -5652,6 +5655,9 @@ export namespace flyteidl {
5652
5655
  /** K8sPod podSpec. */
5653
5656
  public podSpec?: (google.protobuf.IStruct|null);
5654
5657
 
5658
+ /** K8sPod dataConfig. */
5659
+ public dataConfig?: (flyteidl.core.IDataLoadingConfig|null);
5660
+
5655
5661
  /**
5656
5662
  * Creates a new K8sPod instance using the specified properties.
5657
5663
  * @param [properties] Properties to set
@@ -15901,6 +15907,9 @@ export namespace flyteidl {
15901
15907
 
15902
15908
  /** TaskExecutionClosure eventVersion */
15903
15909
  eventVersion?: (number|null);
15910
+
15911
+ /** TaskExecutionClosure reasons */
15912
+ reasons?: (flyteidl.admin.IReason[]|null);
15904
15913
  }
15905
15914
 
15906
15915
  /** Represents a TaskExecutionClosure. */
@@ -15954,6 +15963,9 @@ export namespace flyteidl {
15954
15963
  /** TaskExecutionClosure eventVersion. */
15955
15964
  public eventVersion: number;
15956
15965
 
15966
+ /** TaskExecutionClosure reasons. */
15967
+ public reasons: flyteidl.admin.IReason[];
15968
+
15957
15969
  /** TaskExecutionClosure outputResult. */
15958
15970
  public outputResult?: ("outputUri"|"error"|"outputData");
15959
15971
 
@@ -15990,6 +16002,64 @@ export namespace flyteidl {
15990
16002
  public static verify(message: { [k: string]: any }): (string|null);
15991
16003
  }
15992
16004
 
16005
+ /** Properties of a Reason. */
16006
+ interface IReason {
16007
+
16008
+ /** Reason occurredAt */
16009
+ occurredAt?: (google.protobuf.ITimestamp|null);
16010
+
16011
+ /** Reason message */
16012
+ message?: (string|null);
16013
+ }
16014
+
16015
+ /** Represents a Reason. */
16016
+ class Reason implements IReason {
16017
+
16018
+ /**
16019
+ * Constructs a new Reason.
16020
+ * @param [properties] Properties to set
16021
+ */
16022
+ constructor(properties?: flyteidl.admin.IReason);
16023
+
16024
+ /** Reason occurredAt. */
16025
+ public occurredAt?: (google.protobuf.ITimestamp|null);
16026
+
16027
+ /** Reason message. */
16028
+ public message: string;
16029
+
16030
+ /**
16031
+ * Creates a new Reason instance using the specified properties.
16032
+ * @param [properties] Properties to set
16033
+ * @returns Reason instance
16034
+ */
16035
+ public static create(properties?: flyteidl.admin.IReason): flyteidl.admin.Reason;
16036
+
16037
+ /**
16038
+ * Encodes the specified Reason message. Does not implicitly {@link flyteidl.admin.Reason.verify|verify} messages.
16039
+ * @param message Reason message or plain object to encode
16040
+ * @param [writer] Writer to encode to
16041
+ * @returns Writer
16042
+ */
16043
+ public static encode(message: flyteidl.admin.IReason, writer?: $protobuf.Writer): $protobuf.Writer;
16044
+
16045
+ /**
16046
+ * Decodes a Reason message from the specified reader or buffer.
16047
+ * @param reader Reader or buffer to decode from
16048
+ * @param [length] Message length if known beforehand
16049
+ * @returns Reason
16050
+ * @throws {Error} If the payload is not a reader or valid buffer
16051
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
16052
+ */
16053
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.Reason;
16054
+
16055
+ /**
16056
+ * Verifies a Reason message.
16057
+ * @param message Plain object to verify
16058
+ * @returns `null` if valid, otherwise the reason why it is not
16059
+ */
16060
+ public static verify(message: { [k: string]: any }): (string|null);
16061
+ }
16062
+
15993
16063
  /** Properties of a TaskExecutionGetDataRequest. */
15994
16064
  interface ITaskExecutionGetDataRequest {
15995
16065
 
@@ -13498,6 +13498,7 @@
13498
13498
  * @interface IK8sPod
13499
13499
  * @property {flyteidl.core.IK8sObjectMetadata|null} [metadata] K8sPod metadata
13500
13500
  * @property {google.protobuf.IStruct|null} [podSpec] K8sPod podSpec
13501
+ * @property {flyteidl.core.IDataLoadingConfig|null} [dataConfig] K8sPod dataConfig
13501
13502
  */
13502
13503
 
13503
13504
  /**
@@ -13531,6 +13532,14 @@
13531
13532
  */
13532
13533
  K8sPod.prototype.podSpec = null;
13533
13534
 
13535
+ /**
13536
+ * K8sPod dataConfig.
13537
+ * @member {flyteidl.core.IDataLoadingConfig|null|undefined} dataConfig
13538
+ * @memberof flyteidl.core.K8sPod
13539
+ * @instance
13540
+ */
13541
+ K8sPod.prototype.dataConfig = null;
13542
+
13534
13543
  /**
13535
13544
  * Creates a new K8sPod instance using the specified properties.
13536
13545
  * @function create
@@ -13559,6 +13568,8 @@
13559
13568
  $root.flyteidl.core.K8sObjectMetadata.encode(message.metadata, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
13560
13569
  if (message.podSpec != null && message.hasOwnProperty("podSpec"))
13561
13570
  $root.google.protobuf.Struct.encode(message.podSpec, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
13571
+ if (message.dataConfig != null && message.hasOwnProperty("dataConfig"))
13572
+ $root.flyteidl.core.DataLoadingConfig.encode(message.dataConfig, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
13562
13573
  return writer;
13563
13574
  };
13564
13575
 
@@ -13586,6 +13597,9 @@
13586
13597
  case 2:
13587
13598
  message.podSpec = $root.google.protobuf.Struct.decode(reader, reader.uint32());
13588
13599
  break;
13600
+ case 3:
13601
+ message.dataConfig = $root.flyteidl.core.DataLoadingConfig.decode(reader, reader.uint32());
13602
+ break;
13589
13603
  default:
13590
13604
  reader.skipType(tag & 7);
13591
13605
  break;
@@ -13615,6 +13629,11 @@
13615
13629
  if (error)
13616
13630
  return "podSpec." + error;
13617
13631
  }
13632
+ if (message.dataConfig != null && message.hasOwnProperty("dataConfig")) {
13633
+ var error = $root.flyteidl.core.DataLoadingConfig.verify(message.dataConfig);
13634
+ if (error)
13635
+ return "dataConfig." + error;
13636
+ }
13618
13637
  return null;
13619
13638
  };
13620
13639
 
@@ -37870,6 +37889,7 @@
37870
37889
  * @property {string|null} [taskType] TaskExecutionClosure taskType
37871
37890
  * @property {flyteidl.event.ITaskExecutionMetadata|null} [metadata] TaskExecutionClosure metadata
37872
37891
  * @property {number|null} [eventVersion] TaskExecutionClosure eventVersion
37892
+ * @property {Array.<flyteidl.admin.IReason>|null} [reasons] TaskExecutionClosure reasons
37873
37893
  */
37874
37894
 
37875
37895
  /**
@@ -37882,6 +37902,7 @@
37882
37902
  */
37883
37903
  function TaskExecutionClosure(properties) {
37884
37904
  this.logs = [];
37905
+ this.reasons = [];
37885
37906
  if (properties)
37886
37907
  for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
37887
37908
  if (properties[keys[i]] != null)
@@ -38000,6 +38021,14 @@
38000
38021
  */
38001
38022
  TaskExecutionClosure.prototype.eventVersion = 0;
38002
38023
 
38024
+ /**
38025
+ * TaskExecutionClosure reasons.
38026
+ * @member {Array.<flyteidl.admin.IReason>} reasons
38027
+ * @memberof flyteidl.admin.TaskExecutionClosure
38028
+ * @instance
38029
+ */
38030
+ TaskExecutionClosure.prototype.reasons = $util.emptyArray;
38031
+
38003
38032
  // OneOf field names bound to virtual getters and setters
38004
38033
  var $oneOfFields;
38005
38034
 
@@ -38067,6 +38096,9 @@
38067
38096
  $root.flyteidl.event.TaskExecutionMetadata.encode(message.metadata, writer.uint32(/* id 16, wireType 2 =*/130).fork()).ldelim();
38068
38097
  if (message.eventVersion != null && message.hasOwnProperty("eventVersion"))
38069
38098
  writer.uint32(/* id 17, wireType 0 =*/136).int32(message.eventVersion);
38099
+ if (message.reasons != null && message.reasons.length)
38100
+ for (var i = 0; i < message.reasons.length; ++i)
38101
+ $root.flyteidl.admin.Reason.encode(message.reasons[i], writer.uint32(/* id 18, wireType 2 =*/146).fork()).ldelim();
38070
38102
  return writer;
38071
38103
  };
38072
38104
 
@@ -38132,6 +38164,11 @@
38132
38164
  case 17:
38133
38165
  message.eventVersion = reader.int32();
38134
38166
  break;
38167
+ case 18:
38168
+ if (!(message.reasons && message.reasons.length))
38169
+ message.reasons = [];
38170
+ message.reasons.push($root.flyteidl.admin.Reason.decode(reader, reader.uint32()));
38171
+ break;
38135
38172
  default:
38136
38173
  reader.skipType(tag & 7);
38137
38174
  break;
@@ -38239,12 +38276,150 @@
38239
38276
  if (message.eventVersion != null && message.hasOwnProperty("eventVersion"))
38240
38277
  if (!$util.isInteger(message.eventVersion))
38241
38278
  return "eventVersion: integer expected";
38279
+ if (message.reasons != null && message.hasOwnProperty("reasons")) {
38280
+ if (!Array.isArray(message.reasons))
38281
+ return "reasons: array expected";
38282
+ for (var i = 0; i < message.reasons.length; ++i) {
38283
+ var error = $root.flyteidl.admin.Reason.verify(message.reasons[i]);
38284
+ if (error)
38285
+ return "reasons." + error;
38286
+ }
38287
+ }
38242
38288
  return null;
38243
38289
  };
38244
38290
 
38245
38291
  return TaskExecutionClosure;
38246
38292
  })();
38247
38293
 
38294
+ admin.Reason = (function() {
38295
+
38296
+ /**
38297
+ * Properties of a Reason.
38298
+ * @memberof flyteidl.admin
38299
+ * @interface IReason
38300
+ * @property {google.protobuf.ITimestamp|null} [occurredAt] Reason occurredAt
38301
+ * @property {string|null} [message] Reason message
38302
+ */
38303
+
38304
+ /**
38305
+ * Constructs a new Reason.
38306
+ * @memberof flyteidl.admin
38307
+ * @classdesc Represents a Reason.
38308
+ * @implements IReason
38309
+ * @constructor
38310
+ * @param {flyteidl.admin.IReason=} [properties] Properties to set
38311
+ */
38312
+ function Reason(properties) {
38313
+ if (properties)
38314
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
38315
+ if (properties[keys[i]] != null)
38316
+ this[keys[i]] = properties[keys[i]];
38317
+ }
38318
+
38319
+ /**
38320
+ * Reason occurredAt.
38321
+ * @member {google.protobuf.ITimestamp|null|undefined} occurredAt
38322
+ * @memberof flyteidl.admin.Reason
38323
+ * @instance
38324
+ */
38325
+ Reason.prototype.occurredAt = null;
38326
+
38327
+ /**
38328
+ * Reason message.
38329
+ * @member {string} message
38330
+ * @memberof flyteidl.admin.Reason
38331
+ * @instance
38332
+ */
38333
+ Reason.prototype.message = "";
38334
+
38335
+ /**
38336
+ * Creates a new Reason instance using the specified properties.
38337
+ * @function create
38338
+ * @memberof flyteidl.admin.Reason
38339
+ * @static
38340
+ * @param {flyteidl.admin.IReason=} [properties] Properties to set
38341
+ * @returns {flyteidl.admin.Reason} Reason instance
38342
+ */
38343
+ Reason.create = function create(properties) {
38344
+ return new Reason(properties);
38345
+ };
38346
+
38347
+ /**
38348
+ * Encodes the specified Reason message. Does not implicitly {@link flyteidl.admin.Reason.verify|verify} messages.
38349
+ * @function encode
38350
+ * @memberof flyteidl.admin.Reason
38351
+ * @static
38352
+ * @param {flyteidl.admin.IReason} message Reason message or plain object to encode
38353
+ * @param {$protobuf.Writer} [writer] Writer to encode to
38354
+ * @returns {$protobuf.Writer} Writer
38355
+ */
38356
+ Reason.encode = function encode(message, writer) {
38357
+ if (!writer)
38358
+ writer = $Writer.create();
38359
+ if (message.occurredAt != null && message.hasOwnProperty("occurredAt"))
38360
+ $root.google.protobuf.Timestamp.encode(message.occurredAt, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
38361
+ if (message.message != null && message.hasOwnProperty("message"))
38362
+ writer.uint32(/* id 2, wireType 2 =*/18).string(message.message);
38363
+ return writer;
38364
+ };
38365
+
38366
+ /**
38367
+ * Decodes a Reason message from the specified reader or buffer.
38368
+ * @function decode
38369
+ * @memberof flyteidl.admin.Reason
38370
+ * @static
38371
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
38372
+ * @param {number} [length] Message length if known beforehand
38373
+ * @returns {flyteidl.admin.Reason} Reason
38374
+ * @throws {Error} If the payload is not a reader or valid buffer
38375
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
38376
+ */
38377
+ Reason.decode = function decode(reader, length) {
38378
+ if (!(reader instanceof $Reader))
38379
+ reader = $Reader.create(reader);
38380
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.Reason();
38381
+ while (reader.pos < end) {
38382
+ var tag = reader.uint32();
38383
+ switch (tag >>> 3) {
38384
+ case 1:
38385
+ message.occurredAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
38386
+ break;
38387
+ case 2:
38388
+ message.message = reader.string();
38389
+ break;
38390
+ default:
38391
+ reader.skipType(tag & 7);
38392
+ break;
38393
+ }
38394
+ }
38395
+ return message;
38396
+ };
38397
+
38398
+ /**
38399
+ * Verifies a Reason message.
38400
+ * @function verify
38401
+ * @memberof flyteidl.admin.Reason
38402
+ * @static
38403
+ * @param {Object.<string,*>} message Plain object to verify
38404
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
38405
+ */
38406
+ Reason.verify = function verify(message) {
38407
+ if (typeof message !== "object" || message === null)
38408
+ return "object expected";
38409
+ if (message.occurredAt != null && message.hasOwnProperty("occurredAt")) {
38410
+ var error = $root.google.protobuf.Timestamp.verify(message.occurredAt);
38411
+ if (error)
38412
+ return "occurredAt." + error;
38413
+ }
38414
+ if (message.message != null && message.hasOwnProperty("message"))
38415
+ if (!$util.isString(message.message))
38416
+ return "message: string expected";
38417
+ return null;
38418
+ };
38419
+
38420
+ return Reason;
38421
+ })();
38422
+
38248
38423
  admin.TaskExecutionGetDataRequest = (function() {
38249
38424
 
38250
38425
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flyteorg/flyteidl",
3
- "version": "1.3.11",
3
+ "version": "1.3.13",
4
4
  "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -123,6 +123,19 @@ message TaskExecutionClosure {
123
123
  // TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
124
124
  // in this message.
125
125
  int32 event_version = 17;
126
+
127
+ // A time-series of the phase transition or update explanations. This, when compared to storing a singular reason
128
+ // as previously done, is much more valuable in visualizing and understanding historical evaluations.
129
+ repeated Reason reasons = 18;
130
+ }
131
+
132
+ // Reason is a single message annotated with a timestamp to indicate the instant the reason occurred.
133
+ message Reason {
134
+ // occurred_at is the timestamp indicating the instant that this reason happened.
135
+ google.protobuf.Timestamp occurred_at = 1;
136
+
137
+ // message is the explanation for the most recent phase transition or status update.
138
+ string message = 2;
126
139
  }
127
140
 
128
141
  // Request structure to fetch inputs and output for a task execution.
@@ -268,24 +268,32 @@ message DataLoadingConfig {
268
268
 
269
269
  // Defines a pod spec and additional pod metadata that is created when a task is executed.
270
270
  message K8sPod {
271
- // Contains additional metadata for building a kubernetes pod.
272
- K8sObjectMetadata metadata = 1;
273
-
274
- // Defines the primary pod spec created when a task is executed.
275
- // This should be a JSON-marshalled pod spec, which can be defined in
276
- // - go, using: https://github.com/kubernetes/api/blob/release-1.21/core/v1/types.go#L2936
277
- // - python: using https://github.com/kubernetes-client/python/blob/release-19.0/kubernetes/client/models/v1_pod_spec.py
278
- google.protobuf.Struct pod_spec = 2;
271
+ // Contains additional metadata for building a kubernetes pod.
272
+ K8sObjectMetadata metadata = 1;
273
+
274
+ // Defines the primary pod spec created when a task is executed.
275
+ // This should be a JSON-marshalled pod spec, which can be defined in
276
+ // - go, using: https://github.com/kubernetes/api/blob/release-1.21/core/v1/types.go#L2936
277
+ // - python: using https://github.com/kubernetes-client/python/blob/release-19.0/kubernetes/client/models/v1_pod_spec.py
278
+ google.protobuf.Struct pod_spec = 2;
279
+
280
+ // BETA: Optional configuration for DataLoading. If not specified, then default values are used.
281
+ // This makes it possible to to run a completely portable container, that uses inputs and outputs
282
+ // only from the local file-system and without having any reference to flytekit. This is supported only on K8s at the moment.
283
+ // If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories
284
+ // are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation
285
+ // to understand the default paths.
286
+ // Only K8s
287
+ DataLoadingConfig data_config = 3;
279
288
  }
280
289
 
281
290
  // Metadata for building a kubernetes object when a task is executed.
282
291
  message K8sObjectMetadata {
292
+ // Optional labels to add to the pod definition.
293
+ map<string, string> labels = 1;
283
294
 
284
- // Optional labels to add to the pod definition.
285
- map<string, string> labels = 1;
286
-
287
- // Optional annotations to add to the pod definition.
288
- map<string, string> annotations = 2;
295
+ // Optional annotations to add to the pod definition.
296
+ map<string, string> annotations = 2;
289
297
  }
290
298
 
291
299
  // Sql represents a generic sql workload with a statement and dialect.