@flyteorg/flyteidl 1.2.4 → 1.2.6
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 +158 -0
- package/gen/pb-js/flyteidl.js +372 -0
- package/package.json +1 -1
- package/protos/docs/core/core.rst +1 -0
- package/protos/docs/service/service.rst +62 -0
- package/protos/flyteidl/core/tasks.proto +4 -1
- package/protos/flyteidl/plugins/ray.proto +0 -2
- package/protos/flyteidl/service/dataproxy.proto +52 -0
package/gen/pb-js/flyteidl.d.ts
CHANGED
|
@@ -5092,6 +5092,9 @@ export namespace flyteidl {
|
|
|
5092
5092
|
|
|
5093
5093
|
/** TaskMetadata cacheSerializable */
|
|
5094
5094
|
cacheSerializable?: (boolean|null);
|
|
5095
|
+
|
|
5096
|
+
/** TaskMetadata generatesDeck */
|
|
5097
|
+
generatesDeck?: (boolean|null);
|
|
5095
5098
|
}
|
|
5096
5099
|
|
|
5097
5100
|
/** Represents a TaskMetadata. */
|
|
@@ -5127,6 +5130,9 @@ export namespace flyteidl {
|
|
|
5127
5130
|
/** TaskMetadata cacheSerializable. */
|
|
5128
5131
|
public cacheSerializable: boolean;
|
|
5129
5132
|
|
|
5133
|
+
/** TaskMetadata generatesDeck. */
|
|
5134
|
+
public generatesDeck: boolean;
|
|
5135
|
+
|
|
5130
5136
|
/** TaskMetadata interruptibleValue. */
|
|
5131
5137
|
public interruptibleValue?: "interruptible";
|
|
5132
5138
|
|
|
@@ -18855,6 +18861,137 @@ export namespace flyteidl {
|
|
|
18855
18861
|
public static verify(message: { [k: string]: any }): (string|null);
|
|
18856
18862
|
}
|
|
18857
18863
|
|
|
18864
|
+
/** ArtifactType enum. */
|
|
18865
|
+
enum ArtifactType {
|
|
18866
|
+
ARTIFACT_TYPE_UNDEFINED = 0,
|
|
18867
|
+
ARTIFACT_TYPE_DECK = 1
|
|
18868
|
+
}
|
|
18869
|
+
|
|
18870
|
+
/** Properties of a CreateDownloadLinkRequest. */
|
|
18871
|
+
interface ICreateDownloadLinkRequest {
|
|
18872
|
+
|
|
18873
|
+
/** CreateDownloadLinkRequest artifactType */
|
|
18874
|
+
artifactType?: (flyteidl.service.ArtifactType|null);
|
|
18875
|
+
|
|
18876
|
+
/** CreateDownloadLinkRequest expiresIn */
|
|
18877
|
+
expiresIn?: (google.protobuf.IDuration|null);
|
|
18878
|
+
|
|
18879
|
+
/** CreateDownloadLinkRequest nodeExecutionId */
|
|
18880
|
+
nodeExecutionId?: (flyteidl.core.INodeExecutionIdentifier|null);
|
|
18881
|
+
}
|
|
18882
|
+
|
|
18883
|
+
/** Represents a CreateDownloadLinkRequest. */
|
|
18884
|
+
class CreateDownloadLinkRequest implements ICreateDownloadLinkRequest {
|
|
18885
|
+
|
|
18886
|
+
/**
|
|
18887
|
+
* Constructs a new CreateDownloadLinkRequest.
|
|
18888
|
+
* @param [properties] Properties to set
|
|
18889
|
+
*/
|
|
18890
|
+
constructor(properties?: flyteidl.service.ICreateDownloadLinkRequest);
|
|
18891
|
+
|
|
18892
|
+
/** CreateDownloadLinkRequest artifactType. */
|
|
18893
|
+
public artifactType: flyteidl.service.ArtifactType;
|
|
18894
|
+
|
|
18895
|
+
/** CreateDownloadLinkRequest expiresIn. */
|
|
18896
|
+
public expiresIn?: (google.protobuf.IDuration|null);
|
|
18897
|
+
|
|
18898
|
+
/** CreateDownloadLinkRequest nodeExecutionId. */
|
|
18899
|
+
public nodeExecutionId?: (flyteidl.core.INodeExecutionIdentifier|null);
|
|
18900
|
+
|
|
18901
|
+
/** CreateDownloadLinkRequest source. */
|
|
18902
|
+
public source?: "nodeExecutionId";
|
|
18903
|
+
|
|
18904
|
+
/**
|
|
18905
|
+
* Creates a new CreateDownloadLinkRequest instance using the specified properties.
|
|
18906
|
+
* @param [properties] Properties to set
|
|
18907
|
+
* @returns CreateDownloadLinkRequest instance
|
|
18908
|
+
*/
|
|
18909
|
+
public static create(properties?: flyteidl.service.ICreateDownloadLinkRequest): flyteidl.service.CreateDownloadLinkRequest;
|
|
18910
|
+
|
|
18911
|
+
/**
|
|
18912
|
+
* Encodes the specified CreateDownloadLinkRequest message. Does not implicitly {@link flyteidl.service.CreateDownloadLinkRequest.verify|verify} messages.
|
|
18913
|
+
* @param message CreateDownloadLinkRequest message or plain object to encode
|
|
18914
|
+
* @param [writer] Writer to encode to
|
|
18915
|
+
* @returns Writer
|
|
18916
|
+
*/
|
|
18917
|
+
public static encode(message: flyteidl.service.ICreateDownloadLinkRequest, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
18918
|
+
|
|
18919
|
+
/**
|
|
18920
|
+
* Decodes a CreateDownloadLinkRequest message from the specified reader or buffer.
|
|
18921
|
+
* @param reader Reader or buffer to decode from
|
|
18922
|
+
* @param [length] Message length if known beforehand
|
|
18923
|
+
* @returns CreateDownloadLinkRequest
|
|
18924
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
18925
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
18926
|
+
*/
|
|
18927
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.service.CreateDownloadLinkRequest;
|
|
18928
|
+
|
|
18929
|
+
/**
|
|
18930
|
+
* Verifies a CreateDownloadLinkRequest message.
|
|
18931
|
+
* @param message Plain object to verify
|
|
18932
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
18933
|
+
*/
|
|
18934
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
18935
|
+
}
|
|
18936
|
+
|
|
18937
|
+
/** Properties of a CreateDownloadLinkResponse. */
|
|
18938
|
+
interface ICreateDownloadLinkResponse {
|
|
18939
|
+
|
|
18940
|
+
/** CreateDownloadLinkResponse signedUrl */
|
|
18941
|
+
signedUrl?: (string[]|null);
|
|
18942
|
+
|
|
18943
|
+
/** CreateDownloadLinkResponse expiresAt */
|
|
18944
|
+
expiresAt?: (google.protobuf.ITimestamp|null);
|
|
18945
|
+
}
|
|
18946
|
+
|
|
18947
|
+
/** Represents a CreateDownloadLinkResponse. */
|
|
18948
|
+
class CreateDownloadLinkResponse implements ICreateDownloadLinkResponse {
|
|
18949
|
+
|
|
18950
|
+
/**
|
|
18951
|
+
* Constructs a new CreateDownloadLinkResponse.
|
|
18952
|
+
* @param [properties] Properties to set
|
|
18953
|
+
*/
|
|
18954
|
+
constructor(properties?: flyteidl.service.ICreateDownloadLinkResponse);
|
|
18955
|
+
|
|
18956
|
+
/** CreateDownloadLinkResponse signedUrl. */
|
|
18957
|
+
public signedUrl: string[];
|
|
18958
|
+
|
|
18959
|
+
/** CreateDownloadLinkResponse expiresAt. */
|
|
18960
|
+
public expiresAt?: (google.protobuf.ITimestamp|null);
|
|
18961
|
+
|
|
18962
|
+
/**
|
|
18963
|
+
* Creates a new CreateDownloadLinkResponse instance using the specified properties.
|
|
18964
|
+
* @param [properties] Properties to set
|
|
18965
|
+
* @returns CreateDownloadLinkResponse instance
|
|
18966
|
+
*/
|
|
18967
|
+
public static create(properties?: flyteidl.service.ICreateDownloadLinkResponse): flyteidl.service.CreateDownloadLinkResponse;
|
|
18968
|
+
|
|
18969
|
+
/**
|
|
18970
|
+
* Encodes the specified CreateDownloadLinkResponse message. Does not implicitly {@link flyteidl.service.CreateDownloadLinkResponse.verify|verify} messages.
|
|
18971
|
+
* @param message CreateDownloadLinkResponse message or plain object to encode
|
|
18972
|
+
* @param [writer] Writer to encode to
|
|
18973
|
+
* @returns Writer
|
|
18974
|
+
*/
|
|
18975
|
+
public static encode(message: flyteidl.service.ICreateDownloadLinkResponse, writer?: $protobuf.Writer): $protobuf.Writer;
|
|
18976
|
+
|
|
18977
|
+
/**
|
|
18978
|
+
* Decodes a CreateDownloadLinkResponse message from the specified reader or buffer.
|
|
18979
|
+
* @param reader Reader or buffer to decode from
|
|
18980
|
+
* @param [length] Message length if known beforehand
|
|
18981
|
+
* @returns CreateDownloadLinkResponse
|
|
18982
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
18983
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
18984
|
+
*/
|
|
18985
|
+
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): flyteidl.service.CreateDownloadLinkResponse;
|
|
18986
|
+
|
|
18987
|
+
/**
|
|
18988
|
+
* Verifies a CreateDownloadLinkResponse message.
|
|
18989
|
+
* @param message Plain object to verify
|
|
18990
|
+
* @returns `null` if valid, otherwise the reason why it is not
|
|
18991
|
+
*/
|
|
18992
|
+
public static verify(message: { [k: string]: any }): (string|null);
|
|
18993
|
+
}
|
|
18994
|
+
|
|
18858
18995
|
/** Represents a DataProxyService */
|
|
18859
18996
|
class DataProxyService extends $protobuf.rpc.Service {
|
|
18860
18997
|
|
|
@@ -18902,6 +19039,20 @@ export namespace flyteidl {
|
|
|
18902
19039
|
* @returns Promise
|
|
18903
19040
|
*/
|
|
18904
19041
|
public createDownloadLocation(request: flyteidl.service.ICreateDownloadLocationRequest): Promise<flyteidl.service.CreateDownloadLocationResponse>;
|
|
19042
|
+
|
|
19043
|
+
/**
|
|
19044
|
+
* Calls CreateDownloadLink.
|
|
19045
|
+
* @param request CreateDownloadLinkRequest message or plain object
|
|
19046
|
+
* @param callback Node-style callback called with the error, if any, and CreateDownloadLinkResponse
|
|
19047
|
+
*/
|
|
19048
|
+
public createDownloadLink(request: flyteidl.service.ICreateDownloadLinkRequest, callback: flyteidl.service.DataProxyService.CreateDownloadLinkCallback): void;
|
|
19049
|
+
|
|
19050
|
+
/**
|
|
19051
|
+
* Calls CreateDownloadLink.
|
|
19052
|
+
* @param request CreateDownloadLinkRequest message or plain object
|
|
19053
|
+
* @returns Promise
|
|
19054
|
+
*/
|
|
19055
|
+
public createDownloadLink(request: flyteidl.service.ICreateDownloadLinkRequest): Promise<flyteidl.service.CreateDownloadLinkResponse>;
|
|
18905
19056
|
}
|
|
18906
19057
|
|
|
18907
19058
|
namespace DataProxyService {
|
|
@@ -18919,6 +19070,13 @@ export namespace flyteidl {
|
|
|
18919
19070
|
* @param [response] CreateDownloadLocationResponse
|
|
18920
19071
|
*/
|
|
18921
19072
|
type CreateDownloadLocationCallback = (error: (Error|null), response?: flyteidl.service.CreateDownloadLocationResponse) => void;
|
|
19073
|
+
|
|
19074
|
+
/**
|
|
19075
|
+
* Callback as used by {@link flyteidl.service.DataProxyService#createDownloadLink}.
|
|
19076
|
+
* @param error Error, if any
|
|
19077
|
+
* @param [response] CreateDownloadLinkResponse
|
|
19078
|
+
*/
|
|
19079
|
+
type CreateDownloadLinkCallback = (error: (Error|null), response?: flyteidl.service.CreateDownloadLinkResponse) => void;
|
|
18922
19080
|
}
|
|
18923
19081
|
|
|
18924
19082
|
/** Properties of a UserInfoRequest. */
|
package/gen/pb-js/flyteidl.js
CHANGED
|
@@ -12017,6 +12017,7 @@
|
|
|
12017
12017
|
* @property {string|null} [deprecatedErrorMessage] TaskMetadata deprecatedErrorMessage
|
|
12018
12018
|
* @property {boolean|null} [interruptible] TaskMetadata interruptible
|
|
12019
12019
|
* @property {boolean|null} [cacheSerializable] TaskMetadata cacheSerializable
|
|
12020
|
+
* @property {boolean|null} [generatesDeck] TaskMetadata generatesDeck
|
|
12020
12021
|
*/
|
|
12021
12022
|
|
|
12022
12023
|
/**
|
|
@@ -12098,6 +12099,14 @@
|
|
|
12098
12099
|
*/
|
|
12099
12100
|
TaskMetadata.prototype.cacheSerializable = false;
|
|
12100
12101
|
|
|
12102
|
+
/**
|
|
12103
|
+
* TaskMetadata generatesDeck.
|
|
12104
|
+
* @member {boolean} generatesDeck
|
|
12105
|
+
* @memberof flyteidl.core.TaskMetadata
|
|
12106
|
+
* @instance
|
|
12107
|
+
*/
|
|
12108
|
+
TaskMetadata.prototype.generatesDeck = false;
|
|
12109
|
+
|
|
12101
12110
|
// OneOf field names bound to virtual getters and setters
|
|
12102
12111
|
var $oneOfFields;
|
|
12103
12112
|
|
|
@@ -12152,6 +12161,8 @@
|
|
|
12152
12161
|
writer.uint32(/* id 8, wireType 0 =*/64).bool(message.interruptible);
|
|
12153
12162
|
if (message.cacheSerializable != null && message.hasOwnProperty("cacheSerializable"))
|
|
12154
12163
|
writer.uint32(/* id 9, wireType 0 =*/72).bool(message.cacheSerializable);
|
|
12164
|
+
if (message.generatesDeck != null && message.hasOwnProperty("generatesDeck"))
|
|
12165
|
+
writer.uint32(/* id 10, wireType 0 =*/80).bool(message.generatesDeck);
|
|
12155
12166
|
return writer;
|
|
12156
12167
|
};
|
|
12157
12168
|
|
|
@@ -12197,6 +12208,9 @@
|
|
|
12197
12208
|
case 9:
|
|
12198
12209
|
message.cacheSerializable = reader.bool();
|
|
12199
12210
|
break;
|
|
12211
|
+
case 10:
|
|
12212
|
+
message.generatesDeck = reader.bool();
|
|
12213
|
+
break;
|
|
12200
12214
|
default:
|
|
12201
12215
|
reader.skipType(tag & 7);
|
|
12202
12216
|
break;
|
|
@@ -12249,6 +12263,9 @@
|
|
|
12249
12263
|
if (message.cacheSerializable != null && message.hasOwnProperty("cacheSerializable"))
|
|
12250
12264
|
if (typeof message.cacheSerializable !== "boolean")
|
|
12251
12265
|
return "cacheSerializable: boolean expected";
|
|
12266
|
+
if (message.generatesDeck != null && message.hasOwnProperty("generatesDeck"))
|
|
12267
|
+
if (typeof message.generatesDeck !== "boolean")
|
|
12268
|
+
return "generatesDeck: boolean expected";
|
|
12252
12269
|
return null;
|
|
12253
12270
|
};
|
|
12254
12271
|
|
|
@@ -43891,6 +43908,328 @@
|
|
|
43891
43908
|
return CreateDownloadLocationResponse;
|
|
43892
43909
|
})();
|
|
43893
43910
|
|
|
43911
|
+
/**
|
|
43912
|
+
* ArtifactType enum.
|
|
43913
|
+
* @name flyteidl.service.ArtifactType
|
|
43914
|
+
* @enum {string}
|
|
43915
|
+
* @property {number} ARTIFACT_TYPE_UNDEFINED=0 ARTIFACT_TYPE_UNDEFINED value
|
|
43916
|
+
* @property {number} ARTIFACT_TYPE_DECK=1 ARTIFACT_TYPE_DECK value
|
|
43917
|
+
*/
|
|
43918
|
+
service.ArtifactType = (function() {
|
|
43919
|
+
var valuesById = {}, values = Object.create(valuesById);
|
|
43920
|
+
values[valuesById[0] = "ARTIFACT_TYPE_UNDEFINED"] = 0;
|
|
43921
|
+
values[valuesById[1] = "ARTIFACT_TYPE_DECK"] = 1;
|
|
43922
|
+
return values;
|
|
43923
|
+
})();
|
|
43924
|
+
|
|
43925
|
+
service.CreateDownloadLinkRequest = (function() {
|
|
43926
|
+
|
|
43927
|
+
/**
|
|
43928
|
+
* Properties of a CreateDownloadLinkRequest.
|
|
43929
|
+
* @memberof flyteidl.service
|
|
43930
|
+
* @interface ICreateDownloadLinkRequest
|
|
43931
|
+
* @property {flyteidl.service.ArtifactType|null} [artifactType] CreateDownloadLinkRequest artifactType
|
|
43932
|
+
* @property {google.protobuf.IDuration|null} [expiresIn] CreateDownloadLinkRequest expiresIn
|
|
43933
|
+
* @property {flyteidl.core.INodeExecutionIdentifier|null} [nodeExecutionId] CreateDownloadLinkRequest nodeExecutionId
|
|
43934
|
+
*/
|
|
43935
|
+
|
|
43936
|
+
/**
|
|
43937
|
+
* Constructs a new CreateDownloadLinkRequest.
|
|
43938
|
+
* @memberof flyteidl.service
|
|
43939
|
+
* @classdesc Represents a CreateDownloadLinkRequest.
|
|
43940
|
+
* @implements ICreateDownloadLinkRequest
|
|
43941
|
+
* @constructor
|
|
43942
|
+
* @param {flyteidl.service.ICreateDownloadLinkRequest=} [properties] Properties to set
|
|
43943
|
+
*/
|
|
43944
|
+
function CreateDownloadLinkRequest(properties) {
|
|
43945
|
+
if (properties)
|
|
43946
|
+
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
|
43947
|
+
if (properties[keys[i]] != null)
|
|
43948
|
+
this[keys[i]] = properties[keys[i]];
|
|
43949
|
+
}
|
|
43950
|
+
|
|
43951
|
+
/**
|
|
43952
|
+
* CreateDownloadLinkRequest artifactType.
|
|
43953
|
+
* @member {flyteidl.service.ArtifactType} artifactType
|
|
43954
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
43955
|
+
* @instance
|
|
43956
|
+
*/
|
|
43957
|
+
CreateDownloadLinkRequest.prototype.artifactType = 0;
|
|
43958
|
+
|
|
43959
|
+
/**
|
|
43960
|
+
* CreateDownloadLinkRequest expiresIn.
|
|
43961
|
+
* @member {google.protobuf.IDuration|null|undefined} expiresIn
|
|
43962
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
43963
|
+
* @instance
|
|
43964
|
+
*/
|
|
43965
|
+
CreateDownloadLinkRequest.prototype.expiresIn = null;
|
|
43966
|
+
|
|
43967
|
+
/**
|
|
43968
|
+
* CreateDownloadLinkRequest nodeExecutionId.
|
|
43969
|
+
* @member {flyteidl.core.INodeExecutionIdentifier|null|undefined} nodeExecutionId
|
|
43970
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
43971
|
+
* @instance
|
|
43972
|
+
*/
|
|
43973
|
+
CreateDownloadLinkRequest.prototype.nodeExecutionId = null;
|
|
43974
|
+
|
|
43975
|
+
// OneOf field names bound to virtual getters and setters
|
|
43976
|
+
var $oneOfFields;
|
|
43977
|
+
|
|
43978
|
+
/**
|
|
43979
|
+
* CreateDownloadLinkRequest source.
|
|
43980
|
+
* @member {"nodeExecutionId"|undefined} source
|
|
43981
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
43982
|
+
* @instance
|
|
43983
|
+
*/
|
|
43984
|
+
Object.defineProperty(CreateDownloadLinkRequest.prototype, "source", {
|
|
43985
|
+
get: $util.oneOfGetter($oneOfFields = ["nodeExecutionId"]),
|
|
43986
|
+
set: $util.oneOfSetter($oneOfFields)
|
|
43987
|
+
});
|
|
43988
|
+
|
|
43989
|
+
/**
|
|
43990
|
+
* Creates a new CreateDownloadLinkRequest instance using the specified properties.
|
|
43991
|
+
* @function create
|
|
43992
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
43993
|
+
* @static
|
|
43994
|
+
* @param {flyteidl.service.ICreateDownloadLinkRequest=} [properties] Properties to set
|
|
43995
|
+
* @returns {flyteidl.service.CreateDownloadLinkRequest} CreateDownloadLinkRequest instance
|
|
43996
|
+
*/
|
|
43997
|
+
CreateDownloadLinkRequest.create = function create(properties) {
|
|
43998
|
+
return new CreateDownloadLinkRequest(properties);
|
|
43999
|
+
};
|
|
44000
|
+
|
|
44001
|
+
/**
|
|
44002
|
+
* Encodes the specified CreateDownloadLinkRequest message. Does not implicitly {@link flyteidl.service.CreateDownloadLinkRequest.verify|verify} messages.
|
|
44003
|
+
* @function encode
|
|
44004
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
44005
|
+
* @static
|
|
44006
|
+
* @param {flyteidl.service.ICreateDownloadLinkRequest} message CreateDownloadLinkRequest message or plain object to encode
|
|
44007
|
+
* @param {$protobuf.Writer} [writer] Writer to encode to
|
|
44008
|
+
* @returns {$protobuf.Writer} Writer
|
|
44009
|
+
*/
|
|
44010
|
+
CreateDownloadLinkRequest.encode = function encode(message, writer) {
|
|
44011
|
+
if (!writer)
|
|
44012
|
+
writer = $Writer.create();
|
|
44013
|
+
if (message.artifactType != null && message.hasOwnProperty("artifactType"))
|
|
44014
|
+
writer.uint32(/* id 1, wireType 0 =*/8).int32(message.artifactType);
|
|
44015
|
+
if (message.expiresIn != null && message.hasOwnProperty("expiresIn"))
|
|
44016
|
+
$root.google.protobuf.Duration.encode(message.expiresIn, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
|
|
44017
|
+
if (message.nodeExecutionId != null && message.hasOwnProperty("nodeExecutionId"))
|
|
44018
|
+
$root.flyteidl.core.NodeExecutionIdentifier.encode(message.nodeExecutionId, writer.uint32(/* id 3, wireType 2 =*/26).fork()).ldelim();
|
|
44019
|
+
return writer;
|
|
44020
|
+
};
|
|
44021
|
+
|
|
44022
|
+
/**
|
|
44023
|
+
* Decodes a CreateDownloadLinkRequest message from the specified reader or buffer.
|
|
44024
|
+
* @function decode
|
|
44025
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
44026
|
+
* @static
|
|
44027
|
+
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
|
|
44028
|
+
* @param {number} [length] Message length if known beforehand
|
|
44029
|
+
* @returns {flyteidl.service.CreateDownloadLinkRequest} CreateDownloadLinkRequest
|
|
44030
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
44031
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
44032
|
+
*/
|
|
44033
|
+
CreateDownloadLinkRequest.decode = function decode(reader, length) {
|
|
44034
|
+
if (!(reader instanceof $Reader))
|
|
44035
|
+
reader = $Reader.create(reader);
|
|
44036
|
+
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.service.CreateDownloadLinkRequest();
|
|
44037
|
+
while (reader.pos < end) {
|
|
44038
|
+
var tag = reader.uint32();
|
|
44039
|
+
switch (tag >>> 3) {
|
|
44040
|
+
case 1:
|
|
44041
|
+
message.artifactType = reader.int32();
|
|
44042
|
+
break;
|
|
44043
|
+
case 2:
|
|
44044
|
+
message.expiresIn = $root.google.protobuf.Duration.decode(reader, reader.uint32());
|
|
44045
|
+
break;
|
|
44046
|
+
case 3:
|
|
44047
|
+
message.nodeExecutionId = $root.flyteidl.core.NodeExecutionIdentifier.decode(reader, reader.uint32());
|
|
44048
|
+
break;
|
|
44049
|
+
default:
|
|
44050
|
+
reader.skipType(tag & 7);
|
|
44051
|
+
break;
|
|
44052
|
+
}
|
|
44053
|
+
}
|
|
44054
|
+
return message;
|
|
44055
|
+
};
|
|
44056
|
+
|
|
44057
|
+
/**
|
|
44058
|
+
* Verifies a CreateDownloadLinkRequest message.
|
|
44059
|
+
* @function verify
|
|
44060
|
+
* @memberof flyteidl.service.CreateDownloadLinkRequest
|
|
44061
|
+
* @static
|
|
44062
|
+
* @param {Object.<string,*>} message Plain object to verify
|
|
44063
|
+
* @returns {string|null} `null` if valid, otherwise the reason why it is not
|
|
44064
|
+
*/
|
|
44065
|
+
CreateDownloadLinkRequest.verify = function verify(message) {
|
|
44066
|
+
if (typeof message !== "object" || message === null)
|
|
44067
|
+
return "object expected";
|
|
44068
|
+
var properties = {};
|
|
44069
|
+
if (message.artifactType != null && message.hasOwnProperty("artifactType"))
|
|
44070
|
+
switch (message.artifactType) {
|
|
44071
|
+
default:
|
|
44072
|
+
return "artifactType: enum value expected";
|
|
44073
|
+
case 0:
|
|
44074
|
+
case 1:
|
|
44075
|
+
break;
|
|
44076
|
+
}
|
|
44077
|
+
if (message.expiresIn != null && message.hasOwnProperty("expiresIn")) {
|
|
44078
|
+
var error = $root.google.protobuf.Duration.verify(message.expiresIn);
|
|
44079
|
+
if (error)
|
|
44080
|
+
return "expiresIn." + error;
|
|
44081
|
+
}
|
|
44082
|
+
if (message.nodeExecutionId != null && message.hasOwnProperty("nodeExecutionId")) {
|
|
44083
|
+
properties.source = 1;
|
|
44084
|
+
{
|
|
44085
|
+
var error = $root.flyteidl.core.NodeExecutionIdentifier.verify(message.nodeExecutionId);
|
|
44086
|
+
if (error)
|
|
44087
|
+
return "nodeExecutionId." + error;
|
|
44088
|
+
}
|
|
44089
|
+
}
|
|
44090
|
+
return null;
|
|
44091
|
+
};
|
|
44092
|
+
|
|
44093
|
+
return CreateDownloadLinkRequest;
|
|
44094
|
+
})();
|
|
44095
|
+
|
|
44096
|
+
service.CreateDownloadLinkResponse = (function() {
|
|
44097
|
+
|
|
44098
|
+
/**
|
|
44099
|
+
* Properties of a CreateDownloadLinkResponse.
|
|
44100
|
+
* @memberof flyteidl.service
|
|
44101
|
+
* @interface ICreateDownloadLinkResponse
|
|
44102
|
+
* @property {Array.<string>|null} [signedUrl] CreateDownloadLinkResponse signedUrl
|
|
44103
|
+
* @property {google.protobuf.ITimestamp|null} [expiresAt] CreateDownloadLinkResponse expiresAt
|
|
44104
|
+
*/
|
|
44105
|
+
|
|
44106
|
+
/**
|
|
44107
|
+
* Constructs a new CreateDownloadLinkResponse.
|
|
44108
|
+
* @memberof flyteidl.service
|
|
44109
|
+
* @classdesc Represents a CreateDownloadLinkResponse.
|
|
44110
|
+
* @implements ICreateDownloadLinkResponse
|
|
44111
|
+
* @constructor
|
|
44112
|
+
* @param {flyteidl.service.ICreateDownloadLinkResponse=} [properties] Properties to set
|
|
44113
|
+
*/
|
|
44114
|
+
function CreateDownloadLinkResponse(properties) {
|
|
44115
|
+
this.signedUrl = [];
|
|
44116
|
+
if (properties)
|
|
44117
|
+
for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
|
|
44118
|
+
if (properties[keys[i]] != null)
|
|
44119
|
+
this[keys[i]] = properties[keys[i]];
|
|
44120
|
+
}
|
|
44121
|
+
|
|
44122
|
+
/**
|
|
44123
|
+
* CreateDownloadLinkResponse signedUrl.
|
|
44124
|
+
* @member {Array.<string>} signedUrl
|
|
44125
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44126
|
+
* @instance
|
|
44127
|
+
*/
|
|
44128
|
+
CreateDownloadLinkResponse.prototype.signedUrl = $util.emptyArray;
|
|
44129
|
+
|
|
44130
|
+
/**
|
|
44131
|
+
* CreateDownloadLinkResponse expiresAt.
|
|
44132
|
+
* @member {google.protobuf.ITimestamp|null|undefined} expiresAt
|
|
44133
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44134
|
+
* @instance
|
|
44135
|
+
*/
|
|
44136
|
+
CreateDownloadLinkResponse.prototype.expiresAt = null;
|
|
44137
|
+
|
|
44138
|
+
/**
|
|
44139
|
+
* Creates a new CreateDownloadLinkResponse instance using the specified properties.
|
|
44140
|
+
* @function create
|
|
44141
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44142
|
+
* @static
|
|
44143
|
+
* @param {flyteidl.service.ICreateDownloadLinkResponse=} [properties] Properties to set
|
|
44144
|
+
* @returns {flyteidl.service.CreateDownloadLinkResponse} CreateDownloadLinkResponse instance
|
|
44145
|
+
*/
|
|
44146
|
+
CreateDownloadLinkResponse.create = function create(properties) {
|
|
44147
|
+
return new CreateDownloadLinkResponse(properties);
|
|
44148
|
+
};
|
|
44149
|
+
|
|
44150
|
+
/**
|
|
44151
|
+
* Encodes the specified CreateDownloadLinkResponse message. Does not implicitly {@link flyteidl.service.CreateDownloadLinkResponse.verify|verify} messages.
|
|
44152
|
+
* @function encode
|
|
44153
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44154
|
+
* @static
|
|
44155
|
+
* @param {flyteidl.service.ICreateDownloadLinkResponse} message CreateDownloadLinkResponse message or plain object to encode
|
|
44156
|
+
* @param {$protobuf.Writer} [writer] Writer to encode to
|
|
44157
|
+
* @returns {$protobuf.Writer} Writer
|
|
44158
|
+
*/
|
|
44159
|
+
CreateDownloadLinkResponse.encode = function encode(message, writer) {
|
|
44160
|
+
if (!writer)
|
|
44161
|
+
writer = $Writer.create();
|
|
44162
|
+
if (message.signedUrl != null && message.signedUrl.length)
|
|
44163
|
+
for (var i = 0; i < message.signedUrl.length; ++i)
|
|
44164
|
+
writer.uint32(/* id 1, wireType 2 =*/10).string(message.signedUrl[i]);
|
|
44165
|
+
if (message.expiresAt != null && message.hasOwnProperty("expiresAt"))
|
|
44166
|
+
$root.google.protobuf.Timestamp.encode(message.expiresAt, writer.uint32(/* id 2, wireType 2 =*/18).fork()).ldelim();
|
|
44167
|
+
return writer;
|
|
44168
|
+
};
|
|
44169
|
+
|
|
44170
|
+
/**
|
|
44171
|
+
* Decodes a CreateDownloadLinkResponse message from the specified reader or buffer.
|
|
44172
|
+
* @function decode
|
|
44173
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44174
|
+
* @static
|
|
44175
|
+
* @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
|
|
44176
|
+
* @param {number} [length] Message length if known beforehand
|
|
44177
|
+
* @returns {flyteidl.service.CreateDownloadLinkResponse} CreateDownloadLinkResponse
|
|
44178
|
+
* @throws {Error} If the payload is not a reader or valid buffer
|
|
44179
|
+
* @throws {$protobuf.util.ProtocolError} If required fields are missing
|
|
44180
|
+
*/
|
|
44181
|
+
CreateDownloadLinkResponse.decode = function decode(reader, length) {
|
|
44182
|
+
if (!(reader instanceof $Reader))
|
|
44183
|
+
reader = $Reader.create(reader);
|
|
44184
|
+
var end = length === undefined ? reader.len : reader.pos + length, message = new $root.flyteidl.service.CreateDownloadLinkResponse();
|
|
44185
|
+
while (reader.pos < end) {
|
|
44186
|
+
var tag = reader.uint32();
|
|
44187
|
+
switch (tag >>> 3) {
|
|
44188
|
+
case 1:
|
|
44189
|
+
if (!(message.signedUrl && message.signedUrl.length))
|
|
44190
|
+
message.signedUrl = [];
|
|
44191
|
+
message.signedUrl.push(reader.string());
|
|
44192
|
+
break;
|
|
44193
|
+
case 2:
|
|
44194
|
+
message.expiresAt = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
|
|
44195
|
+
break;
|
|
44196
|
+
default:
|
|
44197
|
+
reader.skipType(tag & 7);
|
|
44198
|
+
break;
|
|
44199
|
+
}
|
|
44200
|
+
}
|
|
44201
|
+
return message;
|
|
44202
|
+
};
|
|
44203
|
+
|
|
44204
|
+
/**
|
|
44205
|
+
* Verifies a CreateDownloadLinkResponse message.
|
|
44206
|
+
* @function verify
|
|
44207
|
+
* @memberof flyteidl.service.CreateDownloadLinkResponse
|
|
44208
|
+
* @static
|
|
44209
|
+
* @param {Object.<string,*>} message Plain object to verify
|
|
44210
|
+
* @returns {string|null} `null` if valid, otherwise the reason why it is not
|
|
44211
|
+
*/
|
|
44212
|
+
CreateDownloadLinkResponse.verify = function verify(message) {
|
|
44213
|
+
if (typeof message !== "object" || message === null)
|
|
44214
|
+
return "object expected";
|
|
44215
|
+
if (message.signedUrl != null && message.hasOwnProperty("signedUrl")) {
|
|
44216
|
+
if (!Array.isArray(message.signedUrl))
|
|
44217
|
+
return "signedUrl: array expected";
|
|
44218
|
+
for (var i = 0; i < message.signedUrl.length; ++i)
|
|
44219
|
+
if (!$util.isString(message.signedUrl[i]))
|
|
44220
|
+
return "signedUrl: string[] expected";
|
|
44221
|
+
}
|
|
44222
|
+
if (message.expiresAt != null && message.hasOwnProperty("expiresAt")) {
|
|
44223
|
+
var error = $root.google.protobuf.Timestamp.verify(message.expiresAt);
|
|
44224
|
+
if (error)
|
|
44225
|
+
return "expiresAt." + error;
|
|
44226
|
+
}
|
|
44227
|
+
return null;
|
|
44228
|
+
};
|
|
44229
|
+
|
|
44230
|
+
return CreateDownloadLinkResponse;
|
|
44231
|
+
})();
|
|
44232
|
+
|
|
43894
44233
|
service.DataProxyService = (function() {
|
|
43895
44234
|
|
|
43896
44235
|
/**
|
|
@@ -43989,6 +44328,39 @@
|
|
|
43989
44328
|
* @variation 2
|
|
43990
44329
|
*/
|
|
43991
44330
|
|
|
44331
|
+
/**
|
|
44332
|
+
* Callback as used by {@link flyteidl.service.DataProxyService#createDownloadLink}.
|
|
44333
|
+
* @memberof flyteidl.service.DataProxyService
|
|
44334
|
+
* @typedef CreateDownloadLinkCallback
|
|
44335
|
+
* @type {function}
|
|
44336
|
+
* @param {Error|null} error Error, if any
|
|
44337
|
+
* @param {flyteidl.service.CreateDownloadLinkResponse} [response] CreateDownloadLinkResponse
|
|
44338
|
+
*/
|
|
44339
|
+
|
|
44340
|
+
/**
|
|
44341
|
+
* Calls CreateDownloadLink.
|
|
44342
|
+
* @function createDownloadLink
|
|
44343
|
+
* @memberof flyteidl.service.DataProxyService
|
|
44344
|
+
* @instance
|
|
44345
|
+
* @param {flyteidl.service.ICreateDownloadLinkRequest} request CreateDownloadLinkRequest message or plain object
|
|
44346
|
+
* @param {flyteidl.service.DataProxyService.CreateDownloadLinkCallback} callback Node-style callback called with the error, if any, and CreateDownloadLinkResponse
|
|
44347
|
+
* @returns {undefined}
|
|
44348
|
+
* @variation 1
|
|
44349
|
+
*/
|
|
44350
|
+
Object.defineProperty(DataProxyService.prototype.createDownloadLink = function createDownloadLink(request, callback) {
|
|
44351
|
+
return this.rpcCall(createDownloadLink, $root.flyteidl.service.CreateDownloadLinkRequest, $root.flyteidl.service.CreateDownloadLinkResponse, request, callback);
|
|
44352
|
+
}, "name", { value: "CreateDownloadLink" });
|
|
44353
|
+
|
|
44354
|
+
/**
|
|
44355
|
+
* Calls CreateDownloadLink.
|
|
44356
|
+
* @function createDownloadLink
|
|
44357
|
+
* @memberof flyteidl.service.DataProxyService
|
|
44358
|
+
* @instance
|
|
44359
|
+
* @param {flyteidl.service.ICreateDownloadLinkRequest} request CreateDownloadLinkRequest message or plain object
|
|
44360
|
+
* @returns {Promise<flyteidl.service.CreateDownloadLinkResponse>} Promise
|
|
44361
|
+
* @variation 2
|
|
44362
|
+
*/
|
|
44363
|
+
|
|
43992
44364
|
return DataProxyService;
|
|
43993
44365
|
})();
|
|
43994
44366
|
|
package/package.json
CHANGED
|
@@ -2236,6 +2236,7 @@ Task Metadata
|
|
|
2236
2236
|
"deprecated_error_message", ":ref:`ref_string`", "", "If set, this indicates that this task is deprecated. This will enable owners of tasks to notify consumers of the ending of support for a given task."
|
|
2237
2237
|
"interruptible", ":ref:`ref_bool`", "", ""
|
|
2238
2238
|
"cache_serializable", ":ref:`ref_bool`", "", "Indicates whether the system should attempt to execute discoverable instances in serial to avoid duplicate work"
|
|
2239
|
+
"generates_deck", ":ref:`ref_bool`", "", "Indicates whether the task will generate a Deck URI when it finishes executing."
|
|
2239
2240
|
|
|
2240
2241
|
|
|
2241
2242
|
|
|
@@ -234,6 +234,51 @@ flyteidl/service/dataproxy.proto
|
|
|
234
234
|
|
|
235
235
|
|
|
236
236
|
|
|
237
|
+
.. _ref_flyteidl.service.CreateDownloadLinkRequest:
|
|
238
|
+
|
|
239
|
+
CreateDownloadLinkRequest
|
|
240
|
+
------------------------------------------------------------------
|
|
241
|
+
|
|
242
|
+
CreateDownloadLinkRequest defines the request parameters to create a download link (signed url)
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
.. csv-table:: CreateDownloadLinkRequest type fields
|
|
247
|
+
:header: "Field", "Type", "Label", "Description"
|
|
248
|
+
:widths: auto
|
|
249
|
+
|
|
250
|
+
"artifact_type", ":ref:`ref_flyteidl.service.ArtifactType`", "", "ArtifactType of the artifact requested."
|
|
251
|
+
"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."
|
|
252
|
+
"node_execution_id", ":ref:`ref_flyteidl.core.NodeExecutionIdentifier`", "", "NodeId is the unique identifier for the node execution. For a task node, this will retrieve the output of the most recent attempt of the task."
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
.. _ref_flyteidl.service.CreateDownloadLinkResponse:
|
|
261
|
+
|
|
262
|
+
CreateDownloadLinkResponse
|
|
263
|
+
------------------------------------------------------------------
|
|
264
|
+
|
|
265
|
+
CreateDownloadLinkResponse defines the response for the generated links
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
.. csv-table:: CreateDownloadLinkResponse type fields
|
|
270
|
+
:header: "Field", "Type", "Label", "Description"
|
|
271
|
+
:widths: auto
|
|
272
|
+
|
|
273
|
+
"signed_url", ":ref:`ref_string`", "repeated", "SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)"
|
|
274
|
+
"expires_at", ":ref:`ref_google.protobuf.Timestamp`", "", "ExpiresAt defines when will the signed URL expire."
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
237
282
|
.. _ref_flyteidl.service.CreateDownloadLocationRequest:
|
|
238
283
|
|
|
239
284
|
CreateDownloadLocationRequest
|
|
@@ -329,6 +374,22 @@ CreateUploadLocationResponse
|
|
|
329
374
|
end messages
|
|
330
375
|
|
|
331
376
|
|
|
377
|
+
|
|
378
|
+
.. _ref_flyteidl.service.ArtifactType:
|
|
379
|
+
|
|
380
|
+
ArtifactType
|
|
381
|
+
------------------------------------------------------------------
|
|
382
|
+
|
|
383
|
+
ArtifactType
|
|
384
|
+
|
|
385
|
+
.. csv-table:: Enum ArtifactType values
|
|
386
|
+
:header: "Name", "Number", "Description"
|
|
387
|
+
:widths: auto
|
|
388
|
+
|
|
389
|
+
"ARTIFACT_TYPE_UNDEFINED", "0", "ARTIFACT_TYPE_UNDEFINED is the default, often invalid, value for the enum."
|
|
390
|
+
"ARTIFACT_TYPE_DECK", "1", "ARTIFACT_TYPE_DECK refers to the deck html file optionally generated after a task, a workflow or a launch plan finishes executing."
|
|
391
|
+
|
|
392
|
+
|
|
332
393
|
..
|
|
333
394
|
end enums
|
|
334
395
|
|
|
@@ -351,6 +412,7 @@ DataProxyService defines an RPC Service that allows access to user-data in a con
|
|
|
351
412
|
|
|
352
413
|
"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."
|
|
353
414
|
"CreateDownloadLocation", ":ref:`ref_flyteidl.service.CreateDownloadLocationRequest`", ":ref:`ref_flyteidl.service.CreateDownloadLocationResponse`", "CreateDownloadLocation creates a signed url to download artifacts."
|
|
415
|
+
"CreateDownloadLink", ":ref:`ref_flyteidl.service.CreateDownloadLinkRequest`", ":ref:`ref_flyteidl.service.CreateDownloadLinkResponse`", "CreateDownloadLocation creates a signed url to download artifacts."
|
|
354
416
|
|
|
355
417
|
..
|
|
356
418
|
end services
|
|
@@ -95,6 +95,9 @@ message TaskMetadata {
|
|
|
95
95
|
|
|
96
96
|
// Indicates whether the system should attempt to execute discoverable instances in serial to avoid duplicate work
|
|
97
97
|
bool cache_serializable = 9;
|
|
98
|
+
|
|
99
|
+
// Indicates whether the task will generate a Deck URI when it finishes executing.
|
|
100
|
+
bool generates_deck = 10;
|
|
98
101
|
}
|
|
99
102
|
|
|
100
103
|
// A Task structure that uniquely identifies a task in the system
|
|
@@ -261,7 +264,7 @@ message K8sPod {
|
|
|
261
264
|
K8sObjectMetadata metadata = 1;
|
|
262
265
|
|
|
263
266
|
// Defines the primary pod spec created when a task is executed.
|
|
264
|
-
// This should be a JSON-marshalled pod spec, which can be defined in
|
|
267
|
+
// This should be a JSON-marshalled pod spec, which can be defined in
|
|
265
268
|
// - go, using: https://github.com/kubernetes/api/blob/release-1.21/core/v1/types.go#L2936
|
|
266
269
|
// - python: using https://github.com/kubernetes-client/python/blob/release-19.0/kubernetes/client/models/v1_pod_spec.py
|
|
267
270
|
google.protobuf.Struct pod_spec = 2;
|
|
@@ -4,8 +4,6 @@ package flyteidl.plugins;
|
|
|
4
4
|
|
|
5
5
|
option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/plugins";
|
|
6
6
|
|
|
7
|
-
import "google/protobuf/timestamp.proto";
|
|
8
|
-
|
|
9
7
|
// RayJobSpec defines the desired state of RayJob
|
|
10
8
|
message RayJob {
|
|
11
9
|
// RayClusterSpec is the cluster template to run the job
|
|
@@ -7,6 +7,7 @@ import "google/api/annotations.proto";
|
|
|
7
7
|
import "protoc-gen-swagger/options/annotations.proto";
|
|
8
8
|
import "google/protobuf/duration.proto";
|
|
9
9
|
import "google/protobuf/timestamp.proto";
|
|
10
|
+
import "flyteidl/core/identifier.proto";
|
|
10
11
|
|
|
11
12
|
message CreateUploadLocationResponse {
|
|
12
13
|
// SignedUrl specifies the url to use to upload content to (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
|
|
@@ -46,6 +47,7 @@ message CreateUploadLocationRequest {
|
|
|
46
47
|
|
|
47
48
|
// CreateDownloadLocationRequest specified request for the CreateDownloadLocation API.
|
|
48
49
|
message CreateDownloadLocationRequest {
|
|
50
|
+
option deprecated = true;
|
|
49
51
|
// NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)
|
|
50
52
|
string native_url = 1;
|
|
51
53
|
|
|
@@ -57,12 +59,49 @@ message CreateDownloadLocationRequest {
|
|
|
57
59
|
}
|
|
58
60
|
|
|
59
61
|
message CreateDownloadLocationResponse {
|
|
62
|
+
option deprecated = true;
|
|
60
63
|
// SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
|
|
61
64
|
string signed_url = 1;
|
|
62
65
|
// ExpiresAt defines when will the signed URL expires.
|
|
63
66
|
google.protobuf.Timestamp expires_at = 2;
|
|
64
67
|
}
|
|
65
68
|
|
|
69
|
+
// ArtifactType
|
|
70
|
+
enum ArtifactType {
|
|
71
|
+
// ARTIFACT_TYPE_UNDEFINED is the default, often invalid, value for the enum.
|
|
72
|
+
ARTIFACT_TYPE_UNDEFINED = 0;
|
|
73
|
+
|
|
74
|
+
// ARTIFACT_TYPE_DECK refers to the deck html file optionally generated after a task, a workflow or a launch plan
|
|
75
|
+
// finishes executing.
|
|
76
|
+
ARTIFACT_TYPE_DECK = 1;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
// CreateDownloadLinkRequest defines the request parameters to create a download link (signed url)
|
|
80
|
+
message CreateDownloadLinkRequest {
|
|
81
|
+
// ArtifactType of the artifact requested.
|
|
82
|
+
ArtifactType artifact_type = 1;
|
|
83
|
+
|
|
84
|
+
// ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this
|
|
85
|
+
// exceeds the platform allowed max.
|
|
86
|
+
// +optional. The default value comes from a global config.
|
|
87
|
+
google.protobuf.Duration expires_in = 2;
|
|
88
|
+
|
|
89
|
+
oneof source {
|
|
90
|
+
// NodeId is the unique identifier for the node execution. For a task node, this will retrieve the output of the
|
|
91
|
+
// most recent attempt of the task.
|
|
92
|
+
core.NodeExecutionIdentifier node_execution_id = 3;
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
// CreateDownloadLinkResponse defines the response for the generated links
|
|
97
|
+
message CreateDownloadLinkResponse {
|
|
98
|
+
// SignedUrl specifies the url to use to download content from (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)
|
|
99
|
+
repeated string signed_url = 1;
|
|
100
|
+
|
|
101
|
+
// ExpiresAt defines when will the signed URL expire.
|
|
102
|
+
google.protobuf.Timestamp expires_at = 2;
|
|
103
|
+
}
|
|
104
|
+
|
|
66
105
|
// DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.
|
|
67
106
|
service DataProxyService {
|
|
68
107
|
// CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain.
|
|
@@ -75,11 +114,24 @@ service DataProxyService {
|
|
|
75
114
|
description: "Creates a write-only http location that is accessible for tasks at runtime."
|
|
76
115
|
};
|
|
77
116
|
}
|
|
117
|
+
|
|
78
118
|
// CreateDownloadLocation creates a signed url to download artifacts.
|
|
79
119
|
rpc CreateDownloadLocation (CreateDownloadLocationRequest) returns (CreateDownloadLocationResponse) {
|
|
120
|
+
option deprecated = true;
|
|
80
121
|
option (google.api.http) = {
|
|
81
122
|
get: "/api/v1/dataproxy/artifact_urn"
|
|
82
123
|
};
|
|
124
|
+
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
125
|
+
description: "Deprecated: Please use CreateDownloadLink instead. Creates a read-only http location that is accessible for tasks at runtime."
|
|
126
|
+
};
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// CreateDownloadLocation creates a signed url to download artifacts.
|
|
130
|
+
rpc CreateDownloadLink (CreateDownloadLinkRequest) returns (CreateDownloadLinkResponse) {
|
|
131
|
+
option (google.api.http) = {
|
|
132
|
+
post: "/api/v1/dataproxy/artifact_link"
|
|
133
|
+
body: "*"
|
|
134
|
+
};
|
|
83
135
|
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
84
136
|
description: "Creates a read-only http location that is accessible for tasks at runtime."
|
|
85
137
|
};
|