@flyteorg/flyteidl 1.2.2 → 1.2.3
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 +26 -1
- package/gen/pb-js/flyteidl.js +73 -0
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +4 -0
- package/protos/docs/core/core.rst +1 -0
- package/protos/docs/datacatalog/datacatalog.rst +46 -0
- package/protos/flyteidl/admin/execution.proto +13 -0
- package/protos/flyteidl/admin/launch_plan.proto +5 -0
- package/protos/flyteidl/admin/matchable_resource.proto +5 -0
- package/protos/flyteidl/core/catalog.proto +2 -0
- package/protos/flyteidl/datacatalog/datacatalog.proto +29 -0
package/gen/pb-js/flyteidl.d.ts
CHANGED
|
@@ -12,7 +12,8 @@ export namespace flyteidl {
|
|
|
12
12
|
CACHE_HIT = 2,
|
|
13
13
|
CACHE_POPULATED = 3,
|
|
14
14
|
CACHE_LOOKUP_FAILURE = 4,
|
|
15
|
-
CACHE_PUT_FAILURE = 5
|
|
15
|
+
CACHE_PUT_FAILURE = 5,
|
|
16
|
+
CACHE_SKIPPED = 6
|
|
16
17
|
}
|
|
17
18
|
|
|
18
19
|
/** Properties of a CatalogArtifactTag. */
|
|
@@ -9289,6 +9290,9 @@ export namespace flyteidl {
|
|
|
9289
9290
|
|
|
9290
9291
|
/** ExecutionRelaunchRequest name */
|
|
9291
9292
|
name?: (string|null);
|
|
9293
|
+
|
|
9294
|
+
/** ExecutionRelaunchRequest overwriteCache */
|
|
9295
|
+
overwriteCache?: (boolean|null);
|
|
9292
9296
|
}
|
|
9293
9297
|
|
|
9294
9298
|
/** Represents an ExecutionRelaunchRequest. */
|
|
@@ -9306,6 +9310,9 @@ export namespace flyteidl {
|
|
|
9306
9310
|
/** ExecutionRelaunchRequest name. */
|
|
9307
9311
|
public name: string;
|
|
9308
9312
|
|
|
9313
|
+
/** ExecutionRelaunchRequest overwriteCache. */
|
|
9314
|
+
public overwriteCache: boolean;
|
|
9315
|
+
|
|
9309
9316
|
/**
|
|
9310
9317
|
* Creates a new ExecutionRelaunchRequest instance using the specified properties.
|
|
9311
9318
|
* @param [properties] Properties to set
|
|
@@ -10130,6 +10137,9 @@ export namespace flyteidl {
|
|
|
10130
10137
|
|
|
10131
10138
|
/** ExecutionSpec interruptible */
|
|
10132
10139
|
interruptible?: (google.protobuf.IBoolValue|null);
|
|
10140
|
+
|
|
10141
|
+
/** ExecutionSpec overwriteCache */
|
|
10142
|
+
overwriteCache?: (boolean|null);
|
|
10133
10143
|
}
|
|
10134
10144
|
|
|
10135
10145
|
/** Represents an ExecutionSpec. */
|
|
@@ -10183,6 +10193,9 @@ export namespace flyteidl {
|
|
|
10183
10193
|
/** ExecutionSpec interruptible. */
|
|
10184
10194
|
public interruptible?: (google.protobuf.IBoolValue|null);
|
|
10185
10195
|
|
|
10196
|
+
/** ExecutionSpec overwriteCache. */
|
|
10197
|
+
public overwriteCache: boolean;
|
|
10198
|
+
|
|
10186
10199
|
/** ExecutionSpec notificationOverrides. */
|
|
10187
10200
|
public notificationOverrides?: ("notifications"|"disableAll");
|
|
10188
10201
|
|
|
@@ -10953,6 +10966,9 @@ export namespace flyteidl {
|
|
|
10953
10966
|
|
|
10954
10967
|
/** LaunchPlanSpec interruptible */
|
|
10955
10968
|
interruptible?: (google.protobuf.IBoolValue|null);
|
|
10969
|
+
|
|
10970
|
+
/** LaunchPlanSpec overwriteCache */
|
|
10971
|
+
overwriteCache?: (boolean|null);
|
|
10956
10972
|
}
|
|
10957
10973
|
|
|
10958
10974
|
/** Represents a LaunchPlanSpec. */
|
|
@@ -11006,6 +11022,9 @@ export namespace flyteidl {
|
|
|
11006
11022
|
/** LaunchPlanSpec interruptible. */
|
|
11007
11023
|
public interruptible?: (google.protobuf.IBoolValue|null);
|
|
11008
11024
|
|
|
11025
|
+
/** LaunchPlanSpec overwriteCache. */
|
|
11026
|
+
public overwriteCache: boolean;
|
|
11027
|
+
|
|
11009
11028
|
/**
|
|
11010
11029
|
* Creates a new LaunchPlanSpec instance using the specified properties.
|
|
11011
11030
|
* @param [properties] Properties to set
|
|
@@ -12048,6 +12067,9 @@ export namespace flyteidl {
|
|
|
12048
12067
|
|
|
12049
12068
|
/** WorkflowExecutionConfig interruptible */
|
|
12050
12069
|
interruptible?: (google.protobuf.IBoolValue|null);
|
|
12070
|
+
|
|
12071
|
+
/** WorkflowExecutionConfig overwriteCache */
|
|
12072
|
+
overwriteCache?: (boolean|null);
|
|
12051
12073
|
}
|
|
12052
12074
|
|
|
12053
12075
|
/** Represents a WorkflowExecutionConfig. */
|
|
@@ -12077,6 +12099,9 @@ export namespace flyteidl {
|
|
|
12077
12099
|
/** WorkflowExecutionConfig interruptible. */
|
|
12078
12100
|
public interruptible?: (google.protobuf.IBoolValue|null);
|
|
12079
12101
|
|
|
12102
|
+
/** WorkflowExecutionConfig overwriteCache. */
|
|
12103
|
+
public overwriteCache: boolean;
|
|
12104
|
+
|
|
12080
12105
|
/**
|
|
12081
12106
|
* Creates a new WorkflowExecutionConfig instance using the specified properties.
|
|
12082
12107
|
* @param [properties] Properties to set
|
package/gen/pb-js/flyteidl.js
CHANGED
|
@@ -44,6 +44,7 @@
|
|
|
44
44
|
* @property {number} CACHE_POPULATED=3 CACHE_POPULATED value
|
|
45
45
|
* @property {number} CACHE_LOOKUP_FAILURE=4 CACHE_LOOKUP_FAILURE value
|
|
46
46
|
* @property {number} CACHE_PUT_FAILURE=5 CACHE_PUT_FAILURE value
|
|
47
|
+
* @property {number} CACHE_SKIPPED=6 CACHE_SKIPPED value
|
|
47
48
|
*/
|
|
48
49
|
core.CatalogCacheStatus = (function() {
|
|
49
50
|
var valuesById = {}, values = Object.create(valuesById);
|
|
@@ -53,6 +54,7 @@
|
|
|
53
54
|
values[valuesById[3] = "CACHE_POPULATED"] = 3;
|
|
54
55
|
values[valuesById[4] = "CACHE_LOOKUP_FAILURE"] = 4;
|
|
55
56
|
values[valuesById[5] = "CACHE_PUT_FAILURE"] = 5;
|
|
57
|
+
values[valuesById[6] = "CACHE_SKIPPED"] = 6;
|
|
56
58
|
return values;
|
|
57
59
|
})();
|
|
58
60
|
|
|
@@ -16348,6 +16350,7 @@
|
|
|
16348
16350
|
case 3:
|
|
16349
16351
|
case 4:
|
|
16350
16352
|
case 5:
|
|
16353
|
+
case 6:
|
|
16351
16354
|
break;
|
|
16352
16355
|
}
|
|
16353
16356
|
if (message.catalogKey != null && message.hasOwnProperty("catalogKey")) {
|
|
@@ -17385,6 +17388,7 @@
|
|
|
17385
17388
|
case 3:
|
|
17386
17389
|
case 4:
|
|
17387
17390
|
case 5:
|
|
17391
|
+
case 6:
|
|
17388
17392
|
break;
|
|
17389
17393
|
}
|
|
17390
17394
|
if (message.logs != null && message.hasOwnProperty("logs")) {
|
|
@@ -22252,6 +22256,7 @@
|
|
|
22252
22256
|
* @interface IExecutionRelaunchRequest
|
|
22253
22257
|
* @property {flyteidl.core.IWorkflowExecutionIdentifier|null} [id] ExecutionRelaunchRequest id
|
|
22254
22258
|
* @property {string|null} [name] ExecutionRelaunchRequest name
|
|
22259
|
+
* @property {boolean|null} [overwriteCache] ExecutionRelaunchRequest overwriteCache
|
|
22255
22260
|
*/
|
|
22256
22261
|
|
|
22257
22262
|
/**
|
|
@@ -22285,6 +22290,14 @@
|
|
|
22285
22290
|
*/
|
|
22286
22291
|
ExecutionRelaunchRequest.prototype.name = "";
|
|
22287
22292
|
|
|
22293
|
+
/**
|
|
22294
|
+
* ExecutionRelaunchRequest overwriteCache.
|
|
22295
|
+
* @member {boolean} overwriteCache
|
|
22296
|
+
* @memberof flyteidl.admin.ExecutionRelaunchRequest
|
|
22297
|
+
* @instance
|
|
22298
|
+
*/
|
|
22299
|
+
ExecutionRelaunchRequest.prototype.overwriteCache = false;
|
|
22300
|
+
|
|
22288
22301
|
/**
|
|
22289
22302
|
* Creates a new ExecutionRelaunchRequest instance using the specified properties.
|
|
22290
22303
|
* @function create
|
|
@@ -22313,6 +22326,8 @@
|
|
|
22313
22326
|
$root.flyteidl.core.WorkflowExecutionIdentifier.encode(message.id, writer.uint32(/* id 1, wireType 2 =*/10).fork()).ldelim();
|
|
22314
22327
|
if (message.name != null && message.hasOwnProperty("name"))
|
|
22315
22328
|
writer.uint32(/* id 3, wireType 2 =*/26).string(message.name);
|
|
22329
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
22330
|
+
writer.uint32(/* id 4, wireType 0 =*/32).bool(message.overwriteCache);
|
|
22316
22331
|
return writer;
|
|
22317
22332
|
};
|
|
22318
22333
|
|
|
@@ -22340,6 +22355,9 @@
|
|
|
22340
22355
|
case 3:
|
|
22341
22356
|
message.name = reader.string();
|
|
22342
22357
|
break;
|
|
22358
|
+
case 4:
|
|
22359
|
+
message.overwriteCache = reader.bool();
|
|
22360
|
+
break;
|
|
22343
22361
|
default:
|
|
22344
22362
|
reader.skipType(tag & 7);
|
|
22345
22363
|
break;
|
|
@@ -22367,6 +22385,9 @@
|
|
|
22367
22385
|
if (message.name != null && message.hasOwnProperty("name"))
|
|
22368
22386
|
if (!$util.isString(message.name))
|
|
22369
22387
|
return "name: string expected";
|
|
22388
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
22389
|
+
if (typeof message.overwriteCache !== "boolean")
|
|
22390
|
+
return "overwriteCache: boolean expected";
|
|
22370
22391
|
return null;
|
|
22371
22392
|
};
|
|
22372
22393
|
|
|
@@ -24224,6 +24245,7 @@
|
|
|
24224
24245
|
* @property {flyteidl.admin.IRawOutputDataConfig|null} [rawOutputDataConfig] ExecutionSpec rawOutputDataConfig
|
|
24225
24246
|
* @property {flyteidl.admin.IClusterAssignment|null} [clusterAssignment] ExecutionSpec clusterAssignment
|
|
24226
24247
|
* @property {google.protobuf.IBoolValue|null} [interruptible] ExecutionSpec interruptible
|
|
24248
|
+
* @property {boolean|null} [overwriteCache] ExecutionSpec overwriteCache
|
|
24227
24249
|
*/
|
|
24228
24250
|
|
|
24229
24251
|
/**
|
|
@@ -24353,6 +24375,14 @@
|
|
|
24353
24375
|
*/
|
|
24354
24376
|
ExecutionSpec.prototype.interruptible = null;
|
|
24355
24377
|
|
|
24378
|
+
/**
|
|
24379
|
+
* ExecutionSpec overwriteCache.
|
|
24380
|
+
* @member {boolean} overwriteCache
|
|
24381
|
+
* @memberof flyteidl.admin.ExecutionSpec
|
|
24382
|
+
* @instance
|
|
24383
|
+
*/
|
|
24384
|
+
ExecutionSpec.prototype.overwriteCache = false;
|
|
24385
|
+
|
|
24356
24386
|
// OneOf field names bound to virtual getters and setters
|
|
24357
24387
|
var $oneOfFields;
|
|
24358
24388
|
|
|
@@ -24419,6 +24449,8 @@
|
|
|
24419
24449
|
$root.flyteidl.admin.ClusterAssignment.encode(message.clusterAssignment, writer.uint32(/* id 20, wireType 2 =*/162).fork()).ldelim();
|
|
24420
24450
|
if (message.interruptible != null && message.hasOwnProperty("interruptible"))
|
|
24421
24451
|
$root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 21, wireType 2 =*/170).fork()).ldelim();
|
|
24452
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
24453
|
+
writer.uint32(/* id 22, wireType 0 =*/176).bool(message.overwriteCache);
|
|
24422
24454
|
return writer;
|
|
24423
24455
|
};
|
|
24424
24456
|
|
|
@@ -24482,6 +24514,9 @@
|
|
|
24482
24514
|
case 21:
|
|
24483
24515
|
message.interruptible = $root.google.protobuf.BoolValue.decode(reader, reader.uint32());
|
|
24484
24516
|
break;
|
|
24517
|
+
case 22:
|
|
24518
|
+
message.overwriteCache = reader.bool();
|
|
24519
|
+
break;
|
|
24485
24520
|
default:
|
|
24486
24521
|
reader.skipType(tag & 7);
|
|
24487
24522
|
break;
|
|
@@ -24575,6 +24610,9 @@
|
|
|
24575
24610
|
if (error)
|
|
24576
24611
|
return "interruptible." + error;
|
|
24577
24612
|
}
|
|
24613
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
24614
|
+
if (typeof message.overwriteCache !== "boolean")
|
|
24615
|
+
return "overwriteCache: boolean expected";
|
|
24578
24616
|
return null;
|
|
24579
24617
|
};
|
|
24580
24618
|
|
|
@@ -26148,6 +26186,7 @@
|
|
|
26148
26186
|
* @property {flyteidl.admin.IRawOutputDataConfig|null} [rawOutputDataConfig] LaunchPlanSpec rawOutputDataConfig
|
|
26149
26187
|
* @property {number|null} [maxParallelism] LaunchPlanSpec maxParallelism
|
|
26150
26188
|
* @property {google.protobuf.IBoolValue|null} [interruptible] LaunchPlanSpec interruptible
|
|
26189
|
+
* @property {boolean|null} [overwriteCache] LaunchPlanSpec overwriteCache
|
|
26151
26190
|
*/
|
|
26152
26191
|
|
|
26153
26192
|
/**
|
|
@@ -26277,6 +26316,14 @@
|
|
|
26277
26316
|
*/
|
|
26278
26317
|
LaunchPlanSpec.prototype.interruptible = null;
|
|
26279
26318
|
|
|
26319
|
+
/**
|
|
26320
|
+
* LaunchPlanSpec overwriteCache.
|
|
26321
|
+
* @member {boolean} overwriteCache
|
|
26322
|
+
* @memberof flyteidl.admin.LaunchPlanSpec
|
|
26323
|
+
* @instance
|
|
26324
|
+
*/
|
|
26325
|
+
LaunchPlanSpec.prototype.overwriteCache = false;
|
|
26326
|
+
|
|
26280
26327
|
/**
|
|
26281
26328
|
* Creates a new LaunchPlanSpec instance using the specified properties.
|
|
26282
26329
|
* @function create
|
|
@@ -26329,6 +26376,8 @@
|
|
|
26329
26376
|
writer.uint32(/* id 18, wireType 0 =*/144).int32(message.maxParallelism);
|
|
26330
26377
|
if (message.interruptible != null && message.hasOwnProperty("interruptible"))
|
|
26331
26378
|
$root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 19, wireType 2 =*/154).fork()).ldelim();
|
|
26379
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
26380
|
+
writer.uint32(/* id 20, wireType 0 =*/160).bool(message.overwriteCache);
|
|
26332
26381
|
return writer;
|
|
26333
26382
|
};
|
|
26334
26383
|
|
|
@@ -26392,6 +26441,9 @@
|
|
|
26392
26441
|
case 19:
|
|
26393
26442
|
message.interruptible = $root.google.protobuf.BoolValue.decode(reader, reader.uint32());
|
|
26394
26443
|
break;
|
|
26444
|
+
case 20:
|
|
26445
|
+
message.overwriteCache = reader.bool();
|
|
26446
|
+
break;
|
|
26395
26447
|
default:
|
|
26396
26448
|
reader.skipType(tag & 7);
|
|
26397
26449
|
break;
|
|
@@ -26477,6 +26529,9 @@
|
|
|
26477
26529
|
if (error)
|
|
26478
26530
|
return "interruptible." + error;
|
|
26479
26531
|
}
|
|
26532
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
26533
|
+
if (typeof message.overwriteCache !== "boolean")
|
|
26534
|
+
return "overwriteCache: boolean expected";
|
|
26480
26535
|
return null;
|
|
26481
26536
|
};
|
|
26482
26537
|
|
|
@@ -28788,6 +28843,7 @@
|
|
|
28788
28843
|
* @property {flyteidl.admin.ILabels|null} [labels] WorkflowExecutionConfig labels
|
|
28789
28844
|
* @property {flyteidl.admin.IAnnotations|null} [annotations] WorkflowExecutionConfig annotations
|
|
28790
28845
|
* @property {google.protobuf.IBoolValue|null} [interruptible] WorkflowExecutionConfig interruptible
|
|
28846
|
+
* @property {boolean|null} [overwriteCache] WorkflowExecutionConfig overwriteCache
|
|
28791
28847
|
*/
|
|
28792
28848
|
|
|
28793
28849
|
/**
|
|
@@ -28853,6 +28909,14 @@
|
|
|
28853
28909
|
*/
|
|
28854
28910
|
WorkflowExecutionConfig.prototype.interruptible = null;
|
|
28855
28911
|
|
|
28912
|
+
/**
|
|
28913
|
+
* WorkflowExecutionConfig overwriteCache.
|
|
28914
|
+
* @member {boolean} overwriteCache
|
|
28915
|
+
* @memberof flyteidl.admin.WorkflowExecutionConfig
|
|
28916
|
+
* @instance
|
|
28917
|
+
*/
|
|
28918
|
+
WorkflowExecutionConfig.prototype.overwriteCache = false;
|
|
28919
|
+
|
|
28856
28920
|
/**
|
|
28857
28921
|
* Creates a new WorkflowExecutionConfig instance using the specified properties.
|
|
28858
28922
|
* @function create
|
|
@@ -28889,6 +28953,8 @@
|
|
|
28889
28953
|
$root.flyteidl.admin.Annotations.encode(message.annotations, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
|
|
28890
28954
|
if (message.interruptible != null && message.hasOwnProperty("interruptible"))
|
|
28891
28955
|
$root.google.protobuf.BoolValue.encode(message.interruptible, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
|
|
28956
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
28957
|
+
writer.uint32(/* id 7, wireType 0 =*/56).bool(message.overwriteCache);
|
|
28892
28958
|
return writer;
|
|
28893
28959
|
};
|
|
28894
28960
|
|
|
@@ -28928,6 +28994,9 @@
|
|
|
28928
28994
|
case 6:
|
|
28929
28995
|
message.interruptible = $root.google.protobuf.BoolValue.decode(reader, reader.uint32());
|
|
28930
28996
|
break;
|
|
28997
|
+
case 7:
|
|
28998
|
+
message.overwriteCache = reader.bool();
|
|
28999
|
+
break;
|
|
28931
29000
|
default:
|
|
28932
29001
|
reader.skipType(tag & 7);
|
|
28933
29002
|
break;
|
|
@@ -28975,6 +29044,9 @@
|
|
|
28975
29044
|
if (error)
|
|
28976
29045
|
return "interruptible." + error;
|
|
28977
29046
|
}
|
|
29047
|
+
if (message.overwriteCache != null && message.hasOwnProperty("overwriteCache"))
|
|
29048
|
+
if (typeof message.overwriteCache !== "boolean")
|
|
29049
|
+
return "overwriteCache: boolean expected";
|
|
28978
29050
|
return null;
|
|
28979
29051
|
};
|
|
28980
29052
|
|
|
@@ -31265,6 +31337,7 @@
|
|
|
31265
31337
|
case 3:
|
|
31266
31338
|
case 4:
|
|
31267
31339
|
case 5:
|
|
31340
|
+
case 6:
|
|
31268
31341
|
break;
|
|
31269
31342
|
}
|
|
31270
31343
|
if (message.catalogKey != null && message.hasOwnProperty("catalogKey")) {
|
package/package.json
CHANGED
|
@@ -1084,6 +1084,7 @@ Request to relaunch the referenced execution.
|
|
|
1084
1084
|
|
|
1085
1085
|
"id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", "Identifier of the workflow execution to relaunch. +required"
|
|
1086
1086
|
"name", ":ref:`ref_string`", "", "User provided value for the relaunched execution. If none is provided the system will generate a unique string. +optional"
|
|
1087
|
+
"overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
|
|
1087
1088
|
|
|
1088
1089
|
|
|
1089
1090
|
|
|
@@ -1119,6 +1120,7 @@ of an execution as it progresses across phase changes.
|
|
|
1119
1120
|
"raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "User setting to configure where to store offloaded data (i.e. Blobs, structured datasets, query data, etc.). This should be a prefix like s3://my-bucket/my-data"
|
|
1120
1121
|
"cluster_assignment", ":ref:`ref_flyteidl.admin.ClusterAssignment`", "", "Controls how to select an available cluster on which this execution should run."
|
|
1121
1122
|
"interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
|
|
1123
|
+
"overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
|
|
1122
1124
|
|
|
1123
1125
|
|
|
1124
1126
|
|
|
@@ -1655,6 +1657,7 @@ User-provided launch plan definition and configuration values.
|
|
|
1655
1657
|
"raw_output_data_config", ":ref:`ref_flyteidl.admin.RawOutputDataConfig`", "", "Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.)."
|
|
1656
1658
|
"max_parallelism", ":ref:`ref_int32`", "", "Controls the maximum number of tasknodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this."
|
|
1657
1659
|
"interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
|
|
1660
|
+
"overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
|
|
1658
1661
|
|
|
1659
1662
|
|
|
1660
1663
|
|
|
@@ -2042,6 +2045,7 @@ Adds defaults for customizable workflow-execution specifications and overrides.
|
|
|
2042
2045
|
"labels", ":ref:`ref_flyteidl.admin.Labels`", "", "Custom labels to be applied to a triggered execution resource."
|
|
2043
2046
|
"annotations", ":ref:`ref_flyteidl.admin.Annotations`", "", "Custom annotations to be applied to a triggered execution resource."
|
|
2044
2047
|
"interruptible", ":ref:`ref_google.protobuf.BoolValue`", "", "Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field."
|
|
2048
|
+
"overwrite_cache", ":ref:`ref_bool`", "", "Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully."
|
|
2045
2049
|
|
|
2046
2050
|
|
|
2047
2051
|
|
|
@@ -94,6 +94,7 @@ Indicates the status of CatalogCaching. The reason why this is not embedded in T
|
|
|
94
94
|
"CACHE_POPULATED", "3", "used to indicate that the resultant artifact was added to the cache"
|
|
95
95
|
"CACHE_LOOKUP_FAILURE", "4", "Used to indicate that cache lookup failed because of an error"
|
|
96
96
|
"CACHE_PUT_FAILURE", "5", "Used to indicate that cache lookup failed because of an error"
|
|
97
|
+
"CACHE_SKIPPED", "6", "Used to indicate the cache lookup was skipped"
|
|
97
98
|
|
|
98
99
|
|
|
99
100
|
|
|
@@ -790,6 +790,51 @@ Tag properties we can filter by
|
|
|
790
790
|
|
|
791
791
|
|
|
792
792
|
|
|
793
|
+
|
|
794
|
+
.. _ref_datacatalog.UpdateArtifactRequest:
|
|
795
|
+
|
|
796
|
+
UpdateArtifactRequest
|
|
797
|
+
------------------------------------------------------------------
|
|
798
|
+
|
|
799
|
+
Request message for updating an Artifact and overwriting its associated ArtifactData.
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
.. csv-table:: UpdateArtifactRequest type fields
|
|
804
|
+
:header: "Field", "Type", "Label", "Description"
|
|
805
|
+
:widths: auto
|
|
806
|
+
|
|
807
|
+
"dataset", ":ref:`ref_datacatalog.DatasetID`", "", "ID of dataset the artifact is associated with"
|
|
808
|
+
"artifact_id", ":ref:`ref_string`", "", ""
|
|
809
|
+
"tag_name", ":ref:`ref_string`", "", ""
|
|
810
|
+
"data", ":ref:`ref_datacatalog.ArtifactData`", "repeated", "List of data to overwrite stored artifact data with. Must contain ALL data for updated Artifact as any missing ArtifactData entries will be removed from the underlying blob storage and database."
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
.. _ref_datacatalog.UpdateArtifactResponse:
|
|
819
|
+
|
|
820
|
+
UpdateArtifactResponse
|
|
821
|
+
------------------------------------------------------------------
|
|
822
|
+
|
|
823
|
+
Response message for updating an Artifact.
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
.. csv-table:: UpdateArtifactResponse type fields
|
|
828
|
+
:header: "Field", "Type", "Label", "Description"
|
|
829
|
+
:widths: auto
|
|
830
|
+
|
|
831
|
+
"artifact_id", ":ref:`ref_string`", "", "The unique ID of the artifact updated"
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
793
838
|
..
|
|
794
839
|
end messages
|
|
795
840
|
|
|
@@ -869,6 +914,7 @@ Artifacts are associated with a Dataset, and can be tagged for retrieval.
|
|
|
869
914
|
"AddTag", ":ref:`ref_datacatalog.AddTagRequest`", ":ref:`ref_datacatalog.AddTagResponse`", "Associate a tag with an artifact. Tags are unique within a Dataset."
|
|
870
915
|
"ListArtifacts", ":ref:`ref_datacatalog.ListArtifactsRequest`", ":ref:`ref_datacatalog.ListArtifactsResponse`", "Return a paginated list of artifacts"
|
|
871
916
|
"ListDatasets", ":ref:`ref_datacatalog.ListDatasetsRequest`", ":ref:`ref_datacatalog.ListDatasetsResponse`", "Return a paginated list of datasets"
|
|
917
|
+
"UpdateArtifact", ":ref:`ref_datacatalog.UpdateArtifactRequest`", ":ref:`ref_datacatalog.UpdateArtifactResponse`", "Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage."
|
|
872
918
|
"GetOrExtendReservation", ":ref:`ref_datacatalog.GetOrExtendReservationRequest`", ":ref:`ref_datacatalog.GetOrExtendReservationResponse`", "Attempts to get or extend a reservation for the corresponding artifact. If one already exists (ie. another entity owns the reservation) then that reservation is retrieved. Once you acquire a reservation, you need to periodically extend the reservation with an identical call. If the reservation is not extended before the defined expiration, it may be acquired by another task. Note: We may have multiple concurrent tasks with the same signature and the same input that try to populate the same artifact at the same time. Thus with reservation, only one task can run at a time, until the reservation expires. Note: If task A does not extend the reservation in time and the reservation expires, another task B may take over the reservation, resulting in two tasks A and B running in parallel. So a third task C may get the Artifact from A or B, whichever writes last."
|
|
873
919
|
"ReleaseReservation", ":ref:`ref_datacatalog.ReleaseReservationRequest`", ":ref:`ref_datacatalog.ReleaseReservationResponse`", "Release the reservation when the task holding the spot fails so that the other tasks can grab the spot."
|
|
874
920
|
|
|
@@ -45,10 +45,18 @@ message ExecutionRelaunchRequest {
|
|
|
45
45
|
// +required
|
|
46
46
|
core.WorkflowExecutionIdentifier id = 1;
|
|
47
47
|
|
|
48
|
+
// Deprecated field, do not use.
|
|
49
|
+
reserved 2;
|
|
50
|
+
|
|
48
51
|
// User provided value for the relaunched execution.
|
|
49
52
|
// If none is provided the system will generate a unique string.
|
|
50
53
|
// +optional
|
|
51
54
|
string name = 3;
|
|
55
|
+
|
|
56
|
+
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
57
|
+
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
58
|
+
// data once execution finishes successfully.
|
|
59
|
+
bool overwrite_cache = 4;
|
|
52
60
|
}
|
|
53
61
|
|
|
54
62
|
// Request to recover the referenced execution.
|
|
@@ -296,6 +304,11 @@ message ExecutionSpec {
|
|
|
296
304
|
// As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
|
|
297
305
|
// around the bool field.
|
|
298
306
|
google.protobuf.BoolValue interruptible = 21;
|
|
307
|
+
|
|
308
|
+
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
309
|
+
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
310
|
+
// data once execution finishes successfully.
|
|
311
|
+
bool overwrite_cache = 22;
|
|
299
312
|
}
|
|
300
313
|
|
|
301
314
|
// Request to terminate an in-progress execution. This action is irreversible.
|
|
@@ -125,6 +125,11 @@ message LaunchPlanSpec {
|
|
|
125
125
|
// As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
|
|
126
126
|
// around the bool field.
|
|
127
127
|
google.protobuf.BoolValue interruptible = 19;
|
|
128
|
+
|
|
129
|
+
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
130
|
+
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
131
|
+
// data once execution finishes successfully.
|
|
132
|
+
bool overwrite_cache = 20;
|
|
128
133
|
}
|
|
129
134
|
|
|
130
135
|
// Values computed by the flyte platform after launch plan registration.
|
|
@@ -123,6 +123,11 @@ message WorkflowExecutionConfig {
|
|
|
123
123
|
// As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper
|
|
124
124
|
// around the bool field.
|
|
125
125
|
google.protobuf.BoolValue interruptible = 6;
|
|
126
|
+
|
|
127
|
+
// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution.
|
|
128
|
+
// If enabled, all calculations are performed even if cached results would be available, overwriting the stored
|
|
129
|
+
// data once execution finishes successfully.
|
|
130
|
+
bool overwrite_cache = 7;
|
|
126
131
|
}
|
|
127
132
|
|
|
128
133
|
// Generic container for encapsulating all types of the above attributes messages.
|
|
@@ -20,6 +20,8 @@ enum CatalogCacheStatus {
|
|
|
20
20
|
CACHE_LOOKUP_FAILURE = 4;
|
|
21
21
|
// Used to indicate that cache lookup failed because of an error
|
|
22
22
|
CACHE_PUT_FAILURE = 5;
|
|
23
|
+
// Used to indicate the cache lookup was skipped
|
|
24
|
+
CACHE_SKIPPED = 6;
|
|
23
25
|
};
|
|
24
26
|
|
|
25
27
|
message CatalogArtifactTag {
|
|
@@ -37,6 +37,9 @@ service DataCatalog {
|
|
|
37
37
|
// Return a paginated list of datasets
|
|
38
38
|
rpc ListDatasets (ListDatasetsRequest) returns (ListDatasetsResponse);
|
|
39
39
|
|
|
40
|
+
// Updates an existing artifact, overwriting the stored artifact data in the underlying blob storage.
|
|
41
|
+
rpc UpdateArtifact (UpdateArtifactRequest) returns (UpdateArtifactResponse);
|
|
42
|
+
|
|
40
43
|
// Attempts to get or extend a reservation for the corresponding artifact. If one already exists
|
|
41
44
|
// (ie. another entity owns the reservation) then that reservation is retrieved.
|
|
42
45
|
// Once you acquire a reservation, you need to periodically extend the reservation with an
|
|
@@ -170,6 +173,32 @@ message ListDatasetsResponse {
|
|
|
170
173
|
string next_token = 2;
|
|
171
174
|
}
|
|
172
175
|
|
|
176
|
+
/*
|
|
177
|
+
* Request message for updating an Artifact and overwriting its associated ArtifactData.
|
|
178
|
+
*/
|
|
179
|
+
message UpdateArtifactRequest {
|
|
180
|
+
// ID of dataset the artifact is associated with
|
|
181
|
+
DatasetID dataset = 1;
|
|
182
|
+
|
|
183
|
+
// Either ID of artifact or name of tag to retrieve existing artifact from
|
|
184
|
+
oneof query_handle {
|
|
185
|
+
string artifact_id = 2;
|
|
186
|
+
string tag_name = 3;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
// List of data to overwrite stored artifact data with. Must contain ALL data for updated Artifact as any missing
|
|
190
|
+
// ArtifactData entries will be removed from the underlying blob storage and database.
|
|
191
|
+
repeated ArtifactData data = 4;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/*
|
|
195
|
+
* Response message for updating an Artifact.
|
|
196
|
+
*/
|
|
197
|
+
message UpdateArtifactResponse {
|
|
198
|
+
// The unique ID of the artifact updated
|
|
199
|
+
string artifact_id = 1;
|
|
200
|
+
}
|
|
201
|
+
|
|
173
202
|
/*
|
|
174
203
|
* ReservationID message that is composed of several string fields.
|
|
175
204
|
*/
|