@flyteorg/flyteidl 1.4.0 → 1.5.1

package/protos/flyteidl/service/external_plugin_service.proto

@@ -0,0 +1,74 @@
+syntax = "proto3";
+package flyteidl.service;
+
+option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
+import "flyteidl/core/literals.proto";
+import "flyteidl/core/tasks.proto";
+import "flyteidl/core/interface.proto";
+
+// ExternalPluginService defines an RPC Service that allows propeller to send the request to the backend plugin server.
+service ExternalPluginService {
+  // Send a task create request to the backend plugin server.
+  rpc CreateTask (TaskCreateRequest) returns (TaskCreateResponse){};
+  // Get job status.
+  rpc GetTask (TaskGetRequest) returns (TaskGetResponse){};
+  // Delete the task resource.
+  rpc DeleteTask (TaskDeleteRequest) returns (TaskDeleteResponse){};
+}
+
+// The state of the execution is used to control its visibility in the UI/CLI.
+enum State {
+  RETRYABLE_FAILURE = 0;
+  PERMANENT_FAILURE = 1;
+  PENDING = 2;
+  RUNNING = 3;
+  SUCCEEDED = 4;
+}
+
+// Represents a request structure to create task.
+message TaskCreateRequest {
+  // The inputs required to start the execution. All required inputs must be
+  // included in this map. If not required and not provided, defaults apply.
+  // +optional
+  core.LiteralMap inputs = 1;
+  // Template of the task that encapsulates all the metadata of the task.
+  core.TaskTemplate template = 2;
+  // Prefix for where task output data will be written. (e.g. s3://my-bucket/randomstring)
+  string output_prefix = 3;
+}
+
+// Represents a create response structure.
+message TaskCreateResponse {
+  string job_id = 1;
+}
+
+// A message used to fetch a job state from backend plugin server.
+message TaskGetRequest {
+  // A predefined yet extensible Task type identifier.
+  string task_type = 1;
+  // The unique id identifying the job.
+  string job_id = 2;
+}
+
+// Response to get an individual task state.
+message TaskGetResponse {
+  // The state of the execution is used to control its visibility in the UI/CLI.
+  State state = 1;
+  // The outputs of the execution. It's typically used by sql task. Flyteplugins service will create a
+  // Structured dataset pointing to the query result table.
+  // +optional
+  core.LiteralMap outputs = 2;
+}
+
+// A message used to delete a task.
+message TaskDeleteRequest {
+  // A predefined yet extensible Task type identifier.
+  string task_type = 1;
+  // The unique id identifying the job.
+  string job_id = 2;
+}
+
+// Response to delete a task.
+message TaskDeleteResponse {
+}
+

package/protos/flyteidl/service/identity.proto

@@ -4,6 +4,7 @@ package flyteidl.service;
 option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
 
 import "google/api/annotations.proto";
+import "google/protobuf/struct.proto";
 // import "protoc-gen-swagger/options/annotations.proto";
 
 message UserInfoRequest {}
@@ -31,6 +32,9 @@ message UserInfoResponse {
 
   // Profile picture URL
   string picture = 7;
+
+  // Additional claims
+  google.protobuf.Struct additional_claims = 8;
 }
 
 // IdentityService defines an RPC Service that interacts with user/app identities.