@flyteorg/flyteidl 1.16.0 → 2.0.0-alpha2
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/package.json +6 -9
- package/LICENSE +0 -202
- package/NOTICE +0 -4
- package/README.md +0 -14
- package/gen/pb-js/flyteidl.d.ts +0 -28307
- package/gen/pb-js/flyteidl.js +0 -66636
- package/protos/buf.lock +0 -18
- package/protos/buf.yaml +0 -12
- package/protos/docs/admin/admin.rst +0 -4623
- package/protos/docs/admin/index.rst +0 -13
- package/protos/docs/contributing.md +0 -68
- package/protos/docs/core/core.rst +0 -3952
- package/protos/docs/core/index.rst +0 -15
- package/protos/docs/datacatalog/datacatalog.rst +0 -1313
- package/protos/docs/datacatalog/index.rst +0 -16
- package/protos/docs/event/event.rst +0 -726
- package/protos/docs/event/index.rst +0 -27
- package/protos/docs/plugins/index.rst +0 -14
- package/protos/docs/plugins/plugins.rst +0 -780
- package/protos/docs/restructuredtext.tmpl +0 -129
- package/protos/docs/service/index.rst +0 -13
- package/protos/docs/service/service.rst +0 -543
- package/protos/docs/withoutscalar_restructuredtext.tmpl +0 -105
- package/protos/docs_index.rst +0 -19
- package/protos/flyteidl/admin/agent.proto +0 -309
- package/protos/flyteidl/admin/cluster_assignment.proto +0 -11
- package/protos/flyteidl/admin/common.proto +0 -337
- package/protos/flyteidl/admin/description_entity.proto +0 -95
- package/protos/flyteidl/admin/event.proto +0 -70
- package/protos/flyteidl/admin/execution.proto +0 -436
- package/protos/flyteidl/admin/launch_plan.proto +0 -231
- package/protos/flyteidl/admin/matchable_resource.proto +0 -194
- package/protos/flyteidl/admin/node_execution.proto +0 -248
- package/protos/flyteidl/admin/notification.proto +0 -27
- package/protos/flyteidl/admin/project.proto +0 -132
- package/protos/flyteidl/admin/project_attributes.proto +0 -69
- package/protos/flyteidl/admin/project_domain_attributes.proto +0 -80
- package/protos/flyteidl/admin/schedule.proto +0 -43
- package/protos/flyteidl/admin/signal.proto +0 -86
- package/protos/flyteidl/admin/task.proto +0 -71
- package/protos/flyteidl/admin/task_execution.proto +0 -171
- package/protos/flyteidl/admin/version.proto +0 -27
- package/protos/flyteidl/admin/workflow.proto +0 -92
- package/protos/flyteidl/admin/workflow_attributes.proto +0 -89
- package/protos/flyteidl/cacheservice/cacheservice.proto +0 -143
- package/protos/flyteidl/core/artifact_id.proto +0 -112
- package/protos/flyteidl/core/catalog.proto +0 -63
- package/protos/flyteidl/core/compiler.proto +0 -64
- package/protos/flyteidl/core/condition.proto +0 -63
- package/protos/flyteidl/core/dynamic_job.proto +0 -32
- package/protos/flyteidl/core/errors.proto +0 -42
- package/protos/flyteidl/core/execution.proto +0 -156
- package/protos/flyteidl/core/execution_envs.proto +0 -45
- package/protos/flyteidl/core/identifier.proto +0 -80
- package/protos/flyteidl/core/interface.proto +0 -64
- package/protos/flyteidl/core/literals.proto +0 -205
- package/protos/flyteidl/core/metrics.proto +0 -50
- package/protos/flyteidl/core/security.proto +0 -135
- package/protos/flyteidl/core/tasks.proto +0 -392
- package/protos/flyteidl/core/types.proto +0 -208
- package/protos/flyteidl/core/workflow.proto +0 -361
- package/protos/flyteidl/core/workflow_closure.proto +0 -18
- package/protos/flyteidl/datacatalog/datacatalog.proto +0 -420
- package/protos/flyteidl/event/cloudevents.proto +0 -81
- package/protos/flyteidl/event/event.proto +0 -347
- package/protos/flyteidl/plugins/array_job.proto +0 -30
- package/protos/flyteidl/plugins/common.proto +0 -27
- package/protos/flyteidl/plugins/dask.proto +0 -41
- package/protos/flyteidl/plugins/kubeflow/common.proto +0 -28
- package/protos/flyteidl/plugins/kubeflow/mpi.proto +0 -47
- package/protos/flyteidl/plugins/kubeflow/pytorch.proto +0 -53
- package/protos/flyteidl/plugins/kubeflow/tensorflow.proto +0 -46
- package/protos/flyteidl/plugins/mpi.proto +0 -20
- package/protos/flyteidl/plugins/presto.proto +0 -14
- package/protos/flyteidl/plugins/pytorch.proto +0 -25
- package/protos/flyteidl/plugins/qubole.proto +0 -26
- package/protos/flyteidl/plugins/ray.proto +0 -59
- package/protos/flyteidl/plugins/spark.proto +0 -42
- package/protos/flyteidl/plugins/tensorflow.proto +0 -18
- package/protos/flyteidl/plugins/waitable.proto +0 -15
- package/protos/flyteidl/service/admin.proto +0 -668
- package/protos/flyteidl/service/agent.proto +0 -79
- package/protos/flyteidl/service/auth.proto +0 -94
- package/protos/flyteidl/service/dataproxy.proto +0 -205
- package/protos/flyteidl/service/external_plugin_service.proto +0 -79
- package/protos/flyteidl/service/identity.proto +0 -51
- package/protos/flyteidl/service/signal.proto +0 -55
|
@@ -1,668 +0,0 @@
|
|
|
1
|
-
syntax = "proto3";
|
|
2
|
-
package flyteidl.service;
|
|
3
|
-
|
|
4
|
-
option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
|
|
5
|
-
|
|
6
|
-
import "google/api/annotations.proto";
|
|
7
|
-
import "flyteidl/admin/project.proto";
|
|
8
|
-
import "flyteidl/admin/project_domain_attributes.proto";
|
|
9
|
-
import "flyteidl/admin/project_attributes.proto";
|
|
10
|
-
import "flyteidl/admin/task.proto";
|
|
11
|
-
import "flyteidl/admin/workflow.proto";
|
|
12
|
-
import "flyteidl/admin/workflow_attributes.proto";
|
|
13
|
-
import "flyteidl/admin/launch_plan.proto";
|
|
14
|
-
import "flyteidl/admin/event.proto";
|
|
15
|
-
import "flyteidl/admin/execution.proto";
|
|
16
|
-
import "flyteidl/admin/matchable_resource.proto";
|
|
17
|
-
import "flyteidl/admin/node_execution.proto";
|
|
18
|
-
import "flyteidl/admin/task_execution.proto";
|
|
19
|
-
import "flyteidl/admin/version.proto";
|
|
20
|
-
import "flyteidl/admin/common.proto";
|
|
21
|
-
import "flyteidl/admin/description_entity.proto";
|
|
22
|
-
import "protoc-gen-openapiv2/options/annotations.proto";
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
// The following defines an RPC service that is also served over HTTP via grpc-gateway.
|
|
26
|
-
// Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
|
|
27
|
-
service AdminService {
|
|
28
|
-
// Create and upload a :ref:`ref_flyteidl.admin.Task` definition
|
|
29
|
-
rpc CreateTask (flyteidl.admin.TaskCreateRequest) returns (flyteidl.admin.TaskCreateResponse) {
|
|
30
|
-
option (google.api.http) = {
|
|
31
|
-
post: "/api/v1/tasks"
|
|
32
|
-
body: "*"
|
|
33
|
-
};
|
|
34
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
35
|
-
description: "Create and register a task definition."
|
|
36
|
-
responses: {
|
|
37
|
-
key: "400"
|
|
38
|
-
value: {
|
|
39
|
-
description: "Returned for bad request that may have failed validation."
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
|
-
responses: {
|
|
43
|
-
key: "409"
|
|
44
|
-
value: {
|
|
45
|
-
description: "Returned for a request that references an identical entity that has already been registered."
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
};
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
// Fetch a :ref:`ref_flyteidl.admin.Task` definition.
|
|
52
|
-
rpc GetTask (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.Task) {
|
|
53
|
-
option (google.api.http) = {
|
|
54
|
-
get: "/api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
55
|
-
};
|
|
56
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
57
|
-
description: "Retrieve an existing task definition."
|
|
58
|
-
};
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
|
|
62
|
-
rpc ListTaskIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
63
|
-
option (google.api.http) = {
|
|
64
|
-
get: "/api/v1/task_ids/{project}/{domain}"
|
|
65
|
-
};
|
|
66
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
67
|
-
description: "Fetch existing task definition identifiers matching input filters."
|
|
68
|
-
};
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
|
|
72
|
-
rpc ListTasks (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.TaskList) {
|
|
73
|
-
option (google.api.http) = {
|
|
74
|
-
get: "/api/v1/tasks/{id.project}/{id.domain}/{id.name}"
|
|
75
|
-
additional_bindings {
|
|
76
|
-
get: "/api/v1/tasks/{id.project}/{id.domain}",
|
|
77
|
-
}
|
|
78
|
-
};
|
|
79
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
80
|
-
description: "Fetch existing task definitions matching input filters."
|
|
81
|
-
};
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
// Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
|
|
85
|
-
rpc CreateWorkflow (flyteidl.admin.WorkflowCreateRequest) returns (flyteidl.admin.WorkflowCreateResponse) {
|
|
86
|
-
option (google.api.http) = {
|
|
87
|
-
post: "/api/v1/workflows"
|
|
88
|
-
body: "*"
|
|
89
|
-
};
|
|
90
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
91
|
-
description: "Create and register a workflow definition."
|
|
92
|
-
responses: {
|
|
93
|
-
key: "400"
|
|
94
|
-
value: {
|
|
95
|
-
description: "Returned for bad request that may have failed validation."
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
responses: {
|
|
99
|
-
key: "409"
|
|
100
|
-
value: {
|
|
101
|
-
description: "Returned for a request that references an identical entity that has already been registered."
|
|
102
|
-
}
|
|
103
|
-
}
|
|
104
|
-
};
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
// Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
|
|
108
|
-
rpc GetWorkflow (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.Workflow) {
|
|
109
|
-
option (google.api.http) = {
|
|
110
|
-
get: "/api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
111
|
-
};
|
|
112
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
113
|
-
description: "Retrieve an existing workflow definition."
|
|
114
|
-
};
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
|
|
118
|
-
rpc ListWorkflowIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
119
|
-
option (google.api.http) = {
|
|
120
|
-
get: "/api/v1/workflow_ids/{project}/{domain}"
|
|
121
|
-
};
|
|
122
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
123
|
-
// description: "Fetch an existing workflow definition identifiers matching input filters."
|
|
124
|
-
// };
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
|
|
128
|
-
rpc ListWorkflows (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.WorkflowList) {
|
|
129
|
-
option (google.api.http) = {
|
|
130
|
-
get: "/api/v1/workflows/{id.project}/{id.domain}/{id.name}"
|
|
131
|
-
additional_bindings {
|
|
132
|
-
get: "/api/v1/workflows/{id.project}/{id.domain}",
|
|
133
|
-
}
|
|
134
|
-
};
|
|
135
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
136
|
-
description: "Fetch existing workflow definitions matching input filters."
|
|
137
|
-
};
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
// Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
|
|
141
|
-
rpc CreateLaunchPlan (flyteidl.admin.LaunchPlanCreateRequest) returns (flyteidl.admin.LaunchPlanCreateResponse) {
|
|
142
|
-
option (google.api.http) = {
|
|
143
|
-
post: "/api/v1/launch_plans"
|
|
144
|
-
body: "*"
|
|
145
|
-
};
|
|
146
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
147
|
-
description: "Create and register a launch plan definition."
|
|
148
|
-
responses: {
|
|
149
|
-
key: "400"
|
|
150
|
-
value: {
|
|
151
|
-
description: "Returned for bad request that may have failed validation."
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
responses: {
|
|
155
|
-
key: "409"
|
|
156
|
-
value: {
|
|
157
|
-
description: "Returned for a request that references an identical entity that has already been registered."
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
};
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
// Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
|
|
164
|
-
rpc GetLaunchPlan (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.LaunchPlan) {
|
|
165
|
-
option (google.api.http) = {
|
|
166
|
-
get: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
167
|
-
};
|
|
168
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
169
|
-
description: "Retrieve an existing launch plan definition."
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
// Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
174
|
-
rpc GetActiveLaunchPlan (flyteidl.admin.ActiveLaunchPlanRequest) returns (flyteidl.admin.LaunchPlan) {
|
|
175
|
-
option (google.api.http) = {
|
|
176
|
-
get: "/api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}"
|
|
177
|
-
};
|
|
178
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
179
|
-
description: "Retrieve the active launch plan version specified by input request filters."
|
|
180
|
-
};
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
// List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
184
|
-
rpc ListActiveLaunchPlans (flyteidl.admin.ActiveLaunchPlanListRequest) returns (flyteidl.admin.LaunchPlanList) {
|
|
185
|
-
option (google.api.http) = {
|
|
186
|
-
get: "/api/v1/active_launch_plans/{project}/{domain}"
|
|
187
|
-
};
|
|
188
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
189
|
-
description: "Fetch the active launch plan versions specified by input request filters."
|
|
190
|
-
};
|
|
191
|
-
}
|
|
192
|
-
|
|
193
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
|
|
194
|
-
rpc ListLaunchPlanIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
195
|
-
option (google.api.http) = {
|
|
196
|
-
get: "/api/v1/launch_plan_ids/{project}/{domain}"
|
|
197
|
-
};
|
|
198
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
199
|
-
description: "Fetch existing launch plan definition identifiers matching input filters."
|
|
200
|
-
};
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
|
|
204
|
-
rpc ListLaunchPlans (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.LaunchPlanList) {
|
|
205
|
-
option (google.api.http) = {
|
|
206
|
-
get: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}"
|
|
207
|
-
additional_bindings {
|
|
208
|
-
get: "/api/v1/launch_plans/{id.project}/{id.domain}"
|
|
209
|
-
}
|
|
210
|
-
};
|
|
211
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
212
|
-
description: "Fetch existing launch plan definitions matching input filters."
|
|
213
|
-
};
|
|
214
|
-
}
|
|
215
|
-
|
|
216
|
-
// Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
217
|
-
rpc UpdateLaunchPlan (flyteidl.admin.LaunchPlanUpdateRequest) returns (flyteidl.admin.LaunchPlanUpdateResponse) {
|
|
218
|
-
option (google.api.http) = {
|
|
219
|
-
put: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
220
|
-
body: "*"
|
|
221
|
-
};
|
|
222
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
223
|
-
description: "Update the status of an existing launch plan definition. "
|
|
224
|
-
"At most one launch plan version for a given {project, domain, name} can be active at a time. "
|
|
225
|
-
"If this call sets a launch plan to active and existing version is already active, the result of this call will be that the "
|
|
226
|
-
"formerly active launch plan will be made inactive and specified launch plan in this request will be made active. "
|
|
227
|
-
"In the event that the formerly active launch plan had a schedule associated it with it, this schedule will be disabled. "
|
|
228
|
-
"If the reference launch plan in this request is being set to active and has a schedule associated with it, the schedule will be enabled."
|
|
229
|
-
};
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
// Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
|
|
233
|
-
rpc CreateExecution (flyteidl.admin.ExecutionCreateRequest) returns (flyteidl.admin.ExecutionCreateResponse) {
|
|
234
|
-
option (google.api.http) = {
|
|
235
|
-
post: "/api/v1/executions"
|
|
236
|
-
body: "*"
|
|
237
|
-
};
|
|
238
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
239
|
-
description: "Create a workflow execution."
|
|
240
|
-
};
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
// Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
|
|
244
|
-
rpc RelaunchExecution (flyteidl.admin.ExecutionRelaunchRequest) returns (flyteidl.admin.ExecutionCreateResponse) {
|
|
245
|
-
option (google.api.http) = {
|
|
246
|
-
post: "/api/v1/executions/relaunch"
|
|
247
|
-
body: "*"
|
|
248
|
-
};
|
|
249
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
250
|
-
description: "Relaunch a workflow execution."
|
|
251
|
-
};
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
// Recreates a previously-run workflow execution that will only start executing from the last known failure point.
|
|
255
|
-
// In Recover mode, users cannot change any input parameters or update the version of the execution.
|
|
256
|
-
// This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures,
|
|
257
|
-
// downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again.
|
|
258
|
-
// See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details.
|
|
259
|
-
rpc RecoverExecution (flyteidl.admin.ExecutionRecoverRequest) returns (flyteidl.admin.ExecutionCreateResponse) {
|
|
260
|
-
option (google.api.http) = {
|
|
261
|
-
post: "/api/v1/executions/recover"
|
|
262
|
-
body: "*"
|
|
263
|
-
};
|
|
264
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
265
|
-
description: "Recreates a previously-run workflow execution that will only start executing from the last known failure point. "
|
|
266
|
-
"In Recover mode, users cannot change any input parameters or update the version of the execution. "
|
|
267
|
-
"This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, "
|
|
268
|
-
"downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again."
|
|
269
|
-
};
|
|
270
|
-
}
|
|
271
|
-
|
|
272
|
-
// Fetches a :ref:`ref_flyteidl.admin.Execution`.
|
|
273
|
-
rpc GetExecution (flyteidl.admin.WorkflowExecutionGetRequest) returns (flyteidl.admin.Execution) {
|
|
274
|
-
option (google.api.http) = {
|
|
275
|
-
get: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
276
|
-
};
|
|
277
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
278
|
-
description: "Retrieve an existing workflow execution."
|
|
279
|
-
};
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
// Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
|
|
283
|
-
rpc UpdateExecution (flyteidl.admin.ExecutionUpdateRequest) returns (flyteidl.admin.ExecutionUpdateResponse) {
|
|
284
|
-
option (google.api.http) = {
|
|
285
|
-
put: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
286
|
-
body: "*"
|
|
287
|
-
};
|
|
288
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
289
|
-
// description: "Update execution belonging to project domain."
|
|
290
|
-
// };
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
// Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
|
|
294
|
-
rpc GetExecutionData (flyteidl.admin.WorkflowExecutionGetDataRequest) returns (flyteidl.admin.WorkflowExecutionGetDataResponse) {
|
|
295
|
-
option (google.api.http) = {
|
|
296
|
-
get: "/api/v1/data/executions/{id.project}/{id.domain}/{id.name}"
|
|
297
|
-
};
|
|
298
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
299
|
-
// description: "Retrieve input and output data from an existing workflow execution."
|
|
300
|
-
// };
|
|
301
|
-
};
|
|
302
|
-
|
|
303
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
|
|
304
|
-
rpc ListExecutions (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.ExecutionList) {
|
|
305
|
-
option (google.api.http) = {
|
|
306
|
-
get: "/api/v1/executions/{id.project}/{id.domain}"
|
|
307
|
-
};
|
|
308
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
309
|
-
// description: "Fetch existing workflow executions matching input filters."
|
|
310
|
-
// };
|
|
311
|
-
}
|
|
312
|
-
|
|
313
|
-
// Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
|
|
314
|
-
rpc TerminateExecution (flyteidl.admin.ExecutionTerminateRequest) returns (flyteidl.admin.ExecutionTerminateResponse) {
|
|
315
|
-
option (google.api.http) = {
|
|
316
|
-
delete: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
317
|
-
body: "*"
|
|
318
|
-
};
|
|
319
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
320
|
-
// description: "Terminate the active workflow execution specified in the request."
|
|
321
|
-
// };
|
|
322
|
-
}
|
|
323
|
-
|
|
324
|
-
// Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
|
|
325
|
-
rpc GetNodeExecution (flyteidl.admin.NodeExecutionGetRequest) returns (flyteidl.admin.NodeExecution) {
|
|
326
|
-
option (google.api.http) = {
|
|
327
|
-
get: "/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
328
|
-
};
|
|
329
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
330
|
-
// description: "Retrieve an existing node execution."
|
|
331
|
-
// };
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
// Fetches a :ref:`ref_flyteidl.admin.DynamicNodeWorkflowResponse`.
|
|
335
|
-
rpc GetDynamicNodeWorkflow (flyteidl.admin.GetDynamicNodeWorkflowRequest) returns (flyteidl.admin.DynamicNodeWorkflowResponse) {
|
|
336
|
-
option (google.api.http) = {
|
|
337
|
-
get: "/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}/dynamic_workflow"
|
|
338
|
-
};
|
|
339
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
340
|
-
// description: "Retrieve a workflow closure from a dynamic node execution."
|
|
341
|
-
// };
|
|
342
|
-
}
|
|
343
|
-
|
|
344
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
|
|
345
|
-
rpc ListNodeExecutions (flyteidl.admin.NodeExecutionListRequest) returns (flyteidl.admin.NodeExecutionList) {
|
|
346
|
-
option (google.api.http) = {
|
|
347
|
-
get: "/api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
|
|
348
|
-
};
|
|
349
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
350
|
-
// description: "Fetch existing node executions matching input filters."
|
|
351
|
-
// };
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
355
|
-
rpc ListNodeExecutionsForTask (flyteidl.admin.NodeExecutionForTaskListRequest) returns (flyteidl.admin.NodeExecutionList) {
|
|
356
|
-
option (google.api.http) = {
|
|
357
|
-
get: "/api/v1/children/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt}"
|
|
358
|
-
};
|
|
359
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
360
|
-
// description: "Fetch child node executions launched by the specified task execution."
|
|
361
|
-
// };
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
// Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
|
|
365
|
-
rpc GetNodeExecutionData (flyteidl.admin.NodeExecutionGetDataRequest) returns (flyteidl.admin.NodeExecutionGetDataResponse) {
|
|
366
|
-
option (google.api.http) = {
|
|
367
|
-
get: "/api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
368
|
-
};
|
|
369
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
370
|
-
// description: "Retrieve input and output data from an existing node execution."
|
|
371
|
-
// };
|
|
372
|
-
};
|
|
373
|
-
|
|
374
|
-
// Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
|
|
375
|
-
rpc RegisterProject (flyteidl.admin.ProjectRegisterRequest) returns (flyteidl.admin.ProjectRegisterResponse) {
|
|
376
|
-
option (google.api.http) = {
|
|
377
|
-
post: "/api/v1/projects"
|
|
378
|
-
body: "*"
|
|
379
|
-
};
|
|
380
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
381
|
-
// description: "Register a project."
|
|
382
|
-
// };
|
|
383
|
-
}
|
|
384
|
-
|
|
385
|
-
// Updates an existing :ref:`ref_flyteidl.admin.Project`
|
|
386
|
-
// flyteidl.admin.Project should be passed but the domains property should be empty;
|
|
387
|
-
// it will be ignored in the handler as domains cannot be updated via this API.
|
|
388
|
-
rpc UpdateProject (flyteidl.admin.Project) returns (flyteidl.admin.ProjectUpdateResponse) {
|
|
389
|
-
option (google.api.http) = {
|
|
390
|
-
put: "/api/v1/projects/{id}"
|
|
391
|
-
body: "*"
|
|
392
|
-
};
|
|
393
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
394
|
-
description: "Update a project."
|
|
395
|
-
};
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
// Fetches a :ref:`ref_flyteidl.admin.Project`
|
|
399
|
-
rpc GetProject (flyteidl.admin.ProjectGetRequest) returns (flyteidl.admin.Project) {
|
|
400
|
-
option (google.api.http) = {
|
|
401
|
-
get: "/api/v1/projects/{id}"
|
|
402
|
-
};
|
|
403
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
404
|
-
description: "Fetch a registered project."
|
|
405
|
-
};
|
|
406
|
-
}
|
|
407
|
-
|
|
408
|
-
// Fetches a list of :ref:`ref_flyteidl.admin.Project`
|
|
409
|
-
rpc ListProjects (flyteidl.admin.ProjectListRequest) returns (flyteidl.admin.Projects) {
|
|
410
|
-
option (google.api.http) = {
|
|
411
|
-
get: "/api/v1/projects"
|
|
412
|
-
};
|
|
413
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
414
|
-
description: "Fetch registered projects."
|
|
415
|
-
};
|
|
416
|
-
}
|
|
417
|
-
|
|
418
|
-
rpc GetDomains (flyteidl.admin.GetDomainRequest) returns (flyteidl.admin.GetDomainsResponse) {
|
|
419
|
-
option (google.api.http) = {
|
|
420
|
-
get: "/api/v1/domains"
|
|
421
|
-
};
|
|
422
|
-
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
423
|
-
// description: "Fetch registered domains."
|
|
424
|
-
// };
|
|
425
|
-
}
|
|
426
|
-
|
|
427
|
-
// Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
|
|
428
|
-
rpc CreateWorkflowEvent (flyteidl.admin.WorkflowExecutionEventRequest) returns (flyteidl.admin.WorkflowExecutionEventResponse) {
|
|
429
|
-
option (google.api.http) = {
|
|
430
|
-
post: "/api/v1/events/workflows"
|
|
431
|
-
body: "*"
|
|
432
|
-
};
|
|
433
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
434
|
-
description: "Create a workflow execution event recording a phase transition."
|
|
435
|
-
};
|
|
436
|
-
}
|
|
437
|
-
|
|
438
|
-
// Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
|
|
439
|
-
rpc CreateNodeEvent (flyteidl.admin.NodeExecutionEventRequest) returns (flyteidl.admin.NodeExecutionEventResponse) {
|
|
440
|
-
option (google.api.http) = {
|
|
441
|
-
post: "/api/v1/events/nodes"
|
|
442
|
-
body: "*"
|
|
443
|
-
};
|
|
444
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
445
|
-
description: "Create a node execution event recording a phase transition."
|
|
446
|
-
};
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
// Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
|
|
450
|
-
rpc CreateTaskEvent (flyteidl.admin.TaskExecutionEventRequest) returns (flyteidl.admin.TaskExecutionEventResponse) {
|
|
451
|
-
option (google.api.http) = {
|
|
452
|
-
post: "/api/v1/events/tasks"
|
|
453
|
-
body: "*"
|
|
454
|
-
};
|
|
455
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
456
|
-
description: "Create a task execution event recording a phase transition."
|
|
457
|
-
};
|
|
458
|
-
}
|
|
459
|
-
|
|
460
|
-
// Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
461
|
-
rpc GetTaskExecution (flyteidl.admin.TaskExecutionGetRequest) returns (flyteidl.admin.TaskExecution) {
|
|
462
|
-
option (google.api.http) = {
|
|
463
|
-
get: "/api/v1/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
464
|
-
};
|
|
465
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
466
|
-
description: "Retrieve an existing task execution."
|
|
467
|
-
};
|
|
468
|
-
}
|
|
469
|
-
|
|
470
|
-
// Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
471
|
-
rpc ListTaskExecutions (flyteidl.admin.TaskExecutionListRequest) returns (flyteidl.admin.TaskExecutionList) {
|
|
472
|
-
option (google.api.http) = {
|
|
473
|
-
get: "/api/v1/task_executions/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id}"
|
|
474
|
-
};
|
|
475
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
476
|
-
description: "Fetch existing task executions matching input filters."
|
|
477
|
-
};
|
|
478
|
-
|
|
479
|
-
}
|
|
480
|
-
|
|
481
|
-
// Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
482
|
-
rpc GetTaskExecutionData (flyteidl.admin.TaskExecutionGetDataRequest) returns (flyteidl.admin.TaskExecutionGetDataResponse) {
|
|
483
|
-
option (google.api.http) = {
|
|
484
|
-
get: "/api/v1/data/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
485
|
-
};
|
|
486
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
487
|
-
description: "Retrieve input and output data from an existing task execution."
|
|
488
|
-
};
|
|
489
|
-
}
|
|
490
|
-
|
|
491
|
-
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
492
|
-
rpc UpdateProjectDomainAttributes (flyteidl.admin.ProjectDomainAttributesUpdateRequest) returns (flyteidl.admin.ProjectDomainAttributesUpdateResponse) {
|
|
493
|
-
option (google.api.http) = {
|
|
494
|
-
put: "/api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}"
|
|
495
|
-
body: "*"
|
|
496
|
-
};
|
|
497
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
498
|
-
description: "Update the customized resource attributes associated with a project-domain combination"
|
|
499
|
-
};
|
|
500
|
-
}
|
|
501
|
-
|
|
502
|
-
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
503
|
-
rpc GetProjectDomainAttributes (flyteidl.admin.ProjectDomainAttributesGetRequest) returns (flyteidl.admin.ProjectDomainAttributesGetResponse) {
|
|
504
|
-
option (google.api.http) = {
|
|
505
|
-
get: "/api/v1/project_domain_attributes/{project}/{domain}"
|
|
506
|
-
};
|
|
507
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
508
|
-
description: "Retrieve the customized resource attributes associated with a project-domain combination"
|
|
509
|
-
};
|
|
510
|
-
}
|
|
511
|
-
|
|
512
|
-
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
513
|
-
rpc DeleteProjectDomainAttributes (flyteidl.admin.ProjectDomainAttributesDeleteRequest) returns (flyteidl.admin.ProjectDomainAttributesDeleteResponse) {
|
|
514
|
-
option (google.api.http) = {
|
|
515
|
-
delete: "/api/v1/project_domain_attributes/{project}/{domain}"
|
|
516
|
-
body: "*"
|
|
517
|
-
};
|
|
518
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
519
|
-
description: "Delete the customized resource attributes associated with a project-domain combination"
|
|
520
|
-
};
|
|
521
|
-
}
|
|
522
|
-
|
|
523
|
-
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` at the project level
|
|
524
|
-
rpc UpdateProjectAttributes (flyteidl.admin.ProjectAttributesUpdateRequest) returns (flyteidl.admin.ProjectAttributesUpdateResponse) {
|
|
525
|
-
option (google.api.http) = {
|
|
526
|
-
put: "/api/v1/project_attributes/{attributes.project}"
|
|
527
|
-
body: "*"
|
|
528
|
-
};
|
|
529
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
530
|
-
description: "Update the customized resource attributes associated with a project"
|
|
531
|
-
};
|
|
532
|
-
}
|
|
533
|
-
|
|
534
|
-
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
535
|
-
rpc GetProjectAttributes (flyteidl.admin.ProjectAttributesGetRequest) returns (flyteidl.admin.ProjectAttributesGetResponse) {
|
|
536
|
-
option (google.api.http) = {
|
|
537
|
-
get: "/api/v1/project_attributes/{project}"
|
|
538
|
-
};
|
|
539
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
540
|
-
description: "Retrieve the customized resource attributes associated with a project"
|
|
541
|
-
};
|
|
542
|
-
}
|
|
543
|
-
|
|
544
|
-
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
545
|
-
rpc DeleteProjectAttributes (flyteidl.admin.ProjectAttributesDeleteRequest) returns (flyteidl.admin.ProjectAttributesDeleteResponse) {
|
|
546
|
-
option (google.api.http) = {
|
|
547
|
-
delete: "/api/v1/project_attributes/{project}"
|
|
548
|
-
body: "*"
|
|
549
|
-
};
|
|
550
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
551
|
-
description: "Delete the customized resource attributes associated with a project"
|
|
552
|
-
};
|
|
553
|
-
}
|
|
554
|
-
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
555
|
-
rpc UpdateWorkflowAttributes (flyteidl.admin.WorkflowAttributesUpdateRequest) returns (flyteidl.admin.WorkflowAttributesUpdateResponse) {
|
|
556
|
-
option (google.api.http) = {
|
|
557
|
-
put: "/api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}"
|
|
558
|
-
body: "*"
|
|
559
|
-
};
|
|
560
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
561
|
-
description: "Update the customized resource attributes associated with a project, domain and workflow combination"
|
|
562
|
-
};
|
|
563
|
-
}
|
|
564
|
-
|
|
565
|
-
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
566
|
-
rpc GetWorkflowAttributes (flyteidl.admin.WorkflowAttributesGetRequest) returns (flyteidl.admin.WorkflowAttributesGetResponse) {
|
|
567
|
-
option (google.api.http) = {
|
|
568
|
-
get: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
|
|
569
|
-
};
|
|
570
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
571
|
-
description: "Retrieve the customized resource attributes associated with a project, domain and workflow combination"
|
|
572
|
-
};
|
|
573
|
-
}
|
|
574
|
-
|
|
575
|
-
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
576
|
-
rpc DeleteWorkflowAttributes (flyteidl.admin.WorkflowAttributesDeleteRequest) returns (flyteidl.admin.WorkflowAttributesDeleteResponse) {
|
|
577
|
-
option (google.api.http) = {
|
|
578
|
-
delete: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
|
|
579
|
-
body: "*"
|
|
580
|
-
};
|
|
581
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
582
|
-
description: "Delete the customized resource attributes associated with a project, domain and workflow combination"
|
|
583
|
-
};
|
|
584
|
-
}
|
|
585
|
-
|
|
586
|
-
// Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
|
|
587
|
-
rpc ListMatchableAttributes (flyteidl.admin.ListMatchableAttributesRequest) returns (flyteidl.admin.ListMatchableAttributesResponse) {
|
|
588
|
-
option (google.api.http) = {
|
|
589
|
-
get: "/api/v1/matchable_attributes"
|
|
590
|
-
};
|
|
591
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
592
|
-
description: "Retrieve a list of MatchableAttributesConfiguration objects."
|
|
593
|
-
};
|
|
594
|
-
}
|
|
595
|
-
|
|
596
|
-
// Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
|
|
597
|
-
rpc ListNamedEntities (flyteidl.admin.NamedEntityListRequest) returns (flyteidl.admin.NamedEntityList) {
|
|
598
|
-
option (google.api.http) = {
|
|
599
|
-
get: "/api/v1/named_entities/{resource_type}/{project}/{domain}"
|
|
600
|
-
};
|
|
601
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
602
|
-
description: "Retrieve a list of NamedEntity objects sharing a common resource type, project, and domain."
|
|
603
|
-
};
|
|
604
|
-
}
|
|
605
|
-
|
|
606
|
-
// Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
|
|
607
|
-
rpc GetNamedEntity (flyteidl.admin.NamedEntityGetRequest) returns (flyteidl.admin.NamedEntity) {
|
|
608
|
-
option (google.api.http) = {
|
|
609
|
-
get: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
610
|
-
};
|
|
611
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
612
|
-
description: "Retrieve a NamedEntity object."
|
|
613
|
-
};
|
|
614
|
-
}
|
|
615
|
-
|
|
616
|
-
// Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
|
|
617
|
-
rpc UpdateNamedEntity (flyteidl.admin.NamedEntityUpdateRequest) returns (flyteidl.admin.NamedEntityUpdateResponse) {
|
|
618
|
-
option (google.api.http) = {
|
|
619
|
-
put: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
620
|
-
body: "*"
|
|
621
|
-
};
|
|
622
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
623
|
-
description: "Update the fields associated with a NamedEntity"
|
|
624
|
-
};
|
|
625
|
-
}
|
|
626
|
-
|
|
627
|
-
rpc GetVersion (flyteidl.admin.GetVersionRequest) returns (flyteidl.admin.GetVersionResponse) {
|
|
628
|
-
option (google.api.http) = {
|
|
629
|
-
get: "/api/v1/version"
|
|
630
|
-
};
|
|
631
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
632
|
-
description: "Retrieve the Version (including the Build information) for FlyteAdmin service"
|
|
633
|
-
};
|
|
634
|
-
}
|
|
635
|
-
|
|
636
|
-
// Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.
|
|
637
|
-
rpc GetDescriptionEntity (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.DescriptionEntity) {
|
|
638
|
-
option (google.api.http) = {
|
|
639
|
-
get: "/api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
640
|
-
};
|
|
641
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
642
|
-
description: "Retrieve an existing description entity description."
|
|
643
|
-
};
|
|
644
|
-
}
|
|
645
|
-
|
|
646
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
|
|
647
|
-
rpc ListDescriptionEntities (flyteidl.admin.DescriptionEntityListRequest) returns (flyteidl.admin.DescriptionEntityList) {
|
|
648
|
-
option (google.api.http) = {
|
|
649
|
-
get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
650
|
-
additional_bindings {
|
|
651
|
-
get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}"
|
|
652
|
-
}
|
|
653
|
-
};
|
|
654
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
655
|
-
description: "Fetch existing description entity definitions matching input filters."
|
|
656
|
-
};
|
|
657
|
-
}
|
|
658
|
-
|
|
659
|
-
// Fetches runtime metrics for a :ref:`ref_flyteidl.admin.Execution`.
|
|
660
|
-
rpc GetExecutionMetrics (flyteidl.admin.WorkflowExecutionGetMetricsRequest) returns (flyteidl.admin.WorkflowExecutionGetMetricsResponse) {
|
|
661
|
-
option (google.api.http) = {
|
|
662
|
-
get: "/api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}"
|
|
663
|
-
};
|
|
664
|
-
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
665
|
-
description: "Retrieve metrics from an existing workflow execution."
|
|
666
|
-
};
|
|
667
|
-
};
|
|
668
|
-
}
|