@flyteorg/flyteidl 0.21.22 → 0.22.0
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/gen/pb-js/flyteidl.d.ts +259 -0
- package/gen/pb-js/flyteidl.js +575 -0
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +438 -362
- package/protos/docs/core/core.rst +62 -40
- package/protos/docs/service/service.rst +1 -0
- package/protos/flyteidl/admin/execution.proto +33 -0
- package/protos/flyteidl/core/types.proto +10 -0
- package/protos/flyteidl/service/admin.proto +11 -0
package/gen/pb-js/flyteidl.d.ts
CHANGED
|
@@ -3290,6 +3290,58 @@ export namespace flyteidl {
|
|
|
3290
3290
|
public static verify(message: { [k: string]: any }): (string|null);
|
|
3291
3291
|
}
|
|
3292
3292
|
|
|
3293
|
+
/** Properties of a TypeAnnotation. */
|
|
3294
|
+
interface ITypeAnnotation {
|
|
3295
|
+
|
|
3296
|
+
/** TypeAnnotation annotations */
|
|
3297
|
+
annotations?: (google.protobuf.IStruct|null);
|
|
3298
|
+
}
|
|
3299
|
+
|
|
3300
|
+
/** Represents a TypeAnnotation. */
|
|
3301
|
+
class TypeAnnotation implements ITypeAnnotation {
|
|
3302
|
+
|
|
3303
|
+
/**
|
|
3304
|
+
* Constructs a new TypeAnnotation.
|
|
3305
|
+
* @param [properties] Properties to set
|
|
3306
|
+
*/
|
|
3307
|
+
constructor(properties?: flyteidl.core.ITypeAnnotation);
|
|
3308
|
+
|
|
3309
|
+
/** TypeAnnotation annotations. */
|
|
3310
|
+
public annotations?: (google.protobuf.IStruct|null);
|
|
3311
|
+
|
|
3312
|
+
/**
|
|
3313
|
+
* Creates a new TypeAnnotation instance using the specified properties.
|
|
3314
|
+
* @param [properties] Properties to set
|
|
3315
|
+
* @returns TypeAnnotation instance
|
|
3316
|
+
*/
|
|
3317
|
+
public static create(properties?: flyteidl.core.ITypeAnnotation): flyteidl.core.TypeAnnotation;
|
|
3318
|
+
|
|
3319
|
+
/**
|
|
3320
|
+
* Encodes the specified TypeAnnotation message. Does not implicitly {@link flyteidl.core.TypeAnnotation.verify|verify} messages.
|
|
3321
|
+
* @param message TypeAnnotation message or plain object to encode
|
|
3322
|
+
* @param [writer] Writer to encode to
|
|
3323
|
+
* @returns Writer
|
|
3324
|
+
*/
|
|
3325
|
+
public static encode(message: flyteidl.core.ITypeAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
3326
|
+
|
|
3327
|
+
/**
|
|
3328
|
+
* Decodes a TypeAnnotation message from the specified reader or buffer.
|
|
3329
|
+
* @param reader Reader or buffer to decode from
|
|
3330
|
+
* @param [length] Message length if known beforehand
|
|
3331
|
+
* @returns TypeAnnotation
|
|
3332
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
3333
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
3334
|
+
*/
|
|
3335
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.core.TypeAnnotation;
|
|
3336
|
+
|
|
3337
|
+
/**
|
|
3338
|
+
* Verifies a TypeAnnotation message.
|
|
3339
|
+
* @param message Plain object to verify
|
|
3340
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
3341
|
+
*/
|
|
3342
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
3343
|
+
}
|
|
3344
|
+
|
|
3293
3345
|
/** Properties of a LiteralType. */
|
|
3294
3346
|
interface ILiteralType {
|
|
3295
3347
|
|
|
@@ -3316,6 +3368,9 @@ export namespace flyteidl {
|
|
|
3316
3368
|
|
|
3317
3369
|
/** LiteralType metadata */
|
|
3318
3370
|
metadata?: (google.protobuf.IStruct|null);
|
|
3371
|
+
|
|
3372
|
+
/** LiteralType annotation */
|
|
3373
|
+
annotation?: (flyteidl.core.ITypeAnnotation|null);
|
|
3319
3374
|
}
|
|
3320
3375
|
|
|
3321
3376
|
/** Represents a LiteralType. */
|
|
@@ -3351,6 +3406,9 @@ export namespace flyteidl {
|
|
|
3351
3406
|
/** LiteralType metadata. */
|
|
3352
3407
|
public metadata?: (google.protobuf.IStruct|null);
|
|
3353
3408
|
|
|
3409
|
+
/** LiteralType annotation. */
|
|
3410
|
+
public annotation?: (flyteidl.core.ITypeAnnotation|null);
|
|
3411
|
+
|
|
3354
3412
|
/** LiteralType type. */
|
|
3355
3413
|
public type?: ("simple"|"schema"|"collectionType"|"mapValueType"|"blob"|"enumType"|"structuredDatasetType");
|
|
3356
3414
|
|
|
@@ -9088,6 +9146,9 @@ export namespace flyteidl {
|
|
|
9088
9146
|
|
|
9089
9147
|
/** ExecutionClosure workflowId */
|
|
9090
9148
|
workflowId?: (flyteidl.core.IIdentifier|null);
|
|
9149
|
+
|
|
9150
|
+
/** ExecutionClosure stateChangeDetails */
|
|
9151
|
+
stateChangeDetails?: (flyteidl.admin.IExecutionStateChangeDetails|null);
|
|
9091
9152
|
}
|
|
9092
9153
|
|
|
9093
9154
|
/** Represents an ExecutionClosure. */
|
|
@@ -9138,6 +9199,9 @@ export namespace flyteidl {
|
|
|
9138
9199
|
/** ExecutionClosure workflowId. */
|
|
9139
9200
|
public workflowId?: (flyteidl.core.IIdentifier|null);
|
|
9140
9201
|
|
|
9202
|
+
/** ExecutionClosure stateChangeDetails. */
|
|
9203
|
+
public stateChangeDetails?: (flyteidl.admin.IExecutionStateChangeDetails|null);
|
|
9204
|
+
|
|
9141
9205
|
/** ExecutionClosure outputResult. */
|
|
9142
9206
|
public outputResult?: ("outputs"|"error"|"abortCause"|"abortMetadata"|"outputData");
|
|
9143
9207
|
|
|
@@ -9720,6 +9784,180 @@ export namespace flyteidl {
|
|
|
9720
9784
|
public static verify(message: { [k: string]: any }): (string|null);
|
|
9721
9785
|
}
|
|
9722
9786
|
|
|
9787
|
+
/** ExecutionState enum. */
|
|
9788
|
+
enum ExecutionState {
|
|
9789
|
+
EXECUTION_ACTIVE = 0,
|
|
9790
|
+
EXECUTION_ARCHIVED = 1
|
|
9791
|
+
}
|
|
9792
|
+
|
|
9793
|
+
/** Properties of an ExecutionUpdateRequest. */
|
|
9794
|
+
interface IExecutionUpdateRequest {
|
|
9795
|
+
|
|
9796
|
+
/** ExecutionUpdateRequest id */
|
|
9797
|
+
id?: (flyteidl.core.IWorkflowExecutionIdentifier|null);
|
|
9798
|
+
|
|
9799
|
+
/** ExecutionUpdateRequest state */
|
|
9800
|
+
state?: (flyteidl.admin.ExecutionState|null);
|
|
9801
|
+
}
|
|
9802
|
+
|
|
9803
|
+
/** Represents an ExecutionUpdateRequest. */
|
|
9804
|
+
class ExecutionUpdateRequest implements IExecutionUpdateRequest {
|
|
9805
|
+
|
|
9806
|
+
/**
|
|
9807
|
+
* Constructs a new ExecutionUpdateRequest.
|
|
9808
|
+
* @param [properties] Properties to set
|
|
9809
|
+
*/
|
|
9810
|
+
constructor(properties?: flyteidl.admin.IExecutionUpdateRequest);
|
|
9811
|
+
|
|
9812
|
+
/** ExecutionUpdateRequest id. */
|
|
9813
|
+
public id?: (flyteidl.core.IWorkflowExecutionIdentifier|null);
|
|
9814
|
+
|
|
9815
|
+
/** ExecutionUpdateRequest state. */
|
|
9816
|
+
public state: flyteidl.admin.ExecutionState;
|
|
9817
|
+
|
|
9818
|
+
/**
|
|
9819
|
+
* Creates a new ExecutionUpdateRequest instance using the specified properties.
|
|
9820
|
+
* @param [properties] Properties to set
|
|
9821
|
+
* @returns ExecutionUpdateRequest instance
|
|
9822
|
+
*/
|
|
9823
|
+
public static create(properties?: flyteidl.admin.IExecutionUpdateRequest): flyteidl.admin.ExecutionUpdateRequest;
|
|
9824
|
+
|
|
9825
|
+
/**
|
|
9826
|
+
* Encodes the specified ExecutionUpdateRequest message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateRequest.verify|verify} messages.
|
|
9827
|
+
* @param message ExecutionUpdateRequest message or plain object to encode
|
|
9828
|
+
* @param [writer] Writer to encode to
|
|
9829
|
+
* @returns Writer
|
|
9830
|
+
*/
|
|
9831
|
+
public static encode(message: flyteidl.admin.IExecutionUpdateRequest, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
9832
|
+
|
|
9833
|
+
/**
|
|
9834
|
+
* Decodes an ExecutionUpdateRequest message from the specified reader or buffer.
|
|
9835
|
+
* @param reader Reader or buffer to decode from
|
|
9836
|
+
* @param [length] Message length if known beforehand
|
|
9837
|
+
* @returns ExecutionUpdateRequest
|
|
9838
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
9839
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
9840
|
+
*/
|
|
9841
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionUpdateRequest;
|
|
9842
|
+
|
|
9843
|
+
/**
|
|
9844
|
+
* Verifies an ExecutionUpdateRequest message.
|
|
9845
|
+
* @param message Plain object to verify
|
|
9846
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
9847
|
+
*/
|
|
9848
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
9849
|
+
}
|
|
9850
|
+
|
|
9851
|
+
/** Properties of an ExecutionStateChangeDetails. */
|
|
9852
|
+
interface IExecutionStateChangeDetails {
|
|
9853
|
+
|
|
9854
|
+
/** ExecutionStateChangeDetails state */
|
|
9855
|
+
state?: (flyteidl.admin.ExecutionState|null);
|
|
9856
|
+
|
|
9857
|
+
/** ExecutionStateChangeDetails occurredAt */
|
|
9858
|
+
occurredAt?: (google.protobuf.ITimestamp|null);
|
|
9859
|
+
|
|
9860
|
+
/** ExecutionStateChangeDetails principal */
|
|
9861
|
+
principal?: (string|null);
|
|
9862
|
+
}
|
|
9863
|
+
|
|
9864
|
+
/** Represents an ExecutionStateChangeDetails. */
|
|
9865
|
+
class ExecutionStateChangeDetails implements IExecutionStateChangeDetails {
|
|
9866
|
+
|
|
9867
|
+
/**
|
|
9868
|
+
* Constructs a new ExecutionStateChangeDetails.
|
|
9869
|
+
* @param [properties] Properties to set
|
|
9870
|
+
*/
|
|
9871
|
+
constructor(properties?: flyteidl.admin.IExecutionStateChangeDetails);
|
|
9872
|
+
|
|
9873
|
+
/** ExecutionStateChangeDetails state. */
|
|
9874
|
+
public state: flyteidl.admin.ExecutionState;
|
|
9875
|
+
|
|
9876
|
+
/** ExecutionStateChangeDetails occurredAt. */
|
|
9877
|
+
public occurredAt?: (google.protobuf.ITimestamp|null);
|
|
9878
|
+
|
|
9879
|
+
/** ExecutionStateChangeDetails principal. */
|
|
9880
|
+
public principal: string;
|
|
9881
|
+
|
|
9882
|
+
/**
|
|
9883
|
+
* Creates a new ExecutionStateChangeDetails instance using the specified properties.
|
|
9884
|
+
* @param [properties] Properties to set
|
|
9885
|
+
* @returns ExecutionStateChangeDetails instance
|
|
9886
|
+
*/
|
|
9887
|
+
public static create(properties?: flyteidl.admin.IExecutionStateChangeDetails): flyteidl.admin.ExecutionStateChangeDetails;
|
|
9888
|
+
|
|
9889
|
+
/**
|
|
9890
|
+
* Encodes the specified ExecutionStateChangeDetails message. Does not implicitly {@link flyteidl.admin.ExecutionStateChangeDetails.verify|verify} messages.
|
|
9891
|
+
* @param message ExecutionStateChangeDetails message or plain object to encode
|
|
9892
|
+
* @param [writer] Writer to encode to
|
|
9893
|
+
* @returns Writer
|
|
9894
|
+
*/
|
|
9895
|
+
public static encode(message: flyteidl.admin.IExecutionStateChangeDetails, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
9896
|
+
|
|
9897
|
+
/**
|
|
9898
|
+
* Decodes an ExecutionStateChangeDetails message from the specified reader or buffer.
|
|
9899
|
+
* @param reader Reader or buffer to decode from
|
|
9900
|
+
* @param [length] Message length if known beforehand
|
|
9901
|
+
* @returns ExecutionStateChangeDetails
|
|
9902
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
9903
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
9904
|
+
*/
|
|
9905
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionStateChangeDetails;
|
|
9906
|
+
|
|
9907
|
+
/**
|
|
9908
|
+
* Verifies an ExecutionStateChangeDetails message.
|
|
9909
|
+
* @param message Plain object to verify
|
|
9910
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
9911
|
+
*/
|
|
9912
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
9913
|
+
}
|
|
9914
|
+
|
|
9915
|
+
/** Properties of an ExecutionUpdateResponse. */
|
|
9916
|
+
interface IExecutionUpdateResponse {
|
|
9917
|
+
}
|
|
9918
|
+
|
|
9919
|
+
/** Represents an ExecutionUpdateResponse. */
|
|
9920
|
+
class ExecutionUpdateResponse implements IExecutionUpdateResponse {
|
|
9921
|
+
|
|
9922
|
+
/**
|
|
9923
|
+
* Constructs a new ExecutionUpdateResponse.
|
|
9924
|
+
* @param [properties] Properties to set
|
|
9925
|
+
*/
|
|
9926
|
+
constructor(properties?: flyteidl.admin.IExecutionUpdateResponse);
|
|
9927
|
+
|
|
9928
|
+
/**
|
|
9929
|
+
* Creates a new ExecutionUpdateResponse instance using the specified properties.
|
|
9930
|
+
* @param [properties] Properties to set
|
|
9931
|
+
* @returns ExecutionUpdateResponse instance
|
|
9932
|
+
*/
|
|
9933
|
+
public static create(properties?: flyteidl.admin.IExecutionUpdateResponse): flyteidl.admin.ExecutionUpdateResponse;
|
|
9934
|
+
|
|
9935
|
+
/**
|
|
9936
|
+
* Encodes the specified ExecutionUpdateResponse message. Does not implicitly {@link flyteidl.admin.ExecutionUpdateResponse.verify|verify} messages.
|
|
9937
|
+
* @param message ExecutionUpdateResponse message or plain object to encode
|
|
9938
|
+
* @param [writer] Writer to encode to
|
|
9939
|
+
* @returns Writer
|
|
9940
|
+
*/
|
|
9941
|
+
public static encode(message: flyteidl.admin.IExecutionUpdateResponse, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
9942
|
+
|
|
9943
|
+
/**
|
|
9944
|
+
* Decodes an ExecutionUpdateResponse message from the specified reader or buffer.
|
|
9945
|
+
* @param reader Reader or buffer to decode from
|
|
9946
|
+
* @param [length] Message length if known beforehand
|
|
9947
|
+
* @returns ExecutionUpdateResponse
|
|
9948
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
9949
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
9950
|
+
*/
|
|
9951
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.admin.ExecutionUpdateResponse;
|
|
9952
|
+
|
|
9953
|
+
/**
|
|
9954
|
+
* Verifies an ExecutionUpdateResponse message.
|
|
9955
|
+
* @param message Plain object to verify
|
|
9956
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
9957
|
+
*/
|
|
9958
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
9959
|
+
}
|
|
9960
|
+
|
|
9723
9961
|
/** Properties of a LaunchPlanCreateRequest. */
|
|
9724
9962
|
interface ILaunchPlanCreateRequest {
|
|
9725
9963
|
|
|
@@ -15164,6 +15402,20 @@ export namespace flyteidl {
|
|
|
15164
15402
|
*/
|
|
15165
15403
|
public getExecution(request: flyteidl.admin.IWorkflowExecutionGetRequest): Promise<flyteidl.admin.Execution>;
|
|
15166
15404
|
|
|
15405
|
+
/**
|
|
15406
|
+
* Calls UpdateExecution.
|
|
15407
|
+
* @param request ExecutionUpdateRequest message or plain object
|
|
15408
|
+
* @param callback Node-style callback called with the error, if any, and ExecutionUpdateResponse
|
|
15409
|
+
*/
|
|
15410
|
+
public updateExecution(request: flyteidl.admin.IExecutionUpdateRequest, callback: flyteidl.service.AdminService.UpdateExecutionCallback): void;
|
|
15411
|
+
|
|
15412
|
+
/**
|
|
15413
|
+
* Calls UpdateExecution.
|
|
15414
|
+
* @param request ExecutionUpdateRequest message or plain object
|
|
15415
|
+
* @returns Promise
|
|
15416
|
+
*/
|
|
15417
|
+
public updateExecution(request: flyteidl.admin.IExecutionUpdateRequest): Promise<flyteidl.admin.ExecutionUpdateResponse>;
|
|
15418
|
+
|
|
15167
15419
|
/**
|
|
15168
15420
|
* Calls GetExecutionData.
|
|
15169
15421
|
* @param request WorkflowExecutionGetDataRequest message or plain object
|
|
@@ -15678,6 +15930,13 @@ export namespace flyteidl {
|
|
|
15678
15930
|
*/
|
|
15679
15931
|
type GetExecutionCallback = (error: (Error|null), response?: flyteidl.admin.Execution) => void;
|
|
15680
15932
|
|
|
15933
|
+
/**
|
|
15934
|
+
* Callback as used by {@link flyteidl.service.AdminService#updateExecution}.
|
|
15935
|
+
* @param error Error, if any
|
|
15936
|
+
* @param [response] ExecutionUpdateResponse
|
|
15937
|
+
*/
|
|
15938
|
+
type UpdateExecutionCallback = (error: (Error|null), response?: flyteidl.admin.ExecutionUpdateResponse) => void;
|
|
15939
|
+
|
|
15681
15940
|
/**
|
|
15682
15941
|
* Callback as used by {@link flyteidl.service.AdminService#getExecutionData}.
|
|
15683
15942
|
* @param error Error, if any
|