@flyteorg/flyteidl 0.21.21 → 0.21.25

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.
@@ -6472,6 +6472,15 @@ export namespace flyteidl {
6472
6472
 
6473
6473
  /** ExternalResourceInfo externalId */
6474
6474
  externalId?: (string|null);
6475
+
6476
+ /** ExternalResourceInfo index */
6477
+ index?: (number|null);
6478
+
6479
+ /** ExternalResourceInfo retryAttempt */
6480
+ retryAttempt?: (number|null);
6481
+
6482
+ /** ExternalResourceInfo phase */
6483
+ phase?: (flyteidl.core.TaskExecution.Phase|null);
6475
6484
  }
6476
6485
 
6477
6486
  /** Represents an ExternalResourceInfo. */
@@ -6486,6 +6495,15 @@ export namespace flyteidl {
6486
6495
  /** ExternalResourceInfo externalId. */
6487
6496
  public externalId: string;
6488
6497
 
6498
+ /** ExternalResourceInfo index. */
6499
+ public index: number;
6500
+
6501
+ /** ExternalResourceInfo retryAttempt. */
6502
+ public retryAttempt: number;
6503
+
6504
+ /** ExternalResourceInfo phase. */
6505
+ public phase: flyteidl.core.TaskExecution.Phase;
6506
+
6489
6507
  /**
6490
6508
  * Creates a new ExternalResourceInfo instance using the specified properties.
6491
6509
  * @param [properties] Properties to set
@@ -9070,6 +9088,9 @@ export namespace flyteidl {
9070
9088
 
9071
9089
  /** ExecutionClosure workflowId */
9072
9090
  workflowId?: (flyteidl.core.IIdentifier|null);
9091
+
9092
+ /** ExecutionClosure stateChangeDetails */
9093
+ stateChangeDetails?: (flyteidl.admin.IExecutionStateChangeDetails|null);
9073
9094
  }
9074
9095
 
9075
9096
  /** Represents an ExecutionClosure. */
@@ -9120,6 +9141,9 @@ export namespace flyteidl {
9120
9141
  /** ExecutionClosure workflowId. */
9121
9142
  public workflowId?: (flyteidl.core.IIdentifier|null);
9122
9143
 
9144
+ /** ExecutionClosure stateChangeDetails. */
9145
+ public stateChangeDetails?: (flyteidl.admin.IExecutionStateChangeDetails|null);
9146
+
9123
9147
  /** ExecutionClosure outputResult. */
9124
9148
  public outputResult?: ("outputs"|"error"|"abortCause"|"abortMetadata"|"outputData");
9125
9149
 
@@ -9702,6 +9726,180 @@ export namespace flyteidl {
9702
9726
  public static verify(message: { [k: string]: any }): (string|null);
9703
9727
  }
9704
9728
 
9729
+ /** ExecutionState enum. */
9730
+ enum ExecutionState {
9731
+ EXECUTION_ACTIVE = 0,
9732
+ EXECUTION_ARCHIVED = 1
9733
+ }
9734
+
9735
+ /** Properties of an ExecutionUpdateRequest. */
9736
+ interface IExecutionUpdateRequest {
9737
+
9738
+ /** ExecutionUpdateRequest id */
9739
+ id?: (flyteidl.core.IWorkflowExecutionIdentifier|null);
9740
+
9741
+ /** ExecutionUpdateRequest state */
9742
+ state?: (flyteidl.admin.ExecutionState|null);
9743
+ }
9744
+
9745
+ /** Represents an ExecutionUpdateRequest. */
9746
+ class ExecutionUpdateRequest implements IExecutionUpdateRequest {
9747
+
9748
+ /**
9749
+ * Constructs a new ExecutionUpdateRequest.
9750
+ * @param [properties] Properties to set
9751
+ */
9752
+ constructor(properties?: flyteidl.admin.IExecutionUpdateRequest);
9753
+
9754
+ /** ExecutionUpdateRequest id. */
9755
+ public id?: (flyteidl.core.IWorkflowExecutionIdentifier|null);
9756
+
9757
+ /** ExecutionUpdateRequest state. */
9758
+ public state: flyteidl.admin.ExecutionState;
9759
+
9760
+ /**
9761
+ * Creates a new ExecutionUpdateRequest instance using the specified properties.
9762
+ * @param [properties] Properties to set
9763
+ * @returns ExecutionUpdateRequest instance
9764
+ */
9765
+ public static create(properties?: flyteidl.admin.IExecutionUpdateRequest): flyteidl.admin.ExecutionUpdateRequest;
9766
+
9767
+ /**
9768
+ * Encodes the specified ExecutionUpdateRequest message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateRequest.verify|verify} messages.
9769
+ * @param message ExecutionUpdateRequest message or plain object to encode
9770
+ * @param [writer] Writer to encode to
9771
+ * @returns Writer
9772
+ */
9773
+ public static encode(message: flyteidl.admin.IExecutionUpdateRequest, writer?: $protobuf.Writer): $protobuf.Writer;
9774
+
9775
+ /**
9776
+ * Decodes an ExecutionUpdateRequest message from the specified reader or buffer.
9777
+ * @param reader Reader or buffer to decode from
9778
+ * @param [length] Message length if known beforehand
9779
+ * @returns ExecutionUpdateRequest
9780
+ * @throws {Error} If the payload is not a reader or valid buffer
9781
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
9782
+ */
9783
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionUpdateRequest;
9784
+
9785
+ /**
9786
+ * Verifies an ExecutionUpdateRequest message.
9787
+ * @param message Plain object to verify
9788
+ * @returns `null` if valid, otherwise the reason why it is not
9789
+ */
9790
+ public static verify(message: { [k: string]: any }): (string|null);
9791
+ }
9792
+
9793
+ /** Properties of an ExecutionStateChangeDetails. */
9794
+ interface IExecutionStateChangeDetails {
9795
+
9796
+ /** ExecutionStateChangeDetails state */
9797
+ state?: (flyteidl.admin.ExecutionState|null);
9798
+
9799
+ /** ExecutionStateChangeDetails occurredAt */
9800
+ occurredAt?: (google.protobuf.ITimestamp|null);
9801
+
9802
+ /** ExecutionStateChangeDetails principal */
9803
+ principal?: (string|null);
9804
+ }
9805
+
9806
+ /** Represents an ExecutionStateChangeDetails. */
9807
+ class ExecutionStateChangeDetails implements IExecutionStateChangeDetails {
9808
+
9809
+ /**
9810
+ * Constructs a new ExecutionStateChangeDetails.
9811
+ * @param [properties] Properties to set
9812
+ */
9813
+ constructor(properties?: flyteidl.admin.IExecutionStateChangeDetails);
9814
+
9815
+ /** ExecutionStateChangeDetails state. */
9816
+ public state: flyteidl.admin.ExecutionState;
9817
+
9818
+ /** ExecutionStateChangeDetails occurredAt. */
9819
+ public occurredAt?: (google.protobuf.ITimestamp|null);
9820
+
9821
+ /** ExecutionStateChangeDetails principal. */
9822
+ public principal: string;
9823
+
9824
+ /**
9825
+ * Creates a new ExecutionStateChangeDetails instance using the specified properties.
9826
+ * @param [properties] Properties to set
9827
+ * @returns ExecutionStateChangeDetails instance
9828
+ */
9829
+ public static create(properties?: flyteidl.admin.IExecutionStateChangeDetails): flyteidl.admin.ExecutionStateChangeDetails;
9830
+
9831
+ /**
9832
+ * Encodes the specified ExecutionStateChangeDetails message. Does not implicitly {@link flyteidl.admin.ExecutionStateChangeDetails.verify|verify} messages.
9833
+ * @param message ExecutionStateChangeDetails message or plain object to encode
9834
+ * @param [writer] Writer to encode to
9835
+ * @returns Writer
9836
+ */
9837
+ public static encode(message: flyteidl.admin.IExecutionStateChangeDetails, writer?: $protobuf.Writer): $protobuf.Writer;
9838
+
9839
+ /**
9840
+ * Decodes an ExecutionStateChangeDetails message from the specified reader or buffer.
9841
+ * @param reader Reader or buffer to decode from
9842
+ * @param [length] Message length if known beforehand
9843
+ * @returns ExecutionStateChangeDetails
9844
+ * @throws {Error} If the payload is not a reader or valid buffer
9845
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
9846
+ */
9847
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionStateChangeDetails;
9848
+
9849
+ /**
9850
+ * Verifies an ExecutionStateChangeDetails message.
9851
+ * @param message Plain object to verify
9852
+ * @returns `null` if valid, otherwise the reason why it is not
9853
+ */
9854
+ public static verify(message: { [k: string]: any }): (string|null);
9855
+ }
9856
+
9857
+ /** Properties of an ExecutionUpdateResponse. */
9858
+ interface IExecutionUpdateResponse {
9859
+ }
9860
+
9861
+ /** Represents an ExecutionUpdateResponse. */
9862
+ class ExecutionUpdateResponse implements IExecutionUpdateResponse {
9863
+
9864
+ /**
9865
+ * Constructs a new ExecutionUpdateResponse.
9866
+ * @param [properties] Properties to set
9867
+ */
9868
+ constructor(properties?: flyteidl.admin.IExecutionUpdateResponse);
9869
+
9870
+ /**
9871
+ * Creates a new ExecutionUpdateResponse instance using the specified properties.
9872
+ * @param [properties] Properties to set
9873
+ * @returns ExecutionUpdateResponse instance
9874
+ */
9875
+ public static create(properties?: flyteidl.admin.IExecutionUpdateResponse): flyteidl.admin.ExecutionUpdateResponse;
9876
+
9877
+ /**
9878
+ * Encodes the specified ExecutionUpdateResponse message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateResponse.verify|verify} messages.
9879
+ * @param message ExecutionUpdateResponse message or plain object to encode
9880
+ * @param [writer] Writer to encode to
9881
+ * @returns Writer
9882
+ */
9883
+ public static encode(message: flyteidl.admin.IExecutionUpdateResponse, writer?: $protobuf.Writer): $protobuf.Writer;
9884
+
9885
+ /**
9886
+ * Decodes an ExecutionUpdateResponse message from the specified reader or buffer.
9887
+ * @param reader Reader or buffer to decode from
9888
+ * @param [length] Message length if known beforehand
9889
+ * @returns ExecutionUpdateResponse
9890
+ * @throws {Error} If the payload is not a reader or valid buffer
9891
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
9892
+ */
9893
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionUpdateResponse;
9894
+
9895
+ /**
9896
+ * Verifies an ExecutionUpdateResponse message.
9897
+ * @param message Plain object to verify
9898
+ * @returns `null` if valid, otherwise the reason why it is not
9899
+ */
9900
+ public static verify(message: { [k: string]: any }): (string|null);
9901
+ }
9902
+
9705
9903
  /** Properties of a LaunchPlanCreateRequest. */
9706
9904
  interface ILaunchPlanCreateRequest {
9707
9905
 
@@ -15146,6 +15344,20 @@ export namespace flyteidl {
15146
15344
  */
15147
15345
  public getExecution(request: flyteidl.admin.IWorkflowExecutionGetRequest): Promise<flyteidl.admin.Execution>;
15148
15346
 
15347
+ /**
15348
+ * Calls UpdateExecution.
15349
+ * @param request ExecutionUpdateRequest message or plain object
15350
+ * @param callback Node-style callback called with the error, if any, and ExecutionUpdateResponse
15351
+ */
15352
+ public updateExecution(request: flyteidl.admin.IExecutionUpdateRequest, callback: flyteidl.service.AdminService.UpdateExecutionCallback): void;
15353
+
15354
+ /**
15355
+ * Calls UpdateExecution.
15356
+ * @param request ExecutionUpdateRequest message or plain object
15357
+ * @returns Promise
15358
+ */
15359
+ public updateExecution(request: flyteidl.admin.IExecutionUpdateRequest): Promise<flyteidl.admin.ExecutionUpdateResponse>;
15360
+
15149
15361
  /**
15150
15362
  * Calls GetExecutionData.
15151
15363
  * @param request WorkflowExecutionGetDataRequest message or plain object
@@ -15660,6 +15872,13 @@ export namespace flyteidl {
15660
15872
  */
15661
15873
  type GetExecutionCallback = (error: (Error|null), response?: flyteidl.admin.Execution) => void;
15662
15874
 
15875
+ /**
15876
+ * Callback as used by {@link flyteidl.service.AdminService#updateExecution}.
15877
+ * @param error Error, if any
15878
+ * @param [response] ExecutionUpdateResponse
15879
+ */
15880
+ type UpdateExecutionCallback = (error: (Error|null), response?: flyteidl.admin.ExecutionUpdateResponse) => void;
15881
+
15663
15882
  /**
15664
15883
  * Callback as used by {@link flyteidl.service.AdminService#getExecutionData}.
15665
15884
  * @param error Error, if any
@@ -15667,6 +15667,9 @@ export const flyteidl = $root.flyteidl = (() => {
15667
15667
  * @memberof flyteidl.event
15668
15668
  * @interface IExternalResourceInfo
15669
15669
  * @property {string|null} [externalId] ExternalResourceInfo externalId
15670
+ * @property {number|null} [index] ExternalResourceInfo index
15671
+ * @property {number|null} [retryAttempt] ExternalResourceInfo retryAttempt
15672
+ * @property {flyteidl.core.TaskExecution.Phase|null} [phase] ExternalResourceInfo phase
15670
15673
  */
15671
15674
 
15672
15675
  /**
@@ -15692,6 +15695,30 @@ export const flyteidl = $root.flyteidl = (() => {
15692
15695
  */
15693
15696
  ExternalResourceInfo.prototype.externalId = "";
15694
15697
 
15698
+ /**
15699
+ * ExternalResourceInfo index.
15700
+ * @member {number} index
15701
+ * @memberof flyteidl.event.ExternalResourceInfo
15702
+ * @instance
15703
+ */
15704
+ ExternalResourceInfo.prototype.index = 0;
15705
+
15706
+ /**
15707
+ * ExternalResourceInfo retryAttempt.
15708
+ * @member {number} retryAttempt
15709
+ * @memberof flyteidl.event.ExternalResourceInfo
15710
+ * @instance
15711
+ */
15712
+ ExternalResourceInfo.prototype.retryAttempt = 0;
15713
+
15714
+ /**
15715
+ * ExternalResourceInfo phase.
15716
+ * @member {flyteidl.core.TaskExecution.Phase} phase
15717
+ * @memberof flyteidl.event.ExternalResourceInfo
15718
+ * @instance
15719
+ */
15720
+ ExternalResourceInfo.prototype.phase = 0;
15721
+
15695
15722
  /**
15696
15723
  * Creates a new ExternalResourceInfo instance using the specified properties.
15697
15724
  * @function create
@@ -15718,6 +15745,12 @@ export const flyteidl = $root.flyteidl = (() => {
15718
15745
  writer = $Writer.create();
15719
15746
  if (message.externalId != null && message.hasOwnProperty("externalId"))
15720
15747
  writer.uint32(/* id 1, wireType 2 =*/10).string(message.externalId);
15748
+ if (message.index != null && message.hasOwnProperty("index"))
15749
+ writer.uint32(/* id 2, wireType 0 =*/16).uint32(message.index);
15750
+ if (message.retryAttempt != null && message.hasOwnProperty("retryAttempt"))
15751
+ writer.uint32(/* id 3, wireType 0 =*/24).uint32(message.retryAttempt);
15752
+ if (message.phase != null && message.hasOwnProperty("phase"))
15753
+ writer.uint32(/* id 4, wireType 0 =*/32).int32(message.phase);
15721
15754
  return writer;
15722
15755
  };
15723
15756
 
@@ -15742,6 +15775,15 @@ export const flyteidl = $root.flyteidl = (() => {
15742
15775
  case 1:
15743
15776
  message.externalId = reader.string();
15744
15777
  break;
15778
+ case 2:
15779
+ message.index = reader.uint32();
15780
+ break;
15781
+ case 3:
15782
+ message.retryAttempt = reader.uint32();
15783
+ break;
15784
+ case 4:
15785
+ message.phase = reader.int32();
15786
+ break;
15745
15787
  default:
15746
15788
  reader.skipType(tag & 7);
15747
15789
  break;
@@ -15764,6 +15806,26 @@ export const flyteidl = $root.flyteidl = (() => {
15764
15806
  if (message.externalId != null && message.hasOwnProperty("externalId"))
15765
15807
  if (!$util.isString(message.externalId))
15766
15808
  return "externalId: string expected";
15809
+ if (message.index != null && message.hasOwnProperty("index"))
15810
+ if (!$util.isInteger(message.index))
15811
+ return "index: integer expected";
15812
+ if (message.retryAttempt != null && message.hasOwnProperty("retryAttempt"))
15813
+ if (!$util.isInteger(message.retryAttempt))
15814
+ return "retryAttempt: integer expected";
15815
+ if (message.phase != null && message.hasOwnProperty("phase"))
15816
+ switch (message.phase) {
15817
+ default:
15818
+ return "phase: enum value expected";
15819
+ case 0:
15820
+ case 1:
15821
+ case 2:
15822
+ case 3:
15823
+ case 4:
15824
+ case 5:
15825
+ case 6:
15826
+ case 7:
15827
+ break;
15828
+ }
15767
15829
  return null;
15768
15830
  };
15769
15831
 
@@ -21587,6 +21649,7 @@ export const flyteidl = $root.flyteidl = (() => {
21587
21649
  * @property {google.protobuf.ITimestamp|null} [updatedAt] ExecutionClosure updatedAt
21588
21650
  * @property {Array.<flyteidl.admin.INotification>|null} [notifications] ExecutionClosure notifications
21589
21651
  * @property {flyteidl.core.IIdentifier|null} [workflowId] ExecutionClosure workflowId
21652
+ * @property {flyteidl.admin.IExecutionStateChangeDetails|null} [stateChangeDetails] ExecutionClosure stateChangeDetails
21590
21653
  */
21591
21654
 
21592
21655
  /**
@@ -21709,6 +21772,14 @@ export const flyteidl = $root.flyteidl = (() => {
21709
21772
  */
21710
21773
  ExecutionClosure.prototype.workflowId = null;
21711
21774
 
21775
+ /**
21776
+ * ExecutionClosure stateChangeDetails.
21777
+ * @member {flyteidl.admin.IExecutionStateChangeDetails|null|undefined} stateChangeDetails
21778
+ * @memberof flyteidl.admin.ExecutionClosure
21779
+ * @instance
21780
+ */
21781
+ ExecutionClosure.prototype.stateChangeDetails = null;
21782
+
21712
21783
  // OneOf field names bound to virtual getters and setters
21713
21784
  let $oneOfFields;
21714
21785
 
@@ -21774,6 +21845,8 @@ export const flyteidl = $root.flyteidl = (() => {
21774
21845
  $root.flyteidl.admin.AbortMetadata.encode(message.abortMetadata, writer.uint32(/* id 12, wireType 2 =*/98).fork()).ldelim();
21775
21846
  if (message.outputData != null && message.hasOwnProperty("outputData"))
21776
21847
  $root.flyteidl.core.LiteralMap.encode(message.outputData, writer.uint32(/* id 13, wireType 2 =*/106).fork()).ldelim();
21848
+ if (message.stateChangeDetails != null && message.hasOwnProperty("stateChangeDetails"))
21849
+ $root.flyteidl.admin.ExecutionStateChangeDetails.encode(message.stateChangeDetails, writer.uint32(/* id 14, wireType 2 =*/114).fork()).ldelim();
21777
21850
  return writer;
21778
21851
  };
21779
21852
 
@@ -21836,6 +21909,9 @@ export const flyteidl = $root.flyteidl = (() => {
21836
21909
  case 11:
21837
21910
  message.workflowId = $root.flyteidl.core.Identifier.decode(reader, reader.uint32());
21838
21911
  break;
21912
+ case 14:
21913
+ message.stateChangeDetails = $root.flyteidl.admin.ExecutionStateChangeDetails.decode(reader, reader.uint32());
21914
+ break;
21839
21915
  default:
21840
21916
  reader.skipType(tag & 7);
21841
21917
  break;
@@ -21956,6 +22032,11 @@ export const flyteidl = $root.flyteidl = (() => {
21956
22032
  if (error)
21957
22033
  return "workflowId." + error;
21958
22034
  }
22035
+ if (message.stateChangeDetails != null && message.hasOwnProperty("stateChangeDetails")) {
22036
+ let error = $root.flyteidl.admin.ExecutionStateChangeDetails.verify(message.stateChangeDetails);
22037
+ if (error)
22038
+ return "stateChangeDetails." + error;
22039
+ }
21959
22040
  return null;
21960
22041
  };
21961
22042
 
@@ -23266,6 +23347,398 @@ export const flyteidl = $root.flyteidl = (() => {
23266
23347
  return WorkflowExecutionGetDataResponse;
23267
23348
  })();
23268
23349
 
23350
+ /**
23351
+ * ExecutionState enum.
23352
+ * @name flyteidl.admin.ExecutionState
23353
+ * @enum {string}
23354
+ * @property {number} EXECUTION_ACTIVE=0 EXECUTION_ACTIVE value
23355
+ * @property {number} EXECUTION_ARCHIVED=1 EXECUTION_ARCHIVED value
23356
+ */
23357
+ admin.ExecutionState = (function() {
23358
+ const valuesById = {}, values = Object.create(valuesById);
23359
+ values[valuesById[0] = "EXECUTION_ACTIVE"] = 0;
23360
+ values[valuesById[1] = "EXECUTION_ARCHIVED"] = 1;
23361
+ return values;
23362
+ })();
23363
+
23364
+ admin.ExecutionUpdateRequest = (function() {
23365
+
23366
+ /**
23367
+ * Properties of an ExecutionUpdateRequest.
23368
+ * @memberof flyteidl.admin
23369
+ * @interface IExecutionUpdateRequest
23370
+ * @property {flyteidl.core.IWorkflowExecutionIdentifier|null} [id] ExecutionUpdateRequest id
23371
+ * @property {flyteidl.admin.ExecutionState|null} [state] ExecutionUpdateRequest state
23372
+ */
23373
+
23374
+ /**
23375
+ * Constructs a new ExecutionUpdateRequest.
23376
+ * @memberof flyteidl.admin
23377
+ * @classdesc Represents an ExecutionUpdateRequest.
23378
+ * @implements IExecutionUpdateRequest
23379
+ * @constructor
23380
+ * @param {flyteidl.admin.IExecutionUpdateRequest=} [properties] Properties to set
23381
+ */
23382
+ function ExecutionUpdateRequest(properties) {
23383
+ if (properties)
23384
+ for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
23385
+ if (properties[keys[i]] != null)
23386
+ this[keys[i]] = properties[keys[i]];
23387
+ }
23388
+
23389
+ /**
23390
+ * ExecutionUpdateRequest id.
23391
+ * @member {flyteidl.core.IWorkflowExecutionIdentifier|null|undefined} id
23392
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23393
+ * @instance
23394
+ */
23395
+ ExecutionUpdateRequest.prototype.id = null;
23396
+
23397
+ /**
23398
+ * ExecutionUpdateRequest state.
23399
+ * @member {flyteidl.admin.ExecutionState} state
23400
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23401
+ * @instance
23402
+ */
23403
+ ExecutionUpdateRequest.prototype.state = 0;
23404
+
23405
+ /**
23406
+ * Creates a new ExecutionUpdateRequest instance using the specified properties.
23407
+ * @function create
23408
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23409
+ * @static
23410
+ * @param {flyteidl.admin.IExecutionUpdateRequest=} [properties] Properties to set
23411
+ * @returns {flyteidl.admin.ExecutionUpdateRequest} ExecutionUpdateRequest instance
23412
+ */
23413
+ ExecutionUpdateRequest.create = function create(properties) {
23414
+ return new ExecutionUpdateRequest(properties);
23415
+ };
23416
+
23417
+ /**
23418
+ * Encodes the specified ExecutionUpdateRequest message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateRequest.verify|verify} messages.
23419
+ * @function encode
23420
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23421
+ * @static
23422
+ * @param {flyteidl.admin.IExecutionUpdateRequest} message ExecutionUpdateRequest message or plain object to encode
23423
+ * @param {$protobuf.Writer} [writer] Writer to encode to
23424
+ * @returns {$protobuf.Writer} Writer
23425
+ */
23426
+ ExecutionUpdateRequest.encode = function encode(message, writer) {
23427
+ if (!writer)
23428
+ writer = $Writer.create();
23429
+ if (message.id != null && message.hasOwnProperty("id"))
23430
+ $root.flyteidl.core.WorkflowExecutionIdentifier.encode(message.id, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
23431
+ if (message.state != null && message.hasOwnProperty("state"))
23432
+ writer.uint32(/* id 2, wireType 0 =*/16).int32(message.state);
23433
+ return writer;
23434
+ };
23435
+
23436
+ /**
23437
+ * Decodes an ExecutionUpdateRequest message from the specified reader or buffer.
23438
+ * @function decode
23439
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23440
+ * @static
23441
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
23442
+ * @param {number} [length] Message length if known beforehand
23443
+ * @returns {flyteidl.admin.ExecutionUpdateRequest} ExecutionUpdateRequest
23444
+ * @throws {Error} If the payload is not a reader or valid buffer
23445
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
23446
+ */
23447
+ ExecutionUpdateRequest.decode = function decode(reader, length) {
23448
+ if (!(reader instanceof $Reader))
23449
+ reader = $Reader.create(reader);
23450
+ let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.ExecutionUpdateRequest();
23451
+ while (reader.pos < end) {
23452
+ let tag = reader.uint32();
23453
+ switch (tag >>> 3) {
23454
+ case 1:
23455
+ message.id = $root.flyteidl.core.WorkflowExecutionIdentifier.decode(reader, reader.uint32());
23456
+ break;
23457
+ case 2:
23458
+ message.state = reader.int32();
23459
+ break;
23460
+ default:
23461
+ reader.skipType(tag & 7);
23462
+ break;
23463
+ }
23464
+ }
23465
+ return message;
23466
+ };
23467
+
23468
+ /**
23469
+ * Verifies an ExecutionUpdateRequest message.
23470
+ * @function verify
23471
+ * @memberof flyteidl.admin.ExecutionUpdateRequest
23472
+ * @static
23473
+ * @param {Object.<string,*>} message Plain object to verify
23474
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
23475
+ */
23476
+ ExecutionUpdateRequest.verify = function verify(message) {
23477
+ if (typeof message !== "object" || message === null)
23478
+ return "object expected";
23479
+ if (message.id != null && message.hasOwnProperty("id")) {
23480
+ let error = $root.flyteidl.core.WorkflowExecutionIdentifier.verify(message.id);
23481
+ if (error)
23482
+ return "id." + error;
23483
+ }
23484
+ if (message.state != null && message.hasOwnProperty("state"))
23485
+ switch (message.state) {
23486
+ default:
23487
+ return "state: enum value expected";
23488
+ case 0:
23489
+ case 1:
23490
+ break;
23491
+ }
23492
+ return null;
23493
+ };
23494
+
23495
+ return ExecutionUpdateRequest;
23496
+ })();
23497
+
23498
+ admin.ExecutionStateChangeDetails = (function() {
23499
+
23500
+ /**
23501
+ * Properties of an ExecutionStateChangeDetails.
23502
+ * @memberof flyteidl.admin
23503
+ * @interface IExecutionStateChangeDetails
23504
+ * @property {flyteidl.admin.ExecutionState|null} [state] ExecutionStateChangeDetails state
23505
+ * @property {google.protobuf.ITimestamp|null} [occurredAt] ExecutionStateChangeDetails occurredAt
23506
+ * @property {string|null} [principal] ExecutionStateChangeDetails principal
23507
+ */
23508
+
23509
+ /**
23510
+ * Constructs a new ExecutionStateChangeDetails.
23511
+ * @memberof flyteidl.admin
23512
+ * @classdesc Represents an ExecutionStateChangeDetails.
23513
+ * @implements IExecutionStateChangeDetails
23514
+ * @constructor
23515
+ * @param {flyteidl.admin.IExecutionStateChangeDetails=} [properties] Properties to set
23516
+ */
23517
+ function ExecutionStateChangeDetails(properties) {
23518
+ if (properties)
23519
+ for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
23520
+ if (properties[keys[i]] != null)
23521
+ this[keys[i]] = properties[keys[i]];
23522
+ }
23523
+
23524
+ /**
23525
+ * ExecutionStateChangeDetails state.
23526
+ * @member {flyteidl.admin.ExecutionState} state
23527
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23528
+ * @instance
23529
+ */
23530
+ ExecutionStateChangeDetails.prototype.state = 0;
23531
+
23532
+ /**
23533
+ * ExecutionStateChangeDetails occurredAt.
23534
+ * @member {google.protobuf.ITimestamp|null|undefined} occurredAt
23535
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23536
+ * @instance
23537
+ */
23538
+ ExecutionStateChangeDetails.prototype.occurredAt = null;
23539
+
23540
+ /**
23541
+ * ExecutionStateChangeDetails principal.
23542
+ * @member {string} principal
23543
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23544
+ * @instance
23545
+ */
23546
+ ExecutionStateChangeDetails.prototype.principal = "";
23547
+
23548
+ /**
23549
+ * Creates a new ExecutionStateChangeDetails instance using the specified properties.
23550
+ * @function create
23551
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23552
+ * @static
23553
+ * @param {flyteidl.admin.IExecutionStateChangeDetails=} [properties] Properties to set
23554
+ * @returns {flyteidl.admin.ExecutionStateChangeDetails} ExecutionStateChangeDetails instance
23555
+ */
23556
+ ExecutionStateChangeDetails.create = function create(properties) {
23557
+ return new ExecutionStateChangeDetails(properties);
23558
+ };
23559
+
23560
+ /**
23561
+ * Encodes the specified ExecutionStateChangeDetails message. Does not implicitly {@link flyteidl.admin.ExecutionStateChangeDetails.verify|verify} messages.
23562
+ * @function encode
23563
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23564
+ * @static
23565
+ * @param {flyteidl.admin.IExecutionStateChangeDetails} message ExecutionStateChangeDetails message or plain object to encode
23566
+ * @param {$protobuf.Writer} [writer] Writer to encode to
23567
+ * @returns {$protobuf.Writer} Writer
23568
+ */
23569
+ ExecutionStateChangeDetails.encode = function encode(message, writer) {
23570
+ if (!writer)
23571
+ writer = $Writer.create();
23572
+ if (message.state != null && message.hasOwnProperty("state"))
23573
+ writer.uint32(/* id 1, wireType 0 =*/8).int32(message.state);
23574
+ if (message.occurredAt != null && message.hasOwnProperty("occurredAt"))
23575
+ $root.google.protobuf.Timestamp.encode(message.occurredAt, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
23576
+ if (message.principal != null && message.hasOwnProperty("principal"))
23577
+ writer.uint32(/* id 3, wireType 2 =*/26).string(message.principal);
23578
+ return writer;
23579
+ };
23580
+
23581
+ /**
23582
+ * Decodes an ExecutionStateChangeDetails message from the specified reader or buffer.
23583
+ * @function decode
23584
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23585
+ * @static
23586
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
23587
+ * @param {number} [length] Message length if known beforehand
23588
+ * @returns {flyteidl.admin.ExecutionStateChangeDetails} ExecutionStateChangeDetails
23589
+ * @throws {Error} If the payload is not a reader or valid buffer
23590
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
23591
+ */
23592
+ ExecutionStateChangeDetails.decode = function decode(reader, length) {
23593
+ if (!(reader instanceof $Reader))
23594
+ reader = $Reader.create(reader);
23595
+ let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.ExecutionStateChangeDetails();
23596
+ while (reader.pos < end) {
23597
+ let tag = reader.uint32();
23598
+ switch (tag >>> 3) {
23599
+ case 1:
23600
+ message.state = reader.int32();
23601
+ break;
23602
+ case 2:
23603
+ message.occurredAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
23604
+ break;
23605
+ case 3:
23606
+ message.principal = reader.string();
23607
+ break;
23608
+ default:
23609
+ reader.skipType(tag & 7);
23610
+ break;
23611
+ }
23612
+ }
23613
+ return message;
23614
+ };
23615
+
23616
+ /**
23617
+ * Verifies an ExecutionStateChangeDetails message.
23618
+ * @function verify
23619
+ * @memberof flyteidl.admin.ExecutionStateChangeDetails
23620
+ * @static
23621
+ * @param {Object.<string,*>} message Plain object to verify
23622
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
23623
+ */
23624
+ ExecutionStateChangeDetails.verify = function verify(message) {
23625
+ if (typeof message !== "object" || message === null)
23626
+ return "object expected";
23627
+ if (message.state != null && message.hasOwnProperty("state"))
23628
+ switch (message.state) {
23629
+ default:
23630
+ return "state: enum value expected";
23631
+ case 0:
23632
+ case 1:
23633
+ break;
23634
+ }
23635
+ if (message.occurredAt != null && message.hasOwnProperty("occurredAt")) {
23636
+ let error = $root.google.protobuf.Timestamp.verify(message.occurredAt);
23637
+ if (error)
23638
+ return "occurredAt." + error;
23639
+ }
23640
+ if (message.principal != null && message.hasOwnProperty("principal"))
23641
+ if (!$util.isString(message.principal))
23642
+ return "principal: string expected";
23643
+ return null;
23644
+ };
23645
+
23646
+ return ExecutionStateChangeDetails;
23647
+ })();
23648
+
23649
+ admin.ExecutionUpdateResponse = (function() {
23650
+
23651
+ /**
23652
+ * Properties of an ExecutionUpdateResponse.
23653
+ * @memberof flyteidl.admin
23654
+ * @interface IExecutionUpdateResponse
23655
+ */
23656
+
23657
+ /**
23658
+ * Constructs a new ExecutionUpdateResponse.
23659
+ * @memberof flyteidl.admin
23660
+ * @classdesc Represents an ExecutionUpdateResponse.
23661
+ * @implements IExecutionUpdateResponse
23662
+ * @constructor
23663
+ * @param {flyteidl.admin.IExecutionUpdateResponse=} [properties] Properties to set
23664
+ */
23665
+ function ExecutionUpdateResponse(properties) {
23666
+ if (properties)
23667
+ for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
23668
+ if (properties[keys[i]] != null)
23669
+ this[keys[i]] = properties[keys[i]];
23670
+ }
23671
+
23672
+ /**
23673
+ * Creates a new ExecutionUpdateResponse instance using the specified properties.
23674
+ * @function create
23675
+ * @memberof flyteidl.admin.ExecutionUpdateResponse
23676
+ * @static
23677
+ * @param {flyteidl.admin.IExecutionUpdateResponse=} [properties] Properties to set
23678
+ * @returns {flyteidl.admin.ExecutionUpdateResponse} ExecutionUpdateResponse instance
23679
+ */
23680
+ ExecutionUpdateResponse.create = function create(properties) {
23681
+ return new ExecutionUpdateResponse(properties);
23682
+ };
23683
+
23684
+ /**
23685
+ * Encodes the specified ExecutionUpdateResponse message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateResponse.verify|verify} messages.
23686
+ * @function encode
23687
+ * @memberof flyteidl.admin.ExecutionUpdateResponse
23688
+ * @static
23689
+ * @param {flyteidl.admin.IExecutionUpdateResponse} message ExecutionUpdateResponse message or plain object to encode
23690
+ * @param {$protobuf.Writer} [writer] Writer to encode to
23691
+ * @returns {$protobuf.Writer} Writer
23692
+ */
23693
+ ExecutionUpdateResponse.encode = function encode(message, writer) {
23694
+ if (!writer)
23695
+ writer = $Writer.create();
23696
+ return writer;
23697
+ };
23698
+
23699
+ /**
23700
+ * Decodes an ExecutionUpdateResponse message from the specified reader or buffer.
23701
+ * @function decode
23702
+ * @memberof flyteidl.admin.ExecutionUpdateResponse
23703
+ * @static
23704
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
23705
+ * @param {number} [length] Message length if known beforehand
23706
+ * @returns {flyteidl.admin.ExecutionUpdateResponse} ExecutionUpdateResponse
23707
+ * @throws {Error} If the payload is not a reader or valid buffer
23708
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
23709
+ */
23710
+ ExecutionUpdateResponse.decode = function decode(reader, length) {
23711
+ if (!(reader instanceof $Reader))
23712
+ reader = $Reader.create(reader);
23713
+ let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.admin.ExecutionUpdateResponse();
23714
+ while (reader.pos < end) {
23715
+ let tag = reader.uint32();
23716
+ switch (tag >>> 3) {
23717
+ default:
23718
+ reader.skipType(tag & 7);
23719
+ break;
23720
+ }
23721
+ }
23722
+ return message;
23723
+ };
23724
+
23725
+ /**
23726
+ * Verifies an ExecutionUpdateResponse message.
23727
+ * @function verify
23728
+ * @memberof flyteidl.admin.ExecutionUpdateResponse
23729
+ * @static
23730
+ * @param {Object.<string,*>} message Plain object to verify
23731
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
23732
+ */
23733
+ ExecutionUpdateResponse.verify = function verify(message) {
23734
+ if (typeof message !== "object" || message === null)
23735
+ return "object expected";
23736
+ return null;
23737
+ };
23738
+
23739
+ return ExecutionUpdateResponse;
23740
+ })();
23741
+
23269
23742
  admin.LaunchPlanCreateRequest = (function() {
23270
23743
 
23271
23744
  /**
@@ -35984,6 +36457,39 @@ export const flyteidl = $root.flyteidl = (() => {
35984
36457
  * @variation 2
35985
36458
  */
35986
36459
 
36460
+ /**
36461
+ * Callback as used by {@link flyteidl.service.AdminService#updateExecution}.
36462
+ * @memberof flyteidl.service.AdminService
36463
+ * @typedef UpdateExecutionCallback
36464
+ * @type {function}
36465
+ * @param {Error|null} error Error, if any
36466
+ * @param {flyteidl.admin.ExecutionUpdateResponse} [response] ExecutionUpdateResponse
36467
+ */
36468
+
36469
+ /**
36470
+ * Calls UpdateExecution.
36471
+ * @function updateExecution
36472
+ * @memberof flyteidl.service.AdminService
36473
+ * @instance
36474
+ * @param {flyteidl.admin.IExecutionUpdateRequest} request ExecutionUpdateRequest message or plain object
36475
+ * @param {flyteidl.service.AdminService.UpdateExecutionCallback} callback Node-style callback called with the error, if any, and ExecutionUpdateResponse
36476
+ * @returns {undefined}
36477
+ * @variation 1
36478
+ */
36479
+ Object.defineProperty(AdminService.prototype.updateExecution = function updateExecution(request, callback) {
36480
+ return this.rpcCall(updateExecution, $root.flyteidl.admin.ExecutionUpdateRequest, $root.flyteidl.admin.ExecutionUpdateResponse, request, callback);
36481
+ }, "name", { value: "UpdateExecution" });
36482
+
36483
+ /**
36484
+ * Calls UpdateExecution.
36485
+ * @function updateExecution
36486
+ * @memberof flyteidl.service.AdminService
36487
+ * @instance
36488
+ * @param {flyteidl.admin.IExecutionUpdateRequest} request ExecutionUpdateRequest message or plain object
36489
+ * @returns {Promise<flyteidl.admin.ExecutionUpdateResponse>} Promise
36490
+ * @variation 2
36491
+ */
36492
+
35987
36493
  /**
35988
36494
  * Callback as used by {@link flyteidl.service.AdminService#getExecutionData}.
35989
36495
  * @memberof flyteidl.service.AdminService
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flyteorg/flyteidl",
3
- "version": "0.21.21",
3
+ "version": "0.21.25",
4
4
  "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -877,6 +877,7 @@ Encapsulates the results of the Execution
877
877
  "updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Reported time at which the execution was last updated."
878
878
  "notifications", ":ref:`ref_flyteidl.admin.Notification`", "repeated", "The notification settings to use after merging the CreateExecutionRequest and the launch plan notification settings. An execution launched with notifications will always prefer that definition to notifications defined statically in a launch plan."
879
879
  "workflow_id", ":ref:`ref_flyteidl.core.Identifier`", "", "Identifies the workflow definition for this execution."
880
+ "state_change_details", ":ref:`ref_flyteidl.admin.ExecutionStateChangeDetails`", "", "Provides the details of the last stage change"
880
881
 
881
882
 
882
883
 
@@ -1059,6 +1060,29 @@ of an execution as it progresses across phase changes.
1059
1060
 
1060
1061
 
1061
1062
 
1063
+ .. _ref_flyteidl.admin.ExecutionStateChangeDetails:
1064
+
1065
+ ExecutionStateChangeDetails
1066
+ ------------------------------------------------------------------
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+ .. csv-table:: ExecutionStateChangeDetails type fields
1073
+ :header: "Field", "Type", "Label", "Description"
1074
+ :widths: auto
1075
+
1076
+ "state", ":ref:`ref_flyteidl.admin.ExecutionState`", "", "The state of the execution is used to control its visibility in the UI/CLI."
1077
+ "occurred_at", ":ref:`ref_google.protobuf.Timestamp`", "", "This timestamp represents when the state changed."
1078
+ "principal", ":ref:`ref_string`", "", "Identifies the entity (if any) responsible for causing the state change of the execution"
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+
1062
1086
  .. _ref_flyteidl.admin.ExecutionTerminateRequest:
1063
1087
 
1064
1088
  ExecutionTerminateRequest
@@ -1099,6 +1123,42 @@ Purposefully empty, may be populated in the future.
1099
1123
 
1100
1124
 
1101
1125
 
1126
+ .. _ref_flyteidl.admin.ExecutionUpdateRequest:
1127
+
1128
+ ExecutionUpdateRequest
1129
+ ------------------------------------------------------------------
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+ .. csv-table:: ExecutionUpdateRequest type fields
1136
+ :header: "Field", "Type", "Label", "Description"
1137
+ :widths: auto
1138
+
1139
+ "id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the execution to update"
1140
+ "state", ":ref:`ref_flyteidl.admin.ExecutionState`", "", "State to set as the new value active/archive"
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+ .. _ref_flyteidl.admin.ExecutionUpdateResponse:
1149
+
1150
+ ExecutionUpdateResponse
1151
+ ------------------------------------------------------------------
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1102
1162
  .. _ref_flyteidl.admin.LiteralMapBlob:
1103
1163
 
1104
1164
  LiteralMapBlob
@@ -1251,6 +1311,22 @@ The method by which this execution was launched.
1251
1311
  "CHILD_WORKFLOW", "4", "This execution was triggered by another execution."
1252
1312
  "RECOVERED", "5", "This execution was recovered from another execution."
1253
1313
 
1314
+
1315
+
1316
+ .. _ref_flyteidl.admin.ExecutionState:
1317
+
1318
+ ExecutionState
1319
+ ------------------------------------------------------------------
1320
+
1321
+ The state of the execution is used to control its visibility in the UI/CLI.
1322
+
1323
+ .. csv-table:: Enum ExecutionState values
1324
+ :header: "Name", "Number", "Description"
1325
+ :widths: auto
1326
+
1327
+ "EXECUTION_ACTIVE", "0", "By default, all executions are considered active."
1328
+ "EXECUTION_ARCHIVED", "1", "Archived executions are no longer visible in the UI."
1329
+
1254
1330
  <!-- end enums -->
1255
1331
 
1256
1332
  <!-- end HasExtensions -->
@@ -1507,6 +1507,7 @@ Scalar
1507
1507
  "none_type", ":ref:`ref_flyteidl.core.Void`", "", ""
1508
1508
  "error", ":ref:`ref_flyteidl.core.Error`", "", ""
1509
1509
  "generic", ":ref:`ref_google.protobuf.Struct`", "", ""
1510
+ "structured_dataset", ":ref:`ref_flyteidl.core.StructuredDataset`", "", ""
1510
1511
 
1511
1512
 
1512
1513
 
@@ -1536,6 +1537,49 @@ A strongly typed schema that defines the interface of data retrieved from the un
1536
1537
 
1537
1538
 
1538
1539
 
1540
+ .. _ref_flyteidl.core.StructuredDataset:
1541
+
1542
+ StructuredDataset
1543
+ ------------------------------------------------------------------
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+ .. csv-table:: StructuredDataset type fields
1550
+ :header: "Field", "Type", "Label", "Description"
1551
+ :widths: auto
1552
+
1553
+ "uri", ":ref:`ref_string`", "", "String location uniquely identifying where the data is. Should start with the storage location (e.g. s3://, gs://, bq://, etc.)"
1554
+ "metadata", ":ref:`ref_flyteidl.core.StructuredDatasetMetadata`", "", ""
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+ .. _ref_flyteidl.core.StructuredDatasetMetadata:
1563
+
1564
+ StructuredDatasetMetadata
1565
+ ------------------------------------------------------------------
1566
+
1567
+
1568
+
1569
+
1570
+
1571
+ .. csv-table:: StructuredDatasetMetadata type fields
1572
+ :header: "Field", "Type", "Label", "Description"
1573
+ :widths: auto
1574
+
1575
+ "structured_dataset_type", ":ref:`ref_flyteidl.core.StructuredDatasetType`", "", "Bundle the type information along with the literal. This is here because StructuredDatasets can often be more defined at run time than at compile time. That is, at compile time you might only declare a task to return a pandas dataframe or a StructuredDataset, without any column information, but at run time, you might have that column information. flytekit python will copy this type information into the literal, from the type information, if not provided by the various plugins (encoders). Since this field is run time generated, it&#39;s not used for any type checking."
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+
1582
+
1539
1583
  .. _ref_flyteidl.core.Void:
1540
1584
 
1541
1585
  Void
@@ -2337,6 +2381,7 @@ Defines a strong type to allow type checking between interfaces.
2337
2381
  "map_value_type", ":ref:`ref_flyteidl.core.LiteralType`", "", "Defines the type of the value of a map type. The type of the key is always a string."
2338
2382
  "blob", ":ref:`ref_flyteidl.core.BlobType`", "", "A blob might have specialized implementation details depending on associated metadata."
2339
2383
  "enum_type", ":ref:`ref_flyteidl.core.EnumType`", "", "Defines an enum with pre-defined string values."
2384
+ "structured_dataset_type", ":ref:`ref_flyteidl.core.StructuredDatasetType`", "", "Generalized schema support"
2340
2385
  "metadata", ":ref:`ref_google.protobuf.Struct`", "", "This field contains type metadata that is descriptive of the type, but is NOT considered in type-checking. This might be used by consumers to identify special behavior or display extended information for the type."
2341
2386
 
2342
2387
 
@@ -2409,6 +2454,52 @@ SchemaType.SchemaColumn
2409
2454
 
2410
2455
 
2411
2456
 
2457
+
2458
+
2459
+ .. _ref_flyteidl.core.StructuredDatasetType:
2460
+
2461
+ StructuredDatasetType
2462
+ ------------------------------------------------------------------
2463
+
2464
+
2465
+
2466
+
2467
+
2468
+ .. csv-table:: StructuredDatasetType type fields
2469
+ :header: "Field", "Type", "Label", "Description"
2470
+ :widths: auto
2471
+
2472
+ "columns", ":ref:`ref_flyteidl.core.StructuredDatasetType.DatasetColumn`", "repeated", "A list of ordered columns this schema comprises of."
2473
+ "format", ":ref:`ref_string`", "", "This is the storage format, the format of the bits at rest parquet, feather, csv, etc. For two types to be compatible, the format will need to be an exact match."
2474
+ "external_schema_type", ":ref:`ref_string`", "", "This is a string representing the type that the bytes in external_schema_bytes are formatted in. This is an optional field that will not be used for type checking."
2475
+ "external_schema_bytes", ":ref:`ref_bytes`", "", "The serialized bytes of a third-party schema library like Arrow. This is an optional field that will not be used for type checking."
2476
+
2477
+
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+ .. _ref_flyteidl.core.StructuredDatasetType.DatasetColumn:
2484
+
2485
+ StructuredDatasetType.DatasetColumn
2486
+ ------------------------------------------------------------------
2487
+
2488
+
2489
+
2490
+
2491
+
2492
+ .. csv-table:: StructuredDatasetType.DatasetColumn type fields
2493
+ :header: "Field", "Type", "Label", "Description"
2494
+ :widths: auto
2495
+
2496
+ "name", ":ref:`ref_string`", "", "A unique name within the schema type for the column."
2497
+ "literal_type", ":ref:`ref_flyteidl.core.LiteralType`", "", "The column type."
2498
+
2499
+
2500
+
2501
+
2502
+
2412
2503
 
2413
2504
 
2414
2505
 
@@ -50,6 +50,9 @@ This message contains metadata about external resources produced or used by a sp
50
50
  :widths: auto
51
51
 
52
52
  "external_id", ":ref:`ref_string`", "", "Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids."
53
+ "index", ":ref:`ref_uint32`", "", "A unique index for the external resource with respect to all external resources for this task. Although the identifier may change between task reporting events or retries, this will remain the same to enable aggregating information from multiple reports."
54
+ "retry_attempt", ":ref:`ref_uint32`", "", "Retry attempt number for this external resource, ie., 2 for the second attempt"
55
+ "phase", ":ref:`ref_flyteidl.core.TaskExecution.Phase`", "", "Phase associated with the external resource"
53
56
 
54
57
 
55
58
 
@@ -51,6 +51,7 @@ Standard response codes for both are defined here: https://github.com/grpc-ecosy
51
51
  "RelaunchExecution", ":ref:`ref_flyteidl.admin.ExecutionRelaunchRequest`", ":ref:`ref_flyteidl.admin.ExecutionCreateResponse`", "Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`"
52
52
  "RecoverExecution", ":ref:`ref_flyteidl.admin.ExecutionRecoverRequest`", ":ref:`ref_flyteidl.admin.ExecutionCreateResponse`", "Recreates a previously-run workflow execution that will only start executing from the last known failure point. In Recover mode, users cannot change any input parameters or update the version of the execution. This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again. See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details."
53
53
  "GetExecution", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetRequest`", ":ref:`ref_flyteidl.admin.Execution`", "Fetches a :ref:`ref_flyteidl.admin.Execution`."
54
+ "UpdateExecution", ":ref:`ref_flyteidl.admin.ExecutionUpdateRequest`", ":ref:`ref_flyteidl.admin.ExecutionUpdateResponse`", "Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`."
54
55
  "GetExecutionData", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetDataRequest`", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetDataResponse`", "Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`."
55
56
  "ListExecutions", ":ref:`ref_flyteidl.admin.ResourceListRequest`", ":ref:`ref_flyteidl.admin.ExecutionList`", "Fetch a list of :ref:`ref_flyteidl.admin.Execution`."
56
57
  "TerminateExecution", ":ref:`ref_flyteidl.admin.ExecutionTerminateRequest`", ":ref:`ref_flyteidl.admin.ExecutionTerminateResponse`", "Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`."
@@ -169,6 +169,9 @@ message ExecutionClosure {
169
169
 
170
170
  // Identifies the workflow definition for this execution.
171
171
  core.Identifier workflow_id = 11;
172
+
173
+ // Provides the details of the last stage change
174
+ ExecutionStateChangeDetails state_change_details = 14;
172
175
  }
173
176
 
174
177
  // Represents system, rather than user-facing, metadata about an execution.
@@ -320,3 +323,33 @@ message WorkflowExecutionGetDataResponse {
320
323
  // Full_outputs will only be populated if they are under a configured size threshold.
321
324
  core.LiteralMap full_outputs = 4;
322
325
  }
326
+
327
+ // The state of the execution is used to control its visibility in the UI/CLI.
328
+ enum ExecutionState {
329
+ // By default, all executions are considered active.
330
+ EXECUTION_ACTIVE = 0;
331
+
332
+ // Archived executions are no longer visible in the UI.
333
+ EXECUTION_ARCHIVED = 1;
334
+ }
335
+
336
+ message ExecutionUpdateRequest {
337
+ // Identifier of the execution to update
338
+ core.WorkflowExecutionIdentifier id = 1;
339
+
340
+ // State to set as the new value active/archive
341
+ ExecutionState state = 2;
342
+ }
343
+
344
+ message ExecutionStateChangeDetails {
345
+ // The state of the execution is used to control its visibility in the UI/CLI.
346
+ ExecutionState state = 1;
347
+
348
+ // This timestamp represents when the state changed.
349
+ google.protobuf.Timestamp occurred_at = 2;
350
+
351
+ // Identifies the entity (if any) responsible for causing the state change of the execution
352
+ string principal = 3;
353
+ }
354
+
355
+ message ExecutionUpdateResponse {}
@@ -193,6 +193,17 @@ message ExternalResourceInfo {
193
193
 
194
194
  // Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids.
195
195
  string external_id = 1;
196
+
197
+ // A unique index for the external resource with respect to all external resources for this task. Although the
198
+ // identifier may change between task reporting events or retries, this will remain the same to enable aggregating
199
+ // information from multiple reports.
200
+ uint32 index = 2;
201
+
202
+ // Retry attempt number for this external resource, ie., 2 for the second attempt
203
+ uint32 retry_attempt = 3;
204
+
205
+ // Phase associated with the external resource
206
+ core.TaskExecution.Phase phase = 4;
196
207
  }
197
208
 
198
209
 
@@ -277,6 +277,17 @@ service AdminService {
277
277
  };
278
278
  }
279
279
 
280
+ // Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
281
+ rpc UpdateExecution (flyteidl.admin.ExecutionUpdateRequest) returns (flyteidl.admin.ExecutionUpdateResponse) {
282
+ option (google.api.http) = {
283
+ put: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
284
+ body: "*"
285
+ };
286
+ option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
287
+ description: "Update execution belonging to project domain."
288
+ };
289
+ }
290
+
280
291
  // Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
281
292
  rpc GetExecutionData (flyteidl.admin.WorkflowExecutionGetDataRequest) returns (flyteidl.admin.WorkflowExecutionGetDataResponse) {
282
293
  option (google.api.http) = {