@flyteorg/flyteidl 1.13.9 → 1.14.1

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.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Flyteidl
2
2
 
3
- This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
3
+ This is one of the core components of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
4
4
 
5
5
 
6
6
  [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
@@ -11,69 +11,4 @@ This is one of the core repositories of Flyte. It contains the Specification of
11
11
 
12
12
  ## Contributing to Flyteidl
13
13
 
14
- ## Tooling for Flyteidl
15
-
16
- 1. Run ``make download_tooling`` to install generator dependencies.
17
-
18
- ```bash
19
- make download_tooling
20
- ```
21
-
22
- 2. Ensure Docker is installed locally.
23
- 3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
24
-
25
- ```bash
26
- make generate
27
- ```
28
-
29
- 4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
30
-
31
- ```bash
32
- make doc-requirements.txt
33
- ```
34
-
35
- ## Docs structure
36
-
37
- The index.rst files for protos are arranged in parallel under the ``docs`` folder.
38
- All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
39
-
40
- ```
41
- docs
42
- ├── admin
43
- │   ├── admin.rst
44
- │   └── index.rst
45
- ├── core
46
- │   ├── core.rst
47
- │   └── index.rst
48
- ├── datacatalog
49
- │   ├── datacatalog.rst
50
- │   └── index.rst
51
- ├── event
52
- │   ├── event.rst
53
- │   └── index.rst
54
- ├── plugins
55
- │   ├── index.rst
56
- │   └── plugins.rst
57
- ├── service
58
- │   ├── index.rst
59
- │   └── service.rst
60
- ```
61
-
62
- Each module in protos has a module in docs with the same name.
63
- For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
64
-
65
-
66
- ## Generating Documentation
67
-
68
- * If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
69
- ```
70
- core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
71
- # Remove any currently generated file
72
- ls -d protos/docs/core/* | grep -v index.rst | xargs rm
73
- protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
74
- ```
75
-
76
- * ``make generate`` generates the modified rst files.
77
-
78
- * ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
79
-
14
+ See the [contributing docs](protos/docs/contributing.md) for more information.
@@ -3797,6 +3797,9 @@ export namespace flyteidl {
3797
3797
  /** BindingData map */
3798
3798
  map?: (flyteidl.core.IBindingDataMap|null);
3799
3799
 
3800
+ /** BindingData offloadedMetadata */
3801
+ offloadedMetadata?: (flyteidl.core.ILiteralOffloadedMetadata|null);
3802
+
3800
3803
  /** BindingData union */
3801
3804
  union?: (flyteidl.core.IUnionInfo|null);
3802
3805
  }
@@ -3822,11 +3825,14 @@ export namespace flyteidl {
3822
3825
  /** BindingData map. */
3823
3826
  public map?: (flyteidl.core.IBindingDataMap|null);
3824
3827
 
3828
+ /** BindingData offloadedMetadata. */
3829
+ public offloadedMetadata?: (flyteidl.core.ILiteralOffloadedMetadata|null);
3830
+
3825
3831
  /** BindingData union. */
3826
3832
  public union?: (flyteidl.core.IUnionInfo|null);
3827
3833
 
3828
3834
  /** BindingData value. */
3829
- public value?: ("scalar"|"collection"|"promise"|"map");
3835
+ public value?: ("scalar"|"collection"|"promise"|"map"|"offloadedMetadata");
3830
3836
 
3831
3837
  /**
3832
3838
  * Creates a new BindingData instance using the specified properties.
@@ -4589,6 +4595,9 @@ export namespace flyteidl {
4589
4595
 
4590
4596
  /** ArrayNode isOriginalSubNodeInterface */
4591
4597
  isOriginalSubNodeInterface?: (google.protobuf.IBoolValue|null);
4598
+
4599
+ /** ArrayNode dataMode */
4600
+ dataMode?: (flyteidl.core.ArrayNode.DataMode|null);
4592
4601
  }
4593
4602
 
4594
4603
  /** Represents an ArrayNode. */
@@ -4618,6 +4627,9 @@ export namespace flyteidl {
4618
4627
  /** ArrayNode isOriginalSubNodeInterface. */
4619
4628
  public isOriginalSubNodeInterface?: (google.protobuf.IBoolValue|null);
4620
4629
 
4630
+ /** ArrayNode dataMode. */
4631
+ public dataMode: flyteidl.core.ArrayNode.DataMode;
4632
+
4621
4633
  /** ArrayNode parallelismOption. */
4622
4634
  public parallelismOption?: "parallelism";
4623
4635
 
@@ -4664,6 +4676,12 @@ export namespace flyteidl {
4664
4676
  MINIMAL_STATE = 0,
4665
4677
  FULL_STATE = 1
4666
4678
  }
4679
+
4680
+ /** DataMode enum. */
4681
+ enum DataMode {
4682
+ SINGLE_INPUT_FILE = 0,
4683
+ INDIVIDUAL_INPUT_FILES = 1
4684
+ }
4667
4685
  }
4668
4686
 
4669
4687
  /** Properties of a NodeMetadata. */
@@ -8082,6 +8100,9 @@ export namespace flyteidl {
8082
8100
 
8083
8101
  /** CloudEventWorkflowExecution launchPlanId */
8084
8102
  launchPlanId?: (flyteidl.core.IIdentifier|null);
8103
+
8104
+ /** CloudEventWorkflowExecution labels */
8105
+ labels?: ({ [k: string]: string }|null);
8085
8106
  }
8086
8107
 
8087
8108
  /** Represents a CloudEventWorkflowExecution. */
@@ -8111,6 +8132,9 @@ export namespace flyteidl {
8111
8132
  /** CloudEventWorkflowExecution launchPlanId. */
8112
8133
  public launchPlanId?: (flyteidl.core.IIdentifier|null);
8113
8134
 
8135
+ /** CloudEventWorkflowExecution labels. */
8136
+ public labels: { [k: string]: string };
8137
+
8114
8138
  /**
8115
8139
  * Creates a new CloudEventWorkflowExecution instance using the specified properties.
8116
8140
  * @param [properties] Properties to set
@@ -8164,6 +8188,9 @@ export namespace flyteidl {
8164
8188
 
8165
8189
  /** CloudEventNodeExecution launchPlanId */
8166
8190
  launchPlanId?: (flyteidl.core.IIdentifier|null);
8191
+
8192
+ /** CloudEventNodeExecution labels */
8193
+ labels?: ({ [k: string]: string }|null);
8167
8194
  }
8168
8195
 
8169
8196
  /** Represents a CloudEventNodeExecution. */
@@ -8193,6 +8220,9 @@ export namespace flyteidl {
8193
8220
  /** CloudEventNodeExecution launchPlanId. */
8194
8221
  public launchPlanId?: (flyteidl.core.IIdentifier|null);
8195
8222
 
8223
+ /** CloudEventNodeExecution labels. */
8224
+ public labels: { [k: string]: string };
8225
+
8196
8226
  /**
8197
8227
  * Creates a new CloudEventNodeExecution instance using the specified properties.
8198
8228
  * @param [properties] Properties to set
@@ -8231,6 +8261,9 @@ export namespace flyteidl {
8231
8261
 
8232
8262
  /** CloudEventTaskExecution rawEvent */
8233
8263
  rawEvent?: (flyteidl.event.ITaskExecutionEvent|null);
8264
+
8265
+ /** CloudEventTaskExecution labels */
8266
+ labels?: ({ [k: string]: string }|null);
8234
8267
  }
8235
8268
 
8236
8269
  /** Represents a CloudEventTaskExecution. */
@@ -8245,6 +8278,9 @@ export namespace flyteidl {
8245
8278
  /** CloudEventTaskExecution rawEvent. */
8246
8279
  public rawEvent?: (flyteidl.event.ITaskExecutionEvent|null);
8247
8280
 
8281
+ /** CloudEventTaskExecution labels. */
8282
+ public labels: { [k: string]: string };
8283
+
8248
8284
  /**
8249
8285
  * Creates a new CloudEventTaskExecution instance using the specified properties.
8250
8286
  * @param [properties] Properties to set
@@ -10034,6 +10070,9 @@ export namespace flyteidl {
10034
10070
 
10035
10071
  /** Resource customInfo */
10036
10072
  customInfo?: (google.protobuf.IStruct|null);
10073
+
10074
+ /** Resource agentError */
10075
+ agentError?: (flyteidl.admin.IAgentError|null);
10037
10076
  }
10038
10077
 
10039
10078
  /** Represents a Resource. */
@@ -10063,6 +10102,9 @@ export namespace flyteidl {
10063
10102
  /** Resource customInfo. */
10064
10103
  public customInfo?: (google.protobuf.IStruct|null);
10065
10104
 
10105
+ /** Resource agentError. */
10106
+ public agentError?: (flyteidl.admin.IAgentError|null);
10107
+
10066
10108
  /**
10067
10109
  * Creates a new Resource instance using the specified properties.
10068
10110
  * @param [properties] Properties to set
@@ -10917,6 +10959,79 @@ export namespace flyteidl {
10917
10959
  public static verify(message: { [k: string]: any }): (string|null);
10918
10960
  }
10919
10961
 
10962
+ /** Properties of an AgentError. */
10963
+ interface IAgentError {
10964
+
10965
+ /** AgentError code */
10966
+ code?: (string|null);
10967
+
10968
+ /** AgentError kind */
10969
+ kind?: (flyteidl.admin.AgentError.Kind|null);
10970
+
10971
+ /** AgentError origin */
10972
+ origin?: (flyteidl.core.ExecutionError.ErrorKind|null);
10973
+ }
10974
+
10975
+ /** Represents an AgentError. */
10976
+ class AgentError implements IAgentError {
10977
+
10978
+ /**
10979
+ * Constructs a new AgentError.
10980
+ * @param [properties] Properties to set
10981
+ */
10982
+ constructor(properties?: flyteidl.admin.IAgentError);
10983
+
10984
+ /** AgentError code. */
10985
+ public code: string;
10986
+
10987
+ /** AgentError kind. */
10988
+ public kind: flyteidl.admin.AgentError.Kind;
10989
+
10990
+ /** AgentError origin. */
10991
+ public origin: flyteidl.core.ExecutionError.ErrorKind;
10992
+
10993
+ /**
10994
+ * Creates a new AgentError instance using the specified properties.
10995
+ * @param [properties] Properties to set
10996
+ * @returns AgentError instance
10997
+ */
10998
+ public static create(properties?: flyteidl.admin.IAgentError): flyteidl.admin.AgentError;
10999
+
11000
+ /**
11001
+ * Encodes the specified AgentError message. Does not implicitly {@link flyteidl.admin.AgentError.verify|verify} messages.
11002
+ * @param message AgentError message or plain object to encode
11003
+ * @param [writer] Writer to encode to
11004
+ * @returns Writer
11005
+ */
11006
+ public static encode(message: flyteidl.admin.IAgentError, writer?: $protobuf.Writer): $protobuf.Writer;
11007
+
11008
+ /**
11009
+ * Decodes an AgentError message from the specified reader or buffer.
11010
+ * @param reader Reader or buffer to decode from
11011
+ * @param [length] Message length if known beforehand
11012
+ * @returns AgentError
11013
+ * @throws {Error} If the payload is not a reader or valid buffer
11014
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
11015
+ */
11016
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.AgentError;
11017
+
11018
+ /**
11019
+ * Verifies an AgentError message.
11020
+ * @param message Plain object to verify
11021
+ * @returns `null` if valid, otherwise the reason why it is not
11022
+ */
11023
+ public static verify(message: { [k: string]: any }): (string|null);
11024
+ }
11025
+
11026
+ namespace AgentError {
11027
+
11028
+ /** Kind enum. */
11029
+ enum Kind {
11030
+ NON_RECOVERABLE = 0,
11031
+ RECOVERABLE = 1
11032
+ }
11033
+ }
11034
+
10920
11035
  /** Properties of a ClusterAssignment. */
10921
11036
  interface IClusterAssignment {
10922
11037
 
@@ -9102,6 +9102,7 @@
9102
9102
  * @property {flyteidl.core.IBindingDataCollection|null} [collection] BindingData collection
9103
9103
  * @property {flyteidl.core.IOutputReference|null} [promise] BindingData promise
9104
9104
  * @property {flyteidl.core.IBindingDataMap|null} [map] BindingData map
9105
+ * @property {flyteidl.core.ILiteralOffloadedMetadata|null} [offloadedMetadata] BindingData offloadedMetadata
9105
9106
  * @property {flyteidl.core.IUnionInfo|null} [union] BindingData union
9106
9107
  */
9107
9108
 
@@ -9152,6 +9153,14 @@
9152
9153
  */
9153
9154
  BindingData.prototype.map = null;
9154
9155
 
9156
+ /**
9157
+ * BindingData offloadedMetadata.
9158
+ * @member {flyteidl.core.ILiteralOffloadedMetadata|null|undefined} offloadedMetadata
9159
+ * @memberof flyteidl.core.BindingData
9160
+ * @instance
9161
+ */
9162
+ BindingData.prototype.offloadedMetadata = null;
9163
+
9155
9164
  /**
9156
9165
  * BindingData union.
9157
9166
  * @member {flyteidl.core.IUnionInfo|null|undefined} union
@@ -9165,12 +9174,12 @@
9165
9174
 
9166
9175
  /**
9167
9176
  * BindingData value.
9168
- * @member {"scalar"|"collection"|"promise"|"map"|undefined} value
9177
+ * @member {"scalar"|"collection"|"promise"|"map"|"offloadedMetadata"|undefined} value
9169
9178
  * @memberof flyteidl.core.BindingData
9170
9179
  * @instance
9171
9180
  */
9172
9181
  Object.defineProperty(BindingData.prototype, "value", {
9173
- get: $util.oneOfGetter($oneOfFields = ["scalar", "collection", "promise", "map"]),
9182
+ get: $util.oneOfGetter($oneOfFields = ["scalar", "collection", "promise", "map", "offloadedMetadata"]),
9174
9183
  set: $util.oneOfSetter($oneOfFields)
9175
9184
  });
9176
9185
 
@@ -9208,6 +9217,8 @@
9208
9217
  $root.flyteidl.core.BindingDataMap.encode(message.map, writer.uint32(/* id 4, wireType 2 =*/34).fork()).ldelim();
9209
9218
  if (message.union != null && message.hasOwnProperty("union"))
9210
9219
  $root.flyteidl.core.UnionInfo.encode(message.union, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
9220
+ if (message.offloadedMetadata != null && message.hasOwnProperty("offloadedMetadata"))
9221
+ $root.flyteidl.core.LiteralOffloadedMetadata.encode(message.offloadedMetadata, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
9211
9222
  return writer;
9212
9223
  };
9213
9224
 
@@ -9241,6 +9252,9 @@
9241
9252
  case 4:
9242
9253
  message.map = $root.flyteidl.core.BindingDataMap.decode(reader, reader.uint32());
9243
9254
  break;
9255
+ case 6:
9256
+ message.offloadedMetadata = $root.flyteidl.core.LiteralOffloadedMetadata.decode(reader, reader.uint32());
9257
+ break;
9244
9258
  case 5:
9245
9259
  message.union = $root.flyteidl.core.UnionInfo.decode(reader, reader.uint32());
9246
9260
  break;
@@ -9302,6 +9316,16 @@
9302
9316
  return "map." + error;
9303
9317
  }
9304
9318
  }
9319
+ if (message.offloadedMetadata != null && message.hasOwnProperty("offloadedMetadata")) {
9320
+ if (properties.value === 1)
9321
+ return "value: multiple values";
9322
+ properties.value = 1;
9323
+ {
9324
+ var error = $root.flyteidl.core.LiteralOffloadedMetadata.verify(message.offloadedMetadata);
9325
+ if (error)
9326
+ return "offloadedMetadata." + error;
9327
+ }
9328
+ }
9305
9329
  if (message.union != null && message.hasOwnProperty("union")) {
9306
9330
  var error = $root.flyteidl.core.UnionInfo.verify(message.union);
9307
9331
  if (error)
@@ -10983,6 +11007,7 @@
10983
11007
  * @property {number|null} [minSuccessRatio] ArrayNode minSuccessRatio
10984
11008
  * @property {flyteidl.core.ArrayNode.ExecutionMode|null} [executionMode] ArrayNode executionMode
10985
11009
  * @property {google.protobuf.IBoolValue|null} [isOriginalSubNodeInterface] ArrayNode isOriginalSubNodeInterface
11010
+ * @property {flyteidl.core.ArrayNode.DataMode|null} [dataMode] ArrayNode dataMode
10986
11011
  */
10987
11012
 
10988
11013
  /**
@@ -11048,6 +11073,14 @@
11048
11073
  */
11049
11074
  ArrayNode.prototype.isOriginalSubNodeInterface = null;
11050
11075
 
11076
+ /**
11077
+ * ArrayNode dataMode.
11078
+ * @member {flyteidl.core.ArrayNode.DataMode} dataMode
11079
+ * @memberof flyteidl.core.ArrayNode
11080
+ * @instance
11081
+ */
11082
+ ArrayNode.prototype.dataMode = 0;
11083
+
11051
11084
  // OneOf field names bound to virtual getters and setters
11052
11085
  var $oneOfFields;
11053
11086
 
@@ -11109,6 +11142,8 @@
11109
11142
  writer.uint32(/* id 5, wireType 0 =*/40).int32(message.executionMode);
11110
11143
  if (message.isOriginalSubNodeInterface != null && message.hasOwnProperty("isOriginalSubNodeInterface"))
11111
11144
  $root.google.protobuf.BoolValue.encode(message.isOriginalSubNodeInterface, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
11145
+ if (message.dataMode != null && message.hasOwnProperty("dataMode"))
11146
+ writer.uint32(/* id 7, wireType 0 =*/56).int32(message.dataMode);
11112
11147
  return writer;
11113
11148
  };
11114
11149
 
@@ -11148,6 +11183,9 @@
11148
11183
  case 6:
11149
11184
  message.isOriginalSubNodeInterface = $root.google.protobuf.BoolValue.decode(reader, reader.uint32());
11150
11185
  break;
11186
+ case 7:
11187
+ message.dataMode = reader.int32();
11188
+ break;
11151
11189
  default:
11152
11190
  reader.skipType(tag & 7);
11153
11191
  break;
@@ -11203,6 +11241,14 @@
11203
11241
  if (error)
11204
11242
  return "isOriginalSubNodeInterface." + error;
11205
11243
  }
11244
+ if (message.dataMode != null && message.hasOwnProperty("dataMode"))
11245
+ switch (message.dataMode) {
11246
+ default:
11247
+ return "dataMode: enum value expected";
11248
+ case 0:
11249
+ case 1:
11250
+ break;
11251
+ }
11206
11252
  return null;
11207
11253
  };
11208
11254
 
@@ -11220,6 +11266,20 @@
11220
11266
  return values;
11221
11267
  })();
11222
11268
 
11269
+ /**
11270
+ * DataMode enum.
11271
+ * @name flyteidl.core.ArrayNode.DataMode
11272
+ * @enum {string}
11273
+ * @property {number} SINGLE_INPUT_FILE=0 SINGLE_INPUT_FILE value
11274
+ * @property {number} INDIVIDUAL_INPUT_FILES=1 INDIVIDUAL_INPUT_FILES value
11275
+ */
11276
+ ArrayNode.DataMode = (function() {
11277
+ var valuesById = {}, values = Object.create(valuesById);
11278
+ values[valuesById[0] = "SINGLE_INPUT_FILE"] = 0;
11279
+ values[valuesById[1] = "INDIVIDUAL_INPUT_FILES"] = 1;
11280
+ return values;
11281
+ })();
11282
+
11223
11283
  return ArrayNode;
11224
11284
  })();
11225
11285
 
@@ -19579,6 +19639,7 @@
19579
19639
  * @property {flyteidl.core.IWorkflowExecutionIdentifier|null} [referenceExecution] CloudEventWorkflowExecution referenceExecution
19580
19640
  * @property {string|null} [principal] CloudEventWorkflowExecution principal
19581
19641
  * @property {flyteidl.core.IIdentifier|null} [launchPlanId] CloudEventWorkflowExecution launchPlanId
19642
+ * @property {Object.<string,string>|null} [labels] CloudEventWorkflowExecution labels
19582
19643
  */
19583
19644
 
19584
19645
  /**
@@ -19591,6 +19652,7 @@
19591
19652
  */
19592
19653
  function CloudEventWorkflowExecution(properties) {
19593
19654
  this.artifactIds = [];
19655
+ this.labels = {};
19594
19656
  if (properties)
19595
19657
  for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
19596
19658
  if (properties[keys[i]] != null)
@@ -19645,6 +19707,14 @@
19645
19707
  */
19646
19708
  CloudEventWorkflowExecution.prototype.launchPlanId = null;
19647
19709
 
19710
+ /**
19711
+ * CloudEventWorkflowExecution labels.
19712
+ * @member {Object.<string,string>} labels
19713
+ * @memberof flyteidl.event.CloudEventWorkflowExecution
19714
+ * @instance
19715
+ */
19716
+ CloudEventWorkflowExecution.prototype.labels = $util.emptyObject;
19717
+
19648
19718
  /**
19649
19719
  * Creates a new CloudEventWorkflowExecution instance using the specified properties.
19650
19720
  * @function create
@@ -19682,6 +19752,9 @@
19682
19752
  writer.uint32(/* id 5, wireType 2 =*/42).string(message.principal);
19683
19753
  if (message.launchPlanId != null && message.hasOwnProperty("launchPlanId"))
19684
19754
  $root.flyteidl.core.Identifier.encode(message.launchPlanId, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
19755
+ if (message.labels != null && message.hasOwnProperty("labels"))
19756
+ for (var keys = Object.keys(message.labels), i = 0; i < keys.length; ++i)
19757
+ writer.uint32(/* id 7, wireType 2 =*/58).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim();
19685
19758
  return writer;
19686
19759
  };
19687
19760
 
@@ -19699,7 +19772,7 @@
19699
19772
  CloudEventWorkflowExecution.decode = function decode(reader, length) {
19700
19773
  if (!(reader instanceof $Reader))
19701
19774
  reader = $Reader.create(reader);
19702
- var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventWorkflowExecution();
19775
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventWorkflowExecution(), key;
19703
19776
  while (reader.pos < end) {
19704
19777
  var tag = reader.uint32();
19705
19778
  switch (tag >>> 3) {
@@ -19723,6 +19796,14 @@
19723
19796
  case 6:
19724
19797
  message.launchPlanId = $root.flyteidl.core.Identifier.decode(reader, reader.uint32());
19725
19798
  break;
19799
+ case 7:
19800
+ reader.skip().pos++;
19801
+ if (message.labels === $util.emptyObject)
19802
+ message.labels = {};
19803
+ key = reader.string();
19804
+ reader.pos++;
19805
+ message.labels[key] = reader.string();
19806
+ break;
19726
19807
  default:
19727
19808
  reader.skipType(tag & 7);
19728
19809
  break;
@@ -19774,6 +19855,14 @@
19774
19855
  if (error)
19775
19856
  return "launchPlanId." + error;
19776
19857
  }
19858
+ if (message.labels != null && message.hasOwnProperty("labels")) {
19859
+ if (!$util.isObject(message.labels))
19860
+ return "labels: object expected";
19861
+ var key = Object.keys(message.labels);
19862
+ for (var i = 0; i < key.length; ++i)
19863
+ if (!$util.isString(message.labels[key[i]]))
19864
+ return "labels: string{k:string} expected";
19865
+ }
19777
19866
  return null;
19778
19867
  };
19779
19868
 
@@ -19792,6 +19881,7 @@
19792
19881
  * @property {Array.<flyteidl.core.IArtifactID>|null} [artifactIds] CloudEventNodeExecution artifactIds
19793
19882
  * @property {string|null} [principal] CloudEventNodeExecution principal
19794
19883
  * @property {flyteidl.core.IIdentifier|null} [launchPlanId] CloudEventNodeExecution launchPlanId
19884
+ * @property {Object.<string,string>|null} [labels] CloudEventNodeExecution labels
19795
19885
  */
19796
19886
 
19797
19887
  /**
@@ -19804,6 +19894,7 @@
19804
19894
  */
19805
19895
  function CloudEventNodeExecution(properties) {
19806
19896
  this.artifactIds = [];
19897
+ this.labels = {};
19807
19898
  if (properties)
19808
19899
  for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
19809
19900
  if (properties[keys[i]] != null)
@@ -19858,6 +19949,14 @@
19858
19949
  */
19859
19950
  CloudEventNodeExecution.prototype.launchPlanId = null;
19860
19951
 
19952
+ /**
19953
+ * CloudEventNodeExecution labels.
19954
+ * @member {Object.<string,string>} labels
19955
+ * @memberof flyteidl.event.CloudEventNodeExecution
19956
+ * @instance
19957
+ */
19958
+ CloudEventNodeExecution.prototype.labels = $util.emptyObject;
19959
+
19861
19960
  /**
19862
19961
  * Creates a new CloudEventNodeExecution instance using the specified properties.
19863
19962
  * @function create
@@ -19895,6 +19994,9 @@
19895
19994
  writer.uint32(/* id 5, wireType 2 =*/42).string(message.principal);
19896
19995
  if (message.launchPlanId != null && message.hasOwnProperty("launchPlanId"))
19897
19996
  $root.flyteidl.core.Identifier.encode(message.launchPlanId, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
19997
+ if (message.labels != null && message.hasOwnProperty("labels"))
19998
+ for (var keys = Object.keys(message.labels), i = 0; i < keys.length; ++i)
19999
+ writer.uint32(/* id 7, wireType 2 =*/58).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim();
19898
20000
  return writer;
19899
20001
  };
19900
20002
 
@@ -19912,7 +20014,7 @@
19912
20014
  CloudEventNodeExecution.decode = function decode(reader, length) {
19913
20015
  if (!(reader instanceof $Reader))
19914
20016
  reader = $Reader.create(reader);
19915
- var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventNodeExecution();
20017
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventNodeExecution(), key;
19916
20018
  while (reader.pos < end) {
19917
20019
  var tag = reader.uint32();
19918
20020
  switch (tag >>> 3) {
@@ -19936,6 +20038,14 @@
19936
20038
  case 6:
19937
20039
  message.launchPlanId = $root.flyteidl.core.Identifier.decode(reader, reader.uint32());
19938
20040
  break;
20041
+ case 7:
20042
+ reader.skip().pos++;
20043
+ if (message.labels === $util.emptyObject)
20044
+ message.labels = {};
20045
+ key = reader.string();
20046
+ reader.pos++;
20047
+ message.labels[key] = reader.string();
20048
+ break;
19939
20049
  default:
19940
20050
  reader.skipType(tag & 7);
19941
20051
  break;
@@ -19987,6 +20097,14 @@
19987
20097
  if (error)
19988
20098
  return "launchPlanId." + error;
19989
20099
  }
20100
+ if (message.labels != null && message.hasOwnProperty("labels")) {
20101
+ if (!$util.isObject(message.labels))
20102
+ return "labels: object expected";
20103
+ var key = Object.keys(message.labels);
20104
+ for (var i = 0; i < key.length; ++i)
20105
+ if (!$util.isString(message.labels[key[i]]))
20106
+ return "labels: string{k:string} expected";
20107
+ }
19990
20108
  return null;
19991
20109
  };
19992
20110
 
@@ -20000,6 +20118,7 @@
20000
20118
  * @memberof flyteidl.event
20001
20119
  * @interface ICloudEventTaskExecution
20002
20120
  * @property {flyteidl.event.ITaskExecutionEvent|null} [rawEvent] CloudEventTaskExecution rawEvent
20121
+ * @property {Object.<string,string>|null} [labels] CloudEventTaskExecution labels
20003
20122
  */
20004
20123
 
20005
20124
  /**
@@ -20011,6 +20130,7 @@
20011
20130
  * @param {flyteidl.event.ICloudEventTaskExecution=} [properties] Properties to set
20012
20131
  */
20013
20132
  function CloudEventTaskExecution(properties) {
20133
+ this.labels = {};
20014
20134
  if (properties)
20015
20135
  for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
20016
20136
  if (properties[keys[i]] != null)
@@ -20025,6 +20145,14 @@
20025
20145
  */
20026
20146
  CloudEventTaskExecution.prototype.rawEvent = null;
20027
20147
 
20148
+ /**
20149
+ * CloudEventTaskExecution labels.
20150
+ * @member {Object.<string,string>} labels
20151
+ * @memberof flyteidl.event.CloudEventTaskExecution
20152
+ * @instance
20153
+ */
20154
+ CloudEventTaskExecution.prototype.labels = $util.emptyObject;
20155
+
20028
20156
  /**
20029
20157
  * Creates a new CloudEventTaskExecution instance using the specified properties.
20030
20158
  * @function create
@@ -20051,6 +20179,9 @@
20051
20179
  writer = $Writer.create();
20052
20180
  if (message.rawEvent != null && message.hasOwnProperty("rawEvent"))
20053
20181
  $root.flyteidl.event.TaskExecutionEvent.encode(message.rawEvent, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
20182
+ if (message.labels != null && message.hasOwnProperty("labels"))
20183
+ for (var keys = Object.keys(message.labels), i = 0; i < keys.length; ++i)
20184
+ writer.uint32(/* id 2, wireType 2 =*/18).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.labels[keys[i]]).ldelim();
20054
20185
  return writer;
20055
20186
  };
20056
20187
 
@@ -20068,13 +20199,21 @@
20068
20199
  CloudEventTaskExecution.decode = function decode(reader, length) {
20069
20200
  if (!(reader instanceof $Reader))
20070
20201
  reader = $Reader.create(reader);
20071
- var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventTaskExecution();
20202
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.event.CloudEventTaskExecution(), key;
20072
20203
  while (reader.pos < end) {
20073
20204
  var tag = reader.uint32();
20074
20205
  switch (tag >>> 3) {
20075
20206
  case 1:
20076
20207
  message.rawEvent = $root.flyteidl.event.TaskExecutionEvent.decode(reader, reader.uint32());
20077
20208
  break;
20209
+ case 2:
20210
+ reader.skip().pos++;
20211
+ if (message.labels === $util.emptyObject)
20212
+ message.labels = {};
20213
+ key = reader.string();
20214
+ reader.pos++;
20215
+ message.labels[key] = reader.string();
20216
+ break;
20078
20217
  default:
20079
20218
  reader.skipType(tag & 7);
20080
20219
  break;
@@ -20099,6 +20238,14 @@
20099
20238
  if (error)
20100
20239
  return "rawEvent." + error;
20101
20240
  }
20241
+ if (message.labels != null && message.hasOwnProperty("labels")) {
20242
+ if (!$util.isObject(message.labels))
20243
+ return "labels: object expected";
20244
+ var key = Object.keys(message.labels);
20245
+ for (var i = 0; i < key.length; ++i)
20246
+ if (!$util.isString(message.labels[key[i]]))
20247
+ return "labels: string{k:string} expected";
20248
+ }
20102
20249
  return null;
20103
20250
  };
20104
20251
 
@@ -24598,6 +24745,7 @@
24598
24745
  * @property {Array.<flyteidl.core.ITaskLog>|null} [logLinks] Resource logLinks
24599
24746
  * @property {flyteidl.core.TaskExecution.Phase|null} [phase] Resource phase
24600
24747
  * @property {google.protobuf.IStruct|null} [customInfo] Resource customInfo
24748
+ * @property {flyteidl.admin.IAgentError|null} [agentError] Resource agentError
24601
24749
  */
24602
24750
 
24603
24751
  /**
@@ -24664,6 +24812,14 @@
24664
24812
  */
24665
24813
  Resource.prototype.customInfo = null;
24666
24814
 
24815
+ /**
24816
+ * Resource agentError.
24817
+ * @member {flyteidl.admin.IAgentError|null|undefined} agentError
24818
+ * @memberof flyteidl.admin.Resource
24819
+ * @instance
24820
+ */
24821
+ Resource.prototype.agentError = null;
24822
+
24667
24823
  /**
24668
24824
  * Creates a new Resource instance using the specified properties.
24669
24825
  * @function create
@@ -24701,6 +24857,8 @@
24701
24857
  writer.uint32(/* id 5, wireType 0 =*/40).int32(message.phase);
24702
24858
  if (message.customInfo != null && message.hasOwnProperty("customInfo"))
24703
24859
  $root.google.protobuf.Struct.encode(message.customInfo, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
24860
+ if (message.agentError != null && message.hasOwnProperty("agentError"))
24861
+ $root.flyteidl.admin.AgentError.encode(message.agentError, writer.uint32(/* id 7, wireType 2 =*/58).fork()).ldelim();
24704
24862
  return writer;
24705
24863
  };
24706
24864
 
@@ -24742,6 +24900,9 @@
24742
24900
  case 6:
24743
24901
  message.customInfo = $root.google.protobuf.Struct.decode(reader, reader.uint32());
24744
24902
  break;
24903
+ case 7:
24904
+ message.agentError = $root.flyteidl.admin.AgentError.decode(reader, reader.uint32());
24905
+ break;
24745
24906
  default:
24746
24907
  reader.skipType(tag & 7);
24747
24908
  break;
@@ -24808,6 +24969,11 @@
24808
24969
  if (error)
24809
24970
  return "customInfo." + error;
24810
24971
  }
24972
+ if (message.agentError != null && message.hasOwnProperty("agentError")) {
24973
+ var error = $root.flyteidl.admin.AgentError.verify(message.agentError);
24974
+ if (error)
24975
+ return "agentError." + error;
24976
+ }
24811
24977
  return null;
24812
24978
  };
24813
24979
 
@@ -26704,6 +26870,175 @@
26704
26870
  return GetTaskLogsResponse;
26705
26871
  })();
26706
26872
 
26873
+ admin.AgentError = (function() {
26874
+
26875
+ /**
26876
+ * Properties of an AgentError.
26877
+ * @memberof flyteidl.admin
26878
+ * @interface IAgentError
26879
+ * @property {string|null} [code] AgentError code
26880
+ * @property {flyteidl.admin.AgentError.Kind|null} [kind] AgentError kind
26881
+ * @property {flyteidl.core.ExecutionError.ErrorKind|null} [origin] AgentError origin
26882
+ */
26883
+
26884
+ /**
26885
+ * Constructs a new AgentError.
26886
+ * @memberof flyteidl.admin
26887
+ * @classdesc Represents an AgentError.
26888
+ * @implements IAgentError
26889
+ * @constructor
26890
+ * @param {flyteidl.admin.IAgentError=} [properties] Properties to set
26891
+ */
26892
+ function AgentError(properties) {
26893
+ if (properties)
26894
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
26895
+ if (properties[keys[i]] != null)
26896
+ this[keys[i]] = properties[keys[i]];
26897
+ }
26898
+
26899
+ /**
26900
+ * AgentError code.
26901
+ * @member {string} code
26902
+ * @memberof flyteidl.admin.AgentError
26903
+ * @instance
26904
+ */
26905
+ AgentError.prototype.code = "";
26906
+
26907
+ /**
26908
+ * AgentError kind.
26909
+ * @member {flyteidl.admin.AgentError.Kind} kind
26910
+ * @memberof flyteidl.admin.AgentError
26911
+ * @instance
26912
+ */
26913
+ AgentError.prototype.kind = 0;
26914
+
26915
+ /**
26916
+ * AgentError origin.
26917
+ * @member {flyteidl.core.ExecutionError.ErrorKind} origin
26918
+ * @memberof flyteidl.admin.AgentError
26919
+ * @instance
26920
+ */
26921
+ AgentError.prototype.origin = 0;
26922
+
26923
+ /**
26924
+ * Creates a new AgentError instance using the specified properties.
26925
+ * @function create
26926
+ * @memberof flyteidl.admin.AgentError
26927
+ * @static
26928
+ * @param {flyteidl.admin.IAgentError=} [properties] Properties to set
26929
+ * @returns {flyteidl.admin.AgentError} AgentError instance
26930
+ */
26931
+ AgentError.create = function create(properties) {
26932
+ return new AgentError(properties);
26933
+ };
26934
+
26935
+ /**
26936
+ * Encodes the specified AgentError message. Does not implicitly {@link flyteidl.admin.AgentError.verify|verify} messages.
26937
+ * @function encode
26938
+ * @memberof flyteidl.admin.AgentError
26939
+ * @static
26940
+ * @param {flyteidl.admin.IAgentError} message AgentError message or plain object to encode
26941
+ * @param {$protobuf.Writer} [writer] Writer to encode to
26942
+ * @returns {$protobuf.Writer} Writer
26943
+ */
26944
+ AgentError.encode = function encode(message, writer) {
26945
+ if (!writer)
26946
+ writer = $Writer.create();
26947
+ if (message.code != null && message.hasOwnProperty("code"))
26948
+ writer.uint32(/* id 1, wireType 2 =*/10).string(message.code);
26949
+ if (message.kind != null && message.hasOwnProperty("kind"))
26950
+ writer.uint32(/* id 3, wireType 0 =*/24).int32(message.kind);
26951
+ if (message.origin != null && message.hasOwnProperty("origin"))
26952
+ writer.uint32(/* id 4, wireType 0 =*/32).int32(message.origin);
26953
+ return writer;
26954
+ };
26955
+
26956
+ /**
26957
+ * Decodes an AgentError message from the specified reader or buffer.
26958
+ * @function decode
26959
+ * @memberof flyteidl.admin.AgentError
26960
+ * @static
26961
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
26962
+ * @param {number} [length] Message length if known beforehand
26963
+ * @returns {flyteidl.admin.AgentError} AgentError
26964
+ * @throws {Error} If the payload is not a reader or valid buffer
26965
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
26966
+ */
26967
+ AgentError.decode = function decode(reader, length) {
26968
+ if (!(reader instanceof $Reader))
26969
+ reader = $Reader.create(reader);
26970
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.AgentError();
26971
+ while (reader.pos < end) {
26972
+ var tag = reader.uint32();
26973
+ switch (tag >>> 3) {
26974
+ case 1:
26975
+ message.code = reader.string();
26976
+ break;
26977
+ case 3:
26978
+ message.kind = reader.int32();
26979
+ break;
26980
+ case 4:
26981
+ message.origin = reader.int32();
26982
+ break;
26983
+ default:
26984
+ reader.skipType(tag & 7);
26985
+ break;
26986
+ }
26987
+ }
26988
+ return message;
26989
+ };
26990
+
26991
+ /**
26992
+ * Verifies an AgentError message.
26993
+ * @function verify
26994
+ * @memberof flyteidl.admin.AgentError
26995
+ * @static
26996
+ * @param {Object.<string,*>} message Plain object to verify
26997
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
26998
+ */
26999
+ AgentError.verify = function verify(message) {
27000
+ if (typeof message !== "object" || message === null)
27001
+ return "object expected";
27002
+ if (message.code != null && message.hasOwnProperty("code"))
27003
+ if (!$util.isString(message.code))
27004
+ return "code: string expected";
27005
+ if (message.kind != null && message.hasOwnProperty("kind"))
27006
+ switch (message.kind) {
27007
+ default:
27008
+ return "kind: enum value expected";
27009
+ case 0:
27010
+ case 1:
27011
+ break;
27012
+ }
27013
+ if (message.origin != null && message.hasOwnProperty("origin"))
27014
+ switch (message.origin) {
27015
+ default:
27016
+ return "origin: enum value expected";
27017
+ case 0:
27018
+ case 1:
27019
+ case 2:
27020
+ break;
27021
+ }
27022
+ return null;
27023
+ };
27024
+
27025
+ /**
27026
+ * Kind enum.
27027
+ * @name flyteidl.admin.AgentError.Kind
27028
+ * @enum {string}
27029
+ * @property {number} NON_RECOVERABLE=0 NON_RECOVERABLE value
27030
+ * @property {number} RECOVERABLE=1 RECOVERABLE value
27031
+ */
27032
+ AgentError.Kind = (function() {
27033
+ var valuesById = {}, values = Object.create(valuesById);
27034
+ values[valuesById[0] = "NON_RECOVERABLE"] = 0;
27035
+ values[valuesById[1] = "RECOVERABLE"] = 1;
27036
+ return values;
27037
+ })();
27038
+
27039
+ return AgentError;
27040
+ })();
27041
+
26707
27042
  admin.ClusterAssignment = (function() {
26708
27043
 
26709
27044
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flyteorg/flyteidl",
3
- "version": "1.13.9",
3
+ "version": "1.14.1",
4
4
  "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -0,0 +1,68 @@
1
+ ## Contributing to FlyteIDL
2
+
3
+ ## Install Tooling
4
+
5
+ 1. Run ``make download_tooling`` to install generator dependencies.
6
+
7
+ ```bash
8
+ make download_tooling
9
+ ```
10
+
11
+ 2. Ensure Docker is installed locally.
12
+ 3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
13
+
14
+ ```bash
15
+ make generate
16
+ ```
17
+
18
+ 4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
19
+
20
+ ```bash
21
+ make doc-requirements.txt
22
+ ```
23
+
24
+ ## Docs structure
25
+
26
+ The index.rst files for protos are arranged in parallel under the ``docs`` folder.
27
+ All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
28
+
29
+ ```
30
+ docs
31
+ ├── admin
32
+ │   ├── admin.rst
33
+ │   └── index.rst
34
+ ├── core
35
+ │   ├── core.rst
36
+ │   └── index.rst
37
+ ├── datacatalog
38
+ │   ├── datacatalog.rst
39
+ │   └── index.rst
40
+ ├── event
41
+ │   ├── event.rst
42
+ │   └── index.rst
43
+ ├── plugins
44
+ │   ├── index.rst
45
+ │   └── plugins.rst
46
+ ├── service
47
+ │   ├── index.rst
48
+ │   └── service.rst
49
+ ```
50
+
51
+ Each module in protos has a module in docs with the same name.
52
+ For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
53
+
54
+
55
+ ## Generating Documentation
56
+
57
+ * If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
58
+ ```
59
+ core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
60
+ # Remove any currently generated file
61
+ ls -d protos/docs/core/* | grep -v index.rst | xargs rm
62
+ protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
63
+ ```
64
+
65
+ * ``make generate`` generates the modified rst files.
66
+
67
+ * ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
68
+
@@ -16,3 +16,4 @@ and documentation of all these entities.
16
16
  docs/event/index
17
17
  docs/plugins/index
18
18
  docs/service/index
19
+ docs/contributing
@@ -138,6 +138,8 @@ message Resource {
138
138
  core.TaskExecution.Phase phase = 5;
139
139
  // Custom data specific to the agent.
140
140
  google.protobuf.Struct custom_info = 6;
141
+ // The error raised during execution
142
+ AgentError agent_error = 7;
141
143
  }
142
144
 
143
145
  // A message used to delete a task.
@@ -256,3 +258,22 @@ message GetTaskLogsResponse {
256
258
  GetTaskLogsResponseBody body = 2;
257
259
  }
258
260
  }
261
+
262
+ // Error message to propagate detailed errors from agent executions to the execution
263
+ // engine.
264
+ message AgentError {
265
+ // A simplified code for errors, so that we can provide a glossary of all possible errors.
266
+ string code = 1;
267
+
268
+ // Defines a generic error type that dictates the behavior of the retry strategy.
269
+ enum Kind {
270
+ NON_RECOVERABLE = 0;
271
+ RECOVERABLE = 1;
272
+ }
273
+
274
+ // An abstract error kind for this error. Defaults to Non_Recoverable if not specified.
275
+ Kind kind = 3;
276
+
277
+ // Defines the origin of the error (system, user, unknown).
278
+ core.ExecutionError.ErrorKind origin = 4;
279
+ }
@@ -29,6 +29,7 @@ message NamedEntityIdentifier {
29
29
 
30
30
  // The status of the named entity is used to control its visibility in the UI.
31
31
  enum NamedEntityState {
32
+ reserved 3, 4;
32
33
  // By default, all named entities are considered active and under development.
33
34
  NAMED_ENTITY_ACTIVE = 0;
34
35
 
@@ -206,6 +206,8 @@ message SystemMetadata {
206
206
  message ExecutionMetadata {
207
207
  // The method by which this execution was launched.
208
208
  enum ExecutionMode {
209
+ reserved 7;
210
+
209
211
  // The default execution mode, MANUAL implies that an execution was launched by an individual.
210
212
  MANUAL = 0;
211
213
 
@@ -169,6 +169,11 @@ message BindingData {
169
169
 
170
170
  // A map of bindings. The key is always a string.
171
171
  BindingDataMap map = 4;
172
+
173
+ // Offloaded literal metadata
174
+ // When you deserialize the offloaded metadata, it would be of Literal and its type would be defined by LiteralType stored in offloaded_metadata.
175
+ // Used for nodes that don't have promises from upstream nodes such as ArrayNode subNodes.
176
+ LiteralOffloadedMetadata offloaded_metadata = 6;
172
177
  }
173
178
 
174
179
  UnionInfo union = 5;
@@ -150,6 +150,23 @@ message ArrayNode {
150
150
 
151
151
  // Indicates whether the sub node's original interface was altered
152
152
  google.protobuf.BoolValue is_original_sub_node_interface = 6;
153
+
154
+ enum DataMode {
155
+ // Indicates the ArrayNode's input is a list of input values that map to subNode executions.
156
+ // The file path set for the subNode will be the ArrayNode's input file, but the in-memory
157
+ // value utilized in propeller will be the individual value for each subNode execution.
158
+ // SubNode executions need to be able to read in and parse the individual value to execute correctly.
159
+ SINGLE_INPUT_FILE = 0;
160
+
161
+ // Indicates the ArrayNode's input is a list of input values that map to subNode executions.
162
+ // Propeller will create input files for each ArrayNode subNode by parsing the inputs and
163
+ // setting the InputBindings on each subNodeSpec. Both the file path and in-memory input values will
164
+ // be the individual value for each subNode execution.
165
+ INDIVIDUAL_INPUT_FILES = 1;
166
+ }
167
+
168
+ // data_mode determines how input data is passed to the sub-nodes
169
+ DataMode data_mode = 7;
153
170
  }
154
171
 
155
172
  // Defines extra information about the Node.
@@ -28,6 +28,9 @@ message CloudEventWorkflowExecution {
28
28
  // Here for provenance information.
29
29
  // Launch plan IDs are easier to get than workflow IDs so we'll use these for now.
30
30
  core.Identifier launch_plan_id = 6;
31
+
32
+ // We can't have the ExecutionMetadata object directly because of import cycle
33
+ map<string,string> labels = 7;
31
34
  }
32
35
 
33
36
  message CloudEventNodeExecution {
@@ -48,10 +51,15 @@ message CloudEventNodeExecution {
48
51
  // Here for provenance information.
49
52
  // Launch plan IDs are easier to get than workflow IDs so we'll use these for now.
50
53
  core.Identifier launch_plan_id = 6;
54
+
55
+ // We can't have the ExecutionMetadata object directly because of import cycle
56
+ map<string,string> labels = 7;
51
57
  }
52
58
 
53
59
  message CloudEventTaskExecution {
54
60
  event.TaskExecutionEvent raw_event = 1;
61
+ // We can't have the ExecutionMetadata object directly because of import cycle
62
+ map<string,string> labels = 2;
55
63
  }
56
64
 
57
65
  // This event is to be sent by Admin after it creates an execution.