@flyteorg/flyteidl 1.1.2 → 1.1.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 +149 -0
- package/gen/pb-js/flyteidl.js +325 -0
- package/package.json +1 -1
- package/protos/docs/admin/admin.rst +1 -0
- package/protos/docs/event/event.rst +1 -0
- package/protos/docs/service/service.rst +45 -0
- package/protos/flyteidl/admin/node_execution.proto +4 -0
- package/protos/flyteidl/event/event.proto +4 -0
- package/protos/flyteidl/service/dataproxy.proto +28 -0
package/gen/pb-js/flyteidl.d.ts
CHANGED
|
@@ -6254,6 +6254,9 @@ export namespace flyteidl {
|
|
|
6254
6254
|
|
|
6255
6255
|
/** NodeExecutionEvent isDynamic */
|
|
6256
6256
|
isDynamic?: (boolean|null);
|
|
6257
|
+
|
|
6258
|
+
/** NodeExecutionEvent deckUri */
|
|
6259
|
+
deckUri?: (string|null);
|
|
6257
6260
|
}
|
|
6258
6261
|
|
|
6259
6262
|
/** Represents a NodeExecutionEvent. */
|
|
@@ -6319,6 +6322,9 @@ export namespace flyteidl {
|
|
|
6319
6322
|
/** NodeExecutionEvent isDynamic. */
|
|
6320
6323
|
public isDynamic: boolean;
|
|
6321
6324
|
|
|
6325
|
+
/** NodeExecutionEvent deckUri. */
|
|
6326
|
+
public deckUri: string;
|
|
6327
|
+
|
|
6322
6328
|
/** NodeExecutionEvent outputResult. */
|
|
6323
6329
|
public outputResult?: ("outputUri"|"error"|"outputData");
|
|
6324
6330
|
|
|
@@ -12702,6 +12708,9 @@ export namespace flyteidl {
|
|
|
12702
12708
|
|
|
12703
12709
|
/** NodeExecutionClosure taskNodeMetadata */
|
|
12704
12710
|
taskNodeMetadata?: (flyteidl.admin.ITaskNodeMetadata|null);
|
|
12711
|
+
|
|
12712
|
+
/** NodeExecutionClosure deckUri */
|
|
12713
|
+
deckUri?: (string|null);
|
|
12705
12714
|
}
|
|
12706
12715
|
|
|
12707
12716
|
/** Represents a NodeExecutionClosure. */
|
|
@@ -12743,6 +12752,9 @@ export namespace flyteidl {
|
|
|
12743
12752
|
/** NodeExecutionClosure taskNodeMetadata. */
|
|
12744
12753
|
public taskNodeMetadata?: (flyteidl.admin.ITaskNodeMetadata|null);
|
|
12745
12754
|
|
|
12755
|
+
/** NodeExecutionClosure deckUri. */
|
|
12756
|
+
public deckUri: string;
|
|
12757
|
+
|
|
12746
12758
|
/** NodeExecutionClosure outputResult. */
|
|
12747
12759
|
public outputResult?: ("outputUri"|"error"|"outputData");
|
|
12748
12760
|
|
|
@@ -17192,6 +17204,122 @@ export namespace flyteidl {
|
|
|
17192
17204
|
public static verify(message: { [k: string]: any }): (string|null);
|
|
17193
17205
|
}
|
|
17194
17206
|
|
|
17207
|
+
/** Properties of a CreateDownloadLocationRequest. */
|
|
17208
|
+
interface ICreateDownloadLocationRequest {
|
|
17209
|
+
|
|
17210
|
+
/** CreateDownloadLocationRequest nativeUrl */
|
|
17211
|
+
nativeUrl?: (string|null);
|
|
17212
|
+
|
|
17213
|
+
/** CreateDownloadLocationRequest expiresIn */
|
|
17214
|
+
expiresIn?: (google.protobuf.IDuration|null);
|
|
17215
|
+
}
|
|
17216
|
+
|
|
17217
|
+
/** Represents a CreateDownloadLocationRequest. */
|
|
17218
|
+
class CreateDownloadLocationRequest implements ICreateDownloadLocationRequest {
|
|
17219
|
+
|
|
17220
|
+
/**
|
|
17221
|
+
* Constructs a new CreateDownloadLocationRequest.
|
|
17222
|
+
* @param [properties] Properties to set
|
|
17223
|
+
*/
|
|
17224
|
+
constructor(properties?: flyteidl.service.ICreateDownloadLocationRequest);
|
|
17225
|
+
|
|
17226
|
+
/** CreateDownloadLocationRequest nativeUrl. */
|
|
17227
|
+
public nativeUrl: string;
|
|
17228
|
+
|
|
17229
|
+
/** CreateDownloadLocationRequest expiresIn. */
|
|
17230
|
+
public expiresIn?: (google.protobuf.IDuration|null);
|
|
17231
|
+
|
|
17232
|
+
/**
|
|
17233
|
+
* Creates a new CreateDownloadLocationRequest instance using the specified properties.
|
|
17234
|
+
* @param [properties] Properties to set
|
|
17235
|
+
* @returns CreateDownloadLocationRequest instance
|
|
17236
|
+
*/
|
|
17237
|
+
public static create(properties?: flyteidl.service.ICreateDownloadLocationRequest): flyteidl.service.CreateDownloadLocationRequest;
|
|
17238
|
+
|
|
17239
|
+
/**
|
|
17240
|
+
* Encodes the specified CreateDownloadLocationRequest message. Does not implicitly {@link flyteidl.service.CreateDownloadLocationRequest.verify|verify} messages.
|
|
17241
|
+
* @param message CreateDownloadLocationRequest message or plain object to encode
|
|
17242
|
+
* @param [writer] Writer to encode to
|
|
17243
|
+
* @returns Writer
|
|
17244
|
+
*/
|
|
17245
|
+
public static encode(message: flyteidl.service.ICreateDownloadLocationRequest, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
17246
|
+
|
|
17247
|
+
/**
|
|
17248
|
+
* Decodes a CreateDownloadLocationRequest message from the specified reader or buffer.
|
|
17249
|
+
* @param reader Reader or buffer to decode from
|
|
17250
|
+
* @param [length] Message length if known beforehand
|
|
17251
|
+
* @returns CreateDownloadLocationRequest
|
|
17252
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
17253
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
17254
|
+
*/
|
|
17255
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.service.CreateDownloadLocationRequest;
|
|
17256
|
+
|
|
17257
|
+
/**
|
|
17258
|
+
* Verifies a CreateDownloadLocationRequest message.
|
|
17259
|
+
* @param message Plain object to verify
|
|
17260
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
17261
|
+
*/
|
|
17262
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
17263
|
+
}
|
|
17264
|
+
|
|
17265
|
+
/** Properties of a CreateDownloadLocationResponse. */
|
|
17266
|
+
interface ICreateDownloadLocationResponse {
|
|
17267
|
+
|
|
17268
|
+
/** CreateDownloadLocationResponse signedUrl */
|
|
17269
|
+
signedUrl?: (string|null);
|
|
17270
|
+
|
|
17271
|
+
/** CreateDownloadLocationResponse expiresAt */
|
|
17272
|
+
expiresAt?: (google.protobuf.ITimestamp|null);
|
|
17273
|
+
}
|
|
17274
|
+
|
|
17275
|
+
/** Represents a CreateDownloadLocationResponse. */
|
|
17276
|
+
class CreateDownloadLocationResponse implements ICreateDownloadLocationResponse {
|
|
17277
|
+
|
|
17278
|
+
/**
|
|
17279
|
+
* Constructs a new CreateDownloadLocationResponse.
|
|
17280
|
+
* @param [properties] Properties to set
|
|
17281
|
+
*/
|
|
17282
|
+
constructor(properties?: flyteidl.service.ICreateDownloadLocationResponse);
|
|
17283
|
+
|
|
17284
|
+
/** CreateDownloadLocationResponse signedUrl. */
|
|
17285
|
+
public signedUrl: string;
|
|
17286
|
+
|
|
17287
|
+
/** CreateDownloadLocationResponse expiresAt. */
|
|
17288
|
+
public expiresAt?: (google.protobuf.ITimestamp|null);
|
|
17289
|
+
|
|
17290
|
+
/**
|
|
17291
|
+
* Creates a new CreateDownloadLocationResponse instance using the specified properties.
|
|
17292
|
+
* @param [properties] Properties to set
|
|
17293
|
+
* @returns CreateDownloadLocationResponse instance
|
|
17294
|
+
*/
|
|
17295
|
+
public static create(properties?: flyteidl.service.ICreateDownloadLocationResponse): flyteidl.service.CreateDownloadLocationResponse;
|
|
17296
|
+
|
|
17297
|
+
/**
|
|
17298
|
+
* Encodes the specified CreateDownloadLocationResponse message. Does not implicitly {@link flyteidl.service.CreateDownloadLocationResponse.verify|verify} messages.
|
|
17299
|
+
* @param message CreateDownloadLocationResponse message or plain object to encode
|
|
17300
|
+
* @param [writer] Writer to encode to
|
|
17301
|
+
* @returns Writer
|
|
17302
|
+
*/
|
|
17303
|
+
public static encode(message: flyteidl.service.ICreateDownloadLocationResponse, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
17304
|
+
|
|
17305
|
+
/**
|
|
17306
|
+
* Decodes a CreateDownloadLocationResponse message from the specified reader or buffer.
|
|
17307
|
+
* @param reader Reader or buffer to decode from
|
|
17308
|
+
* @param [length] Message length if known beforehand
|
|
17309
|
+
* @returns CreateDownloadLocationResponse
|
|
17310
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
17311
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
17312
|
+
*/
|
|
17313
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.service.CreateDownloadLocationResponse;
|
|
17314
|
+
|
|
17315
|
+
/**
|
|
17316
|
+
* Verifies a CreateDownloadLocationResponse message.
|
|
17317
|
+
* @param message Plain object to verify
|
|
17318
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
17319
|
+
*/
|
|
17320
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
17321
|
+
}
|
|
17322
|
+
|
|
17195
17323
|
/** Represents a DataProxyService */
|
|
17196
17324
|
class DataProxyService extends $protobuf.rpc.Service {
|
|
17197
17325
|
|
|
@@ -17225,6 +17353,20 @@ export namespace flyteidl {
|
|
|
17225
17353
|
* @returns Promise
|
|
17226
17354
|
*/
|
|
17227
17355
|
public createUploadLocation(request: flyteidl.service.ICreateUploadLocationRequest): Promise<flyteidl.service.CreateUploadLocationResponse>;
|
|
17356
|
+
|
|
17357
|
+
/**
|
|
17358
|
+
* Calls CreateDownloadLocation.
|
|
17359
|
+
* @param request CreateDownloadLocationRequest message or plain object
|
|
17360
|
+
* @param callback Node-style callback called with the error, if any, and CreateDownloadLocationResponse
|
|
17361
|
+
*/
|
|
17362
|
+
public createDownloadLocation(request: flyteidl.service.ICreateDownloadLocationRequest, callback: flyteidl.service.DataProxyService.CreateDownloadLocationCallback): void;
|
|
17363
|
+
|
|
17364
|
+
/**
|
|
17365
|
+
* Calls CreateDownloadLocation.
|
|
17366
|
+
* @param request CreateDownloadLocationRequest message or plain object
|
|
17367
|
+
* @returns Promise
|
|
17368
|
+
*/
|
|
17369
|
+
public createDownloadLocation(request: flyteidl.service.ICreateDownloadLocationRequest): Promise<flyteidl.service.CreateDownloadLocationResponse>;
|
|
17228
17370
|
}
|
|
17229
17371
|
|
|
17230
17372
|
namespace DataProxyService {
|
|
@@ -17235,6 +17377,13 @@ export namespace flyteidl {
|
|
|
17235
17377
|
* @param [response] CreateUploadLocationResponse
|
|
17236
17378
|
*/
|
|
17237
17379
|
type CreateUploadLocationCallback = (error: (Error|null), response?: flyteidl.service.CreateUploadLocationResponse) => void;
|
|
17380
|
+
|
|
17381
|
+
/**
|
|
17382
|
+
* Callback as used by {@link flyteidl.service.DataProxyService#createDownloadLocation}.
|
|
17383
|
+
* @param error Error, if any
|
|
17384
|
+
* @param [response] CreateDownloadLocationResponse
|
|
17385
|
+
*/
|
|
17386
|
+
type CreateDownloadLocationCallback = (error: (Error|null), response?: flyteidl.service.CreateDownloadLocationResponse) => void;
|
|
17238
17387
|
}
|
|
17239
17388
|
|
|
17240
17389
|
/** Properties of a UserInfoRequest. */
|
package/gen/pb-js/flyteidl.js
CHANGED
|
@@ -14893,6 +14893,7 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
14893
14893
|
* @property {number|null} [eventVersion] NodeExecutionEvent eventVersion
|
|
14894
14894
|
* @property {boolean|null} [isParent] NodeExecutionEvent isParent
|
|
14895
14895
|
* @property {boolean|null} [isDynamic] NodeExecutionEvent isDynamic
|
|
14896
|
+
* @property {string|null} [deckUri] NodeExecutionEvent deckUri
|
|
14896
14897
|
*/
|
|
14897
14898
|
|
|
14898
14899
|
/**
|
|
@@ -15054,6 +15055,14 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
15054
15055
|
*/
|
|
15055
15056
|
NodeExecutionEvent.prototype.isDynamic = false;
|
|
15056
15057
|
|
|
15058
|
+
/**
|
|
15059
|
+
* NodeExecutionEvent deckUri.
|
|
15060
|
+
* @member {string} deckUri
|
|
15061
|
+
* @memberof flyteidl.event.NodeExecutionEvent
|
|
15062
|
+
* @instance
|
|
15063
|
+
*/
|
|
15064
|
+
NodeExecutionEvent.prototype.deckUri = "";
|
|
15065
|
+
|
|
15057
15066
|
// OneOf field names bound to virtual getters and setters
|
|
15058
15067
|
let $oneOfFields;
|
|
15059
15068
|
|
|
@@ -15139,6 +15148,8 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
15139
15148
|
writer.uint32(/* id 17, wireType 0 =*/136).bool(message.isParent);
|
|
15140
15149
|
if (message.isDynamic != null && message.hasOwnProperty("isDynamic"))
|
|
15141
15150
|
writer.uint32(/* id 18, wireType 0 =*/144).bool(message.isDynamic);
|
|
15151
|
+
if (message.deckUri != null && message.hasOwnProperty("deckUri"))
|
|
15152
|
+
writer.uint32(/* id 19, wireType 2 =*/154).string(message.deckUri);
|
|
15142
15153
|
return writer;
|
|
15143
15154
|
};
|
|
15144
15155
|
|
|
@@ -15214,6 +15225,9 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
15214
15225
|
case 18:
|
|
15215
15226
|
message.isDynamic = reader.bool();
|
|
15216
15227
|
break;
|
|
15228
|
+
case 19:
|
|
15229
|
+
message.deckUri = reader.string();
|
|
15230
|
+
break;
|
|
15217
15231
|
default:
|
|
15218
15232
|
reader.skipType(tag & 7);
|
|
15219
15233
|
break;
|
|
@@ -15338,6 +15352,9 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
15338
15352
|
if (message.isDynamic != null && message.hasOwnProperty("isDynamic"))
|
|
15339
15353
|
if (typeof message.isDynamic !== "boolean")
|
|
15340
15354
|
return "isDynamic: boolean expected";
|
|
15355
|
+
if (message.deckUri != null && message.hasOwnProperty("deckUri"))
|
|
15356
|
+
if (!$util.isString(message.deckUri))
|
|
15357
|
+
return "deckUri: string expected";
|
|
15341
15358
|
return null;
|
|
15342
15359
|
};
|
|
15343
15360
|
|
|
@@ -30373,6 +30390,7 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
30373
30390
|
* @property {google.protobuf.ITimestamp|null} [updatedAt] NodeExecutionClosure updatedAt
|
|
30374
30391
|
* @property {flyteidl.admin.IWorkflowNodeMetadata|null} [workflowNodeMetadata] NodeExecutionClosure workflowNodeMetadata
|
|
30375
30392
|
* @property {flyteidl.admin.ITaskNodeMetadata|null} [taskNodeMetadata] NodeExecutionClosure taskNodeMetadata
|
|
30393
|
+
* @property {string|null} [deckUri] NodeExecutionClosure deckUri
|
|
30376
30394
|
*/
|
|
30377
30395
|
|
|
30378
30396
|
/**
|
|
@@ -30470,6 +30488,14 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
30470
30488
|
*/
|
|
30471
30489
|
NodeExecutionClosure.prototype.taskNodeMetadata = null;
|
|
30472
30490
|
|
|
30491
|
+
/**
|
|
30492
|
+
* NodeExecutionClosure deckUri.
|
|
30493
|
+
* @member {string} deckUri
|
|
30494
|
+
* @memberof flyteidl.admin.NodeExecutionClosure
|
|
30495
|
+
* @instance
|
|
30496
|
+
*/
|
|
30497
|
+
NodeExecutionClosure.prototype.deckUri = "";
|
|
30498
|
+
|
|
30473
30499
|
// OneOf field names bound to virtual getters and setters
|
|
30474
30500
|
let $oneOfFields;
|
|
30475
30501
|
|
|
@@ -30539,6 +30565,8 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
30539
30565
|
$root.flyteidl.admin.TaskNodeMetadata.encode(message.taskNodeMetadata, writer.uint32(/* id 9, wireType 2 =*/74).fork()).ldelim();
|
|
30540
30566
|
if (message.outputData != null && message.hasOwnProperty("outputData"))
|
|
30541
30567
|
$root.flyteidl.core.LiteralMap.encode(message.outputData, writer.uint32(/* id 10, wireType 2 =*/82).fork()).ldelim();
|
|
30568
|
+
if (message.deckUri != null && message.hasOwnProperty("deckUri"))
|
|
30569
|
+
writer.uint32(/* id 11, wireType 2 =*/90).string(message.deckUri);
|
|
30542
30570
|
return writer;
|
|
30543
30571
|
};
|
|
30544
30572
|
|
|
@@ -30590,6 +30618,9 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
30590
30618
|
case 9:
|
|
30591
30619
|
message.taskNodeMetadata = $root.flyteidl.admin.TaskNodeMetadata.decode(reader, reader.uint32());
|
|
30592
30620
|
break;
|
|
30621
|
+
case 11:
|
|
30622
|
+
message.deckUri = reader.string();
|
|
30623
|
+
break;
|
|
30593
30624
|
default:
|
|
30594
30625
|
reader.skipType(tag & 7);
|
|
30595
30626
|
break;
|
|
@@ -30690,6 +30721,9 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
30690
30721
|
return "taskNodeMetadata." + error;
|
|
30691
30722
|
}
|
|
30692
30723
|
}
|
|
30724
|
+
if (message.deckUri != null && message.hasOwnProperty("deckUri"))
|
|
30725
|
+
if (!$util.isString(message.deckUri))
|
|
30726
|
+
return "deckUri: string expected";
|
|
30693
30727
|
return null;
|
|
30694
30728
|
};
|
|
30695
30729
|
|
|
@@ -40084,6 +40118,264 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
40084
40118
|
return CreateUploadLocationRequest;
|
|
40085
40119
|
})();
|
|
40086
40120
|
|
|
40121
|
+
service.CreateDownloadLocationRequest = (function() {
|
|
40122
|
+
|
|
40123
|
+
/**
|
|
40124
|
+
* Properties of a CreateDownloadLocationRequest.
|
|
40125
|
+
* @memberof flyteidl.service
|
|
40126
|
+
* @interface ICreateDownloadLocationRequest
|
|
40127
|
+
* @property {string|null} [nativeUrl] CreateDownloadLocationRequest nativeUrl
|
|
40128
|
+
* @property {google.protobuf.IDuration|null} [expiresIn] CreateDownloadLocationRequest expiresIn
|
|
40129
|
+
*/
|
|
40130
|
+
|
|
40131
|
+
/**
|
|
40132
|
+
* Constructs a new CreateDownloadLocationRequest.
|
|
40133
|
+
* @memberof flyteidl.service
|
|
40134
|
+
* @classdesc Represents a CreateDownloadLocationRequest.
|
|
40135
|
+
* @implements ICreateDownloadLocationRequest
|
|
40136
|
+
* @constructor
|
|
40137
|
+
* @param {flyteidl.service.ICreateDownloadLocationRequest=} [properties] Properties to set
|
|
40138
|
+
*/
|
|
40139
|
+
function CreateDownloadLocationRequest(properties) {
|
|
40140
|
+
if (properties)
|
|
40141
|
+
for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
|
40142
|
+
if (properties[keys[i]] != null)
|
|
40143
|
+
this[keys[i]] = properties[keys[i]];
|
|
40144
|
+
}
|
|
40145
|
+
|
|
40146
|
+
/**
|
|
40147
|
+
* CreateDownloadLocationRequest nativeUrl.
|
|
40148
|
+
* @member {string} nativeUrl
|
|
40149
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40150
|
+
* @instance
|
|
40151
|
+
*/
|
|
40152
|
+
CreateDownloadLocationRequest.prototype.nativeUrl = "";
|
|
40153
|
+
|
|
40154
|
+
/**
|
|
40155
|
+
* CreateDownloadLocationRequest expiresIn.
|
|
40156
|
+
* @member {google.protobuf.IDuration|null|undefined} expiresIn
|
|
40157
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40158
|
+
* @instance
|
|
40159
|
+
*/
|
|
40160
|
+
CreateDownloadLocationRequest.prototype.expiresIn = null;
|
|
40161
|
+
|
|
40162
|
+
/**
|
|
40163
|
+
* Creates a new CreateDownloadLocationRequest instance using the specified properties.
|
|
40164
|
+
* @function create
|
|
40165
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40166
|
+
* @static
|
|
40167
|
+
* @param {flyteidl.service.ICreateDownloadLocationRequest=} [properties] Properties to set
|
|
40168
|
+
* @returns {flyteidl.service.CreateDownloadLocationRequest} CreateDownloadLocationRequest instance
|
|
40169
|
+
*/
|
|
40170
|
+
CreateDownloadLocationRequest.create = function create(properties) {
|
|
40171
|
+
return new CreateDownloadLocationRequest(properties);
|
|
40172
|
+
};
|
|
40173
|
+
|
|
40174
|
+
/**
|
|
40175
|
+
* Encodes the specified CreateDownloadLocationRequest message. Does not implicitly {@link flyteidl.service.CreateDownloadLocationRequest.verify|verify} messages.
|
|
40176
|
+
* @function encode
|
|
40177
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40178
|
+
* @static
|
|
40179
|
+
* @param {flyteidl.service.ICreateDownloadLocationRequest} message CreateDownloadLocationRequest message or plain object to encode
|
|
40180
|
+
* @param {$protobuf.Writer} [writer] Writer to encode to
|
|
40181
|
+
* @returns {$protobuf.Writer} Writer
|
|
40182
|
+
*/
|
|
40183
|
+
CreateDownloadLocationRequest.encode = function encode(message, writer) {
|
|
40184
|
+
if (!writer)
|
|
40185
|
+
writer = $Writer.create();
|
|
40186
|
+
if (message.nativeUrl != null && message.hasOwnProperty("nativeUrl"))
|
|
40187
|
+
writer.uint32(/* id 1, wireType 2 =*/10).string(message.nativeUrl);
|
|
40188
|
+
if (message.expiresIn != null && message.hasOwnProperty("expiresIn"))
|
|
40189
|
+
$root.google.protobuf.Duration.encode(message.expiresIn, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
|
|
40190
|
+
return writer;
|
|
40191
|
+
};
|
|
40192
|
+
|
|
40193
|
+
/**
|
|
40194
|
+
* Decodes a CreateDownloadLocationRequest message from the specified reader or buffer.
|
|
40195
|
+
* @function decode
|
|
40196
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40197
|
+
* @static
|
|
40198
|
+
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
|
|
40199
|
+
* @param {number} [length] Message length if known beforehand
|
|
40200
|
+
* @returns {flyteidl.service.CreateDownloadLocationRequest} CreateDownloadLocationRequest
|
|
40201
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
40202
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
40203
|
+
*/
|
|
40204
|
+
CreateDownloadLocationRequest.decode = function decode(reader, length) {
|
|
40205
|
+
if (!(reader instanceof $Reader))
|
|
40206
|
+
reader = $Reader.create(reader);
|
|
40207
|
+
let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.service.CreateDownloadLocationRequest();
|
|
40208
|
+
while (reader.pos < end) {
|
|
40209
|
+
let tag = reader.uint32();
|
|
40210
|
+
switch (tag >>> 3) {
|
|
40211
|
+
case 1:
|
|
40212
|
+
message.nativeUrl = reader.string();
|
|
40213
|
+
break;
|
|
40214
|
+
case 2:
|
|
40215
|
+
message.expiresIn = $root.google.protobuf.Duration.decode(reader, reader.uint32());
|
|
40216
|
+
break;
|
|
40217
|
+
default:
|
|
40218
|
+
reader.skipType(tag & 7);
|
|
40219
|
+
break;
|
|
40220
|
+
}
|
|
40221
|
+
}
|
|
40222
|
+
return message;
|
|
40223
|
+
};
|
|
40224
|
+
|
|
40225
|
+
/**
|
|
40226
|
+
* Verifies a CreateDownloadLocationRequest message.
|
|
40227
|
+
* @function verify
|
|
40228
|
+
* @memberof flyteidl.service.CreateDownloadLocationRequest
|
|
40229
|
+
* @static
|
|
40230
|
+
* @param {Object.<string,*>} message Plain object to verify
|
|
40231
|
+
* @returns {string|null} `null` if valid, otherwise the reason why it is not
|
|
40232
|
+
*/
|
|
40233
|
+
CreateDownloadLocationRequest.verify = function verify(message) {
|
|
40234
|
+
if (typeof message !== "object" || message === null)
|
|
40235
|
+
return "object expected";
|
|
40236
|
+
if (message.nativeUrl != null && message.hasOwnProperty("nativeUrl"))
|
|
40237
|
+
if (!$util.isString(message.nativeUrl))
|
|
40238
|
+
return "nativeUrl: string expected";
|
|
40239
|
+
if (message.expiresIn != null && message.hasOwnProperty("expiresIn")) {
|
|
40240
|
+
let error = $root.google.protobuf.Duration.verify(message.expiresIn);
|
|
40241
|
+
if (error)
|
|
40242
|
+
return "expiresIn." + error;
|
|
40243
|
+
}
|
|
40244
|
+
return null;
|
|
40245
|
+
};
|
|
40246
|
+
|
|
40247
|
+
return CreateDownloadLocationRequest;
|
|
40248
|
+
})();
|
|
40249
|
+
|
|
40250
|
+
service.CreateDownloadLocationResponse = (function() {
|
|
40251
|
+
|
|
40252
|
+
/**
|
|
40253
|
+
* Properties of a CreateDownloadLocationResponse.
|
|
40254
|
+
* @memberof flyteidl.service
|
|
40255
|
+
* @interface ICreateDownloadLocationResponse
|
|
40256
|
+
* @property {string|null} [signedUrl] CreateDownloadLocationResponse signedUrl
|
|
40257
|
+
* @property {google.protobuf.ITimestamp|null} [expiresAt] CreateDownloadLocationResponse expiresAt
|
|
40258
|
+
*/
|
|
40259
|
+
|
|
40260
|
+
/**
|
|
40261
|
+
* Constructs a new CreateDownloadLocationResponse.
|
|
40262
|
+
* @memberof flyteidl.service
|
|
40263
|
+
* @classdesc Represents a CreateDownloadLocationResponse.
|
|
40264
|
+
* @implements ICreateDownloadLocationResponse
|
|
40265
|
+
* @constructor
|
|
40266
|
+
* @param {flyteidl.service.ICreateDownloadLocationResponse=} [properties] Properties to set
|
|
40267
|
+
*/
|
|
40268
|
+
function CreateDownloadLocationResponse(properties) {
|
|
40269
|
+
if (properties)
|
|
40270
|
+
for (let keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
|
40271
|
+
if (properties[keys[i]] != null)
|
|
40272
|
+
this[keys[i]] = properties[keys[i]];
|
|
40273
|
+
}
|
|
40274
|
+
|
|
40275
|
+
/**
|
|
40276
|
+
* CreateDownloadLocationResponse signedUrl.
|
|
40277
|
+
* @member {string} signedUrl
|
|
40278
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40279
|
+
* @instance
|
|
40280
|
+
*/
|
|
40281
|
+
CreateDownloadLocationResponse.prototype.signedUrl = "";
|
|
40282
|
+
|
|
40283
|
+
/**
|
|
40284
|
+
* CreateDownloadLocationResponse expiresAt.
|
|
40285
|
+
* @member {google.protobuf.ITimestamp|null|undefined} expiresAt
|
|
40286
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40287
|
+
* @instance
|
|
40288
|
+
*/
|
|
40289
|
+
CreateDownloadLocationResponse.prototype.expiresAt = null;
|
|
40290
|
+
|
|
40291
|
+
/**
|
|
40292
|
+
* Creates a new CreateDownloadLocationResponse instance using the specified properties.
|
|
40293
|
+
* @function create
|
|
40294
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40295
|
+
* @static
|
|
40296
|
+
* @param {flyteidl.service.ICreateDownloadLocationResponse=} [properties] Properties to set
|
|
40297
|
+
* @returns {flyteidl.service.CreateDownloadLocationResponse} CreateDownloadLocationResponse instance
|
|
40298
|
+
*/
|
|
40299
|
+
CreateDownloadLocationResponse.create = function create(properties) {
|
|
40300
|
+
return new CreateDownloadLocationResponse(properties);
|
|
40301
|
+
};
|
|
40302
|
+
|
|
40303
|
+
/**
|
|
40304
|
+
* Encodes the specified CreateDownloadLocationResponse message. Does not implicitly {@link flyteidl.service.CreateDownloadLocationResponse.verify|verify} messages.
|
|
40305
|
+
* @function encode
|
|
40306
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40307
|
+
* @static
|
|
40308
|
+
* @param {flyteidl.service.ICreateDownloadLocationResponse} message CreateDownloadLocationResponse message or plain object to encode
|
|
40309
|
+
* @param {$protobuf.Writer} [writer] Writer to encode to
|
|
40310
|
+
* @returns {$protobuf.Writer} Writer
|
|
40311
|
+
*/
|
|
40312
|
+
CreateDownloadLocationResponse.encode = function encode(message, writer) {
|
|
40313
|
+
if (!writer)
|
|
40314
|
+
writer = $Writer.create();
|
|
40315
|
+
if (message.signedUrl != null && message.hasOwnProperty("signedUrl"))
|
|
40316
|
+
writer.uint32(/* id 1, wireType 2 =*/10).string(message.signedUrl);
|
|
40317
|
+
if (message.expiresAt != null && message.hasOwnProperty("expiresAt"))
|
|
40318
|
+
$root.google.protobuf.Timestamp.encode(message.expiresAt, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
|
|
40319
|
+
return writer;
|
|
40320
|
+
};
|
|
40321
|
+
|
|
40322
|
+
/**
|
|
40323
|
+
* Decodes a CreateDownloadLocationResponse message from the specified reader or buffer.
|
|
40324
|
+
* @function decode
|
|
40325
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40326
|
+
* @static
|
|
40327
|
+
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
|
|
40328
|
+
* @param {number} [length] Message length if known beforehand
|
|
40329
|
+
* @returns {flyteidl.service.CreateDownloadLocationResponse} CreateDownloadLocationResponse
|
|
40330
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
40331
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
40332
|
+
*/
|
|
40333
|
+
CreateDownloadLocationResponse.decode = function decode(reader, length) {
|
|
40334
|
+
if (!(reader instanceof $Reader))
|
|
40335
|
+
reader = $Reader.create(reader);
|
|
40336
|
+
let end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.service.CreateDownloadLocationResponse();
|
|
40337
|
+
while (reader.pos < end) {
|
|
40338
|
+
let tag = reader.uint32();
|
|
40339
|
+
switch (tag >>> 3) {
|
|
40340
|
+
case 1:
|
|
40341
|
+
message.signedUrl = reader.string();
|
|
40342
|
+
break;
|
|
40343
|
+
case 2:
|
|
40344
|
+
message.expiresAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
|
|
40345
|
+
break;
|
|
40346
|
+
default:
|
|
40347
|
+
reader.skipType(tag & 7);
|
|
40348
|
+
break;
|
|
40349
|
+
}
|
|
40350
|
+
}
|
|
40351
|
+
return message;
|
|
40352
|
+
};
|
|
40353
|
+
|
|
40354
|
+
/**
|
|
40355
|
+
* Verifies a CreateDownloadLocationResponse message.
|
|
40356
|
+
* @function verify
|
|
40357
|
+
* @memberof flyteidl.service.CreateDownloadLocationResponse
|
|
40358
|
+
* @static
|
|
40359
|
+
* @param {Object.<string,*>} message Plain object to verify
|
|
40360
|
+
* @returns {string|null} `null` if valid, otherwise the reason why it is not
|
|
40361
|
+
*/
|
|
40362
|
+
CreateDownloadLocationResponse.verify = function verify(message) {
|
|
40363
|
+
if (typeof message !== "object" || message === null)
|
|
40364
|
+
return "object expected";
|
|
40365
|
+
if (message.signedUrl != null && message.hasOwnProperty("signedUrl"))
|
|
40366
|
+
if (!$util.isString(message.signedUrl))
|
|
40367
|
+
return "signedUrl: string expected";
|
|
40368
|
+
if (message.expiresAt != null && message.hasOwnProperty("expiresAt")) {
|
|
40369
|
+
let error = $root.google.protobuf.Timestamp.verify(message.expiresAt);
|
|
40370
|
+
if (error)
|
|
40371
|
+
return "expiresAt." + error;
|
|
40372
|
+
}
|
|
40373
|
+
return null;
|
|
40374
|
+
};
|
|
40375
|
+
|
|
40376
|
+
return CreateDownloadLocationResponse;
|
|
40377
|
+
})();
|
|
40378
|
+
|
|
40087
40379
|
service.DataProxyService = (function() {
|
|
40088
40380
|
|
|
40089
40381
|
/**
|
|
@@ -40149,6 +40441,39 @@ export const flyteidl = $root.flyteidl = (() => {
|
|
|
40149
40441
|
* @variation 2
|
|
40150
40442
|
*/
|
|
40151
40443
|
|
|
40444
|
+
/**
|
|
40445
|
+
* Callback as used by {@link flyteidl.service.DataProxyService#createDownloadLocation}.
|
|
40446
|
+
* @memberof flyteidl.service.DataProxyService
|
|
40447
|
+
* @typedef CreateDownloadLocationCallback
|
|
40448
|
+
* @type {function}
|
|
40449
|
+
* @param {Error|null} error Error, if any
|
|
40450
|
+
* @param {flyteidl.service.CreateDownloadLocationResponse} [response] CreateDownloadLocationResponse
|
|
40451
|
+
*/
|
|
40452
|
+
|
|
40453
|
+
/**
|
|
40454
|
+
* Calls CreateDownloadLocation.
|
|
40455
|
+
* @function createDownloadLocation
|
|
40456
|
+
* @memberof flyteidl.service.DataProxyService
|
|
40457
|
+
* @instance
|
|
40458
|
+
* @param {flyteidl.service.ICreateDownloadLocationRequest} request CreateDownloadLocationRequest message or plain object
|
|
40459
|
+
* @param {flyteidl.service.DataProxyService.CreateDownloadLocationCallback} callback Node-style callback called with the error, if any, and CreateDownloadLocationResponse
|
|
40460
|
+
* @returns {undefined}
|
|
40461
|
+
* @variation 1
|
|
40462
|
+
*/
|
|
40463
|
+
Object.defineProperty(DataProxyService.prototype.createDownloadLocation = function createDownloadLocation(request, callback) {
|
|
40464
|
+
return this.rpcCall(createDownloadLocation, $root.flyteidl.service.CreateDownloadLocationRequest, $root.flyteidl.service.CreateDownloadLocationResponse, request, callback);
|
|
40465
|
+
}, "name", { value: "CreateDownloadLocation" });
|
|
40466
|
+
|
|
40467
|
+
/**
|
|
40468
|
+
* Calls CreateDownloadLocation.
|
|
40469
|
+
* @function createDownloadLocation
|
|
40470
|
+
* @memberof flyteidl.service.DataProxyService
|
|
40471
|
+
* @instance
|
|
40472
|
+
* @param {flyteidl.service.ICreateDownloadLocationRequest} request CreateDownloadLocationRequest message or plain object
|
|
40473
|
+
* @returns {Promise<flyteidl.service.CreateDownloadLocationResponse>} Promise
|
|
40474
|
+
* @variation 2
|
|
40475
|
+
*/
|
|
40476
|
+
|
|
40152
40477
|
return DataProxyService;
|
|
40153
40478
|
})();
|
|
40154
40479
|
|
package/package.json
CHANGED
|
@@ -2271,6 +2271,7 @@ Container for node execution details and results.
|
|
|
2271
2271
|
"updated_at", ":ref:`ref_google.protobuf.Timestamp`", "", "Time at which the node execution was last updated."
|
|
2272
2272
|
"workflow_node_metadata", ":ref:`ref_flyteidl.admin.WorkflowNodeMetadata`", "", ""
|
|
2273
2273
|
"task_node_metadata", ":ref:`ref_flyteidl.admin.TaskNodeMetadata`", "", ""
|
|
2274
|
+
"deck_uri", ":ref:`ref_string`", "", "String location uniquely identifying where the deck HTML file is. NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
|
|
2274
2275
|
|
|
2275
2276
|
|
|
2276
2277
|
|
|
@@ -93,6 +93,7 @@ NodeExecutionEvent
|
|
|
93
93
|
"event_version", ":ref:`ref_int32`", "", ""
|
|
94
94
|
"is_parent", ":ref:`ref_bool`", "", "Whether this node launched a subworkflow."
|
|
95
95
|
"is_dynamic", ":ref:`ref_bool`", "", "Whether this node yielded a dynamic workflow."
|
|
96
|
+
"deck_uri", ":ref:`ref_string`", "", "String location uniquely identifying where the deck HTML file is NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
|
|
96
97
|
|
|
97
98
|
|
|
98
99
|
|
|
@@ -227,6 +227,50 @@ flyteidl/service/dataproxy.proto
|
|
|
227
227
|
|
|
228
228
|
|
|
229
229
|
|
|
230
|
+
.. _ref_flyteidl.service.CreateDownloadLocationRequest:
|
|
231
|
+
|
|
232
|
+
CreateDownloadLocationRequest
|
|
233
|
+
------------------------------------------------------------------
|
|
234
|
+
|
|
235
|
+
CreateDownloadLocationRequest specified request for the CreateDownloadLocation API.
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
.. csv-table:: CreateDownloadLocationRequest type fields
|
|
240
|
+
:header: "Field", "Type", "Label", "Description"
|
|
241
|
+
:widths: auto
|
|
242
|
+
|
|
243
|
+
"native_url", ":ref:`ref_string`", "", "NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
|
|
244
|
+
"expires_in", ":ref:`ref_google.protobuf.Duration`", "", "ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this exceeds the platform allowed max. +optional. The default value comes from a global config."
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
.. _ref_flyteidl.service.CreateDownloadLocationResponse:
|
|
253
|
+
|
|
254
|
+
CreateDownloadLocationResponse
|
|
255
|
+
------------------------------------------------------------------
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
.. csv-table:: CreateDownloadLocationResponse type fields
|
|
262
|
+
:header: "Field", "Type", "Label", "Description"
|
|
263
|
+
:widths: auto
|
|
264
|
+
|
|
265
|
+
"signed_url", ":ref:`ref_string`", "", "SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)"
|
|
266
|
+
"expires_at", ":ref:`ref_google.protobuf.Timestamp`", "", "ExpiresAt defines when will the signed URL expires."
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
230
274
|
.. _ref_flyteidl.service.CreateUploadLocationRequest:
|
|
231
275
|
|
|
232
276
|
CreateUploadLocationRequest
|
|
@@ -299,6 +343,7 @@ DataProxyService defines an RPC Service that allows access to user-data in a con
|
|
|
299
343
|
:widths: auto
|
|
300
344
|
|
|
301
345
|
"CreateUploadLocation", ":ref:`ref_flyteidl.service.CreateUploadLocationRequest`", ":ref:`ref_flyteidl.service.CreateUploadLocationResponse`", "CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain."
|
|
346
|
+
"CreateDownloadLocation", ":ref:`ref_flyteidl.service.CreateDownloadLocationRequest`", ":ref:`ref_flyteidl.service.CreateDownloadLocationResponse`", "CreateDownloadLocation creates a signed url to download artifacts."
|
|
302
347
|
|
|
303
348
|
..
|
|
304
349
|
end services
|
|
@@ -163,6 +163,10 @@ message NodeExecutionClosure {
|
|
|
163
163
|
WorkflowNodeMetadata workflow_node_metadata = 8;
|
|
164
164
|
TaskNodeMetadata task_node_metadata = 9;
|
|
165
165
|
}
|
|
166
|
+
|
|
167
|
+
// String location uniquely identifying where the deck HTML file is.
|
|
168
|
+
// NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
|
|
169
|
+
string deck_uri = 11;
|
|
166
170
|
}
|
|
167
171
|
|
|
168
172
|
// Metadata for a WorkflowNode
|
|
@@ -95,6 +95,10 @@ message NodeExecutionEvent {
|
|
|
95
95
|
|
|
96
96
|
// Whether this node yielded a dynamic workflow.
|
|
97
97
|
bool is_dynamic = 18;
|
|
98
|
+
|
|
99
|
+
// String location uniquely identifying where the deck HTML file is
|
|
100
|
+
// NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
|
|
101
|
+
string deck_uri = 19;
|
|
98
102
|
}
|
|
99
103
|
|
|
100
104
|
// For Workflow Nodes we need to send information about the workflow that's launched
|
|
@@ -44,6 +44,25 @@ message CreateUploadLocationRequest {
|
|
|
44
44
|
bytes content_md5 = 5;
|
|
45
45
|
}
|
|
46
46
|
|
|
47
|
+
// CreateDownloadLocationRequest specified request for the CreateDownloadLocation API.
|
|
48
|
+
message CreateDownloadLocationRequest {
|
|
49
|
+
// NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
|
|
50
|
+
string native_url = 1;
|
|
51
|
+
|
|
52
|
+
// ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this
|
|
53
|
+
// exceeds the platform allowed max.
|
|
54
|
+
// +optional. The default value comes from a global config.
|
|
55
|
+
google.protobuf.Duration expires_in = 2;
|
|
56
|
+
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
message CreateDownloadLocationResponse {
|
|
60
|
+
// SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
|
|
61
|
+
string signed_url = 1;
|
|
62
|
+
// ExpiresAt defines when will the signed URL expires.
|
|
63
|
+
google.protobuf.Timestamp expires_at = 2;
|
|
64
|
+
}
|
|
65
|
+
|
|
47
66
|
// DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.
|
|
48
67
|
service DataProxyService {
|
|
49
68
|
// CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain.
|
|
@@ -56,4 +75,13 @@ service DataProxyService {
|
|
|
56
75
|
description: "Creates a write-only http location that is accessible for tasks at runtime."
|
|
57
76
|
};
|
|
58
77
|
}
|
|
78
|
+
// CreateDownloadLocation creates a signed url to download artifacts.
|
|
79
|
+
rpc CreateDownloadLocation (CreateDownloadLocationRequest) returns (CreateDownloadLocationResponse) {
|
|
80
|
+
option (google.api.http) = {
|
|
81
|
+
get: "/api/v1/dataproxy/artifact_urn"
|
|
82
|
+
};
|
|
83
|
+
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
84
|
+
description: "Creates a read-only http location that is accessible for tasks at runtime."
|
|
85
|
+
};
|
|
86
|
+
}
|
|
59
87
|
}
|