@flyteorg/flyteidl 1.16.0 → 2.0.0-test1

package/protos/flyteidl/admin/version.proto

@@ -1,27 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-// Response for the GetVersion API
-message GetVersionResponse {
-    // The control plane version information. FlyteAdmin and related components
-    // form the control plane of Flyte
-    Version control_plane_version = 1;
-}
-
-// Provides Version information for a component
-message Version {
-    // Specifies the GIT sha of the build
-    string	Build = 1;
-
-    // Version for the build, should follow a semver
-    string Version = 2;
-
-    // Build timestamp
-    string BuildTime = 3;
-}
-
-// Empty request for GetVersion
-message GetVersionRequest {
-}

package/protos/flyteidl/admin/workflow.proto

@@ -1,92 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/core/compiler.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/workflow.proto";
-import "flyteidl/admin/description_entity.proto";
-import "google/protobuf/timestamp.proto";
-
-// Represents a request structure to create a revision of a workflow.
-// See :ref:`ref_flyteidl.admin.Workflow` for more details
-message WorkflowCreateRequest {
-    // id represents the unique identifier of the workflow.
-    // +required
-    core.Identifier id     = 1;
-    
-    // Represents the specification for workflow.
-    // +required
-    WorkflowSpec spec      = 2;
-}
-
-message WorkflowCreateResponse {
-    // Purposefully empty, may be populated in the future. 
-}
-
-// Represents the workflow structure stored in the Admin
-// A workflow is created by ordering tasks and associating outputs to inputs
-// in order to produce a directed-acyclic execution graph.
-message Workflow {
-    // id represents the unique identifier of the workflow.
-    core.Identifier id       = 1;
-    
-    // closure encapsulates all the fields that maps to a compiled version of the workflow.
-    WorkflowClosure closure  = 2;
-
-    // One-liner overview of the entity.
-    string short_description = 3;
-}
-
-// Represents a list of workflows returned from the admin.
-// See :ref:`ref_flyteidl.admin.Workflow` for more details
-message WorkflowList {
-    // A list of workflows returned based on the request.
-    repeated Workflow workflows = 1;
-
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query. If there are no more results, this value will be empty.
-    string token                = 2;
-}
-
-// Represents a structure that encapsulates the specification of the workflow.
-message WorkflowSpec {
-    // Template of the task that encapsulates all the metadata of the workflow.
-    core.WorkflowTemplate template = 1;
-
-    // Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the
-    // propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out
-    // to Admin to see other registered workflows).  In fact, subworkflows do not even need to be registered.
-    repeated core.WorkflowTemplate sub_workflows = 2;
-
-    // Represents the specification for description entity.
-    DescriptionEntity description        = 3;
-}
-
-// A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.
-message WorkflowClosure {
-    // Represents the compiled representation of the workflow from the specification provided.
-    core.CompiledWorkflowClosure compiled_workflow = 1;
-
-    // Time at which the workflow was created.
-    google.protobuf.Timestamp created_at           = 2;
-}
-
-// The workflow id is already used and the structure is different
-message WorkflowErrorExistsDifferentStructure {
-    core.Identifier id = 1;
-}
-
-// The workflow id is already used with an identical sctructure
-message WorkflowErrorExistsIdenticalStructure {
-    core.Identifier id = 1;
-}
-
-// When a CreateWorkflowRequest fails due to matching id
-message CreateWorkflowFailureReason {
-    oneof reason {
-        WorkflowErrorExistsDifferentStructure exists_different_structure = 1;
-        WorkflowErrorExistsIdenticalStructure exists_identical_structure = 2;
-    }
-}

package/protos/flyteidl/admin/workflow_attributes.proto

@@ -1,89 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/admin/matchable_resource.proto";
-
-// Defines a set of custom matching attributes which defines resource defaults for a project, domain and workflow.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message WorkflowAttributes {
-    // Unique project id for which this set of attributes will be applied.
-    string project                 = 1;
-
-    // Unique domain id for which this set of attributes will be applied.
-    string domain                  = 2;
-
-    // Workflow name for which this set of attributes will be applied.
-    string workflow                = 3;
-
-    MatchingAttributes matching_attributes = 4;
-
-    // Optional, org key applied to the attributes.
-    string org = 5;
-}
-
-// Sets custom attributes for a project, domain and workflow combination.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message WorkflowAttributesUpdateRequest {
-    WorkflowAttributes attributes = 1;
-}
-
-// Purposefully empty, may be populated in the future.
-message WorkflowAttributesUpdateResponse {
-}
-
-// Request to get an individual workflow attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message WorkflowAttributesGetRequest {
-    // Unique project id which this set of attributes references.
-    // +required
-    string project                 = 1;
-
-    // Unique domain id which this set of attributes references.
-    // +required
-    string domain                  = 2;
-
-    // Workflow name which this set of attributes references.
-    // +required
-    string workflow                = 3;
-
-    // Which type of matchable attributes to return.
-    // +required
-    MatchableResource resource_type = 4;
-
-    // Optional, org key applied to the attributes.
-    string org = 5;
-}
-
-// Response to get an individual workflow attribute override.
-message WorkflowAttributesGetResponse {
-    WorkflowAttributes attributes = 1;
-}
-
-// Request to delete a set matchable workflow attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message WorkflowAttributesDeleteRequest {
-    // Unique project id which this set of attributes references.
-    // +required
-    string project                 = 1;
-
-    // Unique domain id which this set of attributes references.
-    // +required
-    string domain                  = 2;
-
-    // Workflow name which this set of attributes references.
-    // +required
-    string workflow                = 3;
-
-    // Which type of matchable attributes to delete.
-    // +required
-    MatchableResource resource_type = 4;
-
-    // Optional, org key applied to the attributes.
-    string org = 5;
-}
-
-// Purposefully empty, may be populated in the future.
-message WorkflowAttributesDeleteResponse {
-}

package/protos/flyteidl/cacheservice/cacheservice.proto

@@ -1,143 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.cacheservice;
-
-import "flyteidl/core/literals.proto";
-import "flyteidl/core/types.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/interface.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/timestamp.proto";
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/cacheservice";
-
-/*
- * CacheService defines operations for cache management including retrieval, storage, and deletion of cached task/workflow outputs.
- */
-service CacheService {
-  // Retrieves cached data by key.
-  rpc Get (GetCacheRequest) returns (GetCacheResponse);
-
-  // Stores or updates cached data by key.
-  rpc Put (PutCacheRequest) returns (PutCacheResponse);
-
-  // Deletes cached data by key.
-  rpc Delete (DeleteCacheRequest) returns (DeleteCacheResponse);
-
-  // Get or extend a reservation for a cache key
-  rpc GetOrExtendReservation (GetOrExtendReservationRequest) returns (GetOrExtendReservationResponse);
-
-  // Release the reservation for a cache key
-  rpc ReleaseReservation (ReleaseReservationRequest) returns (ReleaseReservationResponse);
-}
-
-/*
- * Additional metadata as key-value pairs
- */
-message KeyMapMetadata {
-  map<string, string> values = 1; // Additional metadata as key-value pairs
-}
-
-/*
- * Metadata for cached outputs, including the source identifier and timestamps.
- */
-message Metadata {
-  core.Identifier source_identifier = 1; // Source task or workflow identifier
-  KeyMapMetadata key_map = 2; // Additional metadata as key-value pairs
-  google.protobuf.Timestamp created_at = 3; // Creation timestamp
-  google.protobuf.Timestamp last_updated_at = 4; // Last update timestamp
-}
-
-/*
- * Represents cached output, either as literals or an URI, with associated metadata.
- */
-message CachedOutput {
-  oneof output {
-    flyteidl.core.LiteralMap output_literals = 1; // Output literals
-    string output_uri = 2; // URI to output data
-  }
-  Metadata metadata = 3; // Associated metadata
-}
-
-/*
- * Request to retrieve cached data by key.
- */
-message GetCacheRequest {
-  string key = 1; // Cache key
-}
-
-/*
- * Response with cached data for a given key.
- */
-message GetCacheResponse {
-  CachedOutput output = 1; // Cached output
-}
-
-/*
- * Request to store/update cached data by key.
- */
-message PutCacheRequest {
-  string key = 1; // Cache key
-  CachedOutput output = 2; // Output to cache
-  bool overwrite = 3; // Overwrite flag
-}
-
-/*
- * Response message of cache store/update operation.
- */
-message PutCacheResponse {
-  // Empty, success indicated by no errors
-}
-
-/*
- * Request to delete cached data by key.
- */
-message DeleteCacheRequest {
-  string key = 1; // Cache key
-}
-
-/*
- * Response message of cache deletion operation.
- */
-message DeleteCacheResponse {
-  // Empty, success indicated by no errors
-}
-
-// A reservation including owner, heartbeat interval, expiration timestamp, and various metadata.
-message Reservation {
-  string key = 1; // The unique ID for the reservation - same as the cache key
-  string owner_id = 2; // The unique ID of the owner for the reservation
-  google.protobuf.Duration heartbeat_interval = 3; // Requested reservation extension heartbeat interval
-  google.protobuf.Timestamp expires_at = 4; // Expiration timestamp of this reservation
-}
-
-/*
- * Request to get or extend a reservation for a cache key
- */
-message GetOrExtendReservationRequest {
-  string key = 1; // The unique ID for the reservation - same as the cache key
-  string owner_id = 2; // The unique ID of the owner for the reservation
-  google.protobuf.Duration heartbeat_interval = 3; // Requested reservation extension heartbeat interval
-}
-
-/*
- * Request to get or extend a reservation for a cache key
- */
-message GetOrExtendReservationResponse {
-  Reservation reservation = 1; // The reservation that was created or extended
-}
-
-/*
- * Request to release the reservation for a cache key
- */
-message ReleaseReservationRequest {
-  string key = 1; // The unique ID for the reservation - same as the cache key
-  string owner_id = 2; // The unique ID of the owner for the reservation
-}
-
-/*
- * Response message of release reservation operation.
- */
-message ReleaseReservationResponse {
-  // Empty, success indicated by no errors
-}

package/protos/flyteidl/core/artifact_id.proto

@@ -1,112 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.core;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core";
-
-import "google/protobuf/timestamp.proto";
-import "flyteidl/core/identifier.proto";
-
-
-message ArtifactKey {
-  // Project and domain and suffix needs to be unique across a given artifact store.
-  string project = 1;
-  string domain = 2;
-  string name = 3;
-  string org = 4;
-}
-
-// Only valid for triggers
-message ArtifactBindingData {
-  reserved 1 to 4;
-  // These two fields are only relevant in the partition value case
-  oneof partition_data {
-    string partition_key = 5;
-    bool bind_to_time_partition = 6;
-  }
-
-  // This is only relevant in the time partition case
-  TimeTransform time_transform = 7;
-}
-
-enum Granularity {
-  UNSET = 0;
-  MINUTE = 1;
-  HOUR = 2;
-  DAY = 3; // default
-  MONTH = 4;
-}
-
-enum Operator {
-  MINUS = 0;
-  PLUS = 1;
-}
-
-message TimeTransform {
-  string transform = 1;
-  Operator op = 2;
-}
-
-message InputBindingData {
-  string var = 1;
-}
-
-message RuntimeBinding {}
-
-message LabelValue {
-  oneof value {
-    // The string static value is for use in the Partitions object
-    string static_value = 1;
-
-    // The time value is for use in the TimePartition case
-    google.protobuf.Timestamp time_value = 2;
-    ArtifactBindingData triggered_binding = 3;
-    InputBindingData input_binding = 4;
-    RuntimeBinding runtime_binding = 5;
-  }
-}
-
-message Partitions {
-  map<string, LabelValue> value = 1;
-}
-
-message TimePartition {
-  LabelValue value = 1;
-  Granularity granularity = 2;
-}
-
-message ArtifactID {
-  ArtifactKey artifact_key = 1;
-
-  string version = 2;
-
-  // Think of a partition as a tag on an Artifact, except it's a key-value pair.
-  // Different partitions naturally have different versions (execution ids).
-  Partitions partitions = 3;
-
-  // There is no such thing as an empty time partition - if it's not set, then there is no time partition.
-  TimePartition time_partition = 4;
-}
-
-message ArtifactTag {
-  ArtifactKey artifact_key = 1;
-
-  LabelValue value = 2;
-}
-
-// Uniqueness constraints for Artifacts
-//  - project, domain, name, version, partitions
-// Option 2 (tags are standalone, point to an individual artifact id):
-//  - project, domain, name, alias (points to one partition if partitioned)
-//  - project, domain, name, partition key, partition value
-message ArtifactQuery {
-  oneof identifier {
-    ArtifactID artifact_id = 1;
-    ArtifactTag artifact_tag = 2;
-    string uri = 3;
-
-    // This is used in the trigger case, where a user specifies a value for an input that is one of the triggering
-    // artifacts, or a partition value derived from a triggering artifact.
-    ArtifactBindingData binding = 4;
-  }
-}

package/protos/flyteidl/core/catalog.proto

@@ -1,63 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.core;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core";
-
-import "flyteidl/core/identifier.proto";
-
-// Indicates the status of CatalogCaching. The reason why this is not embedded in TaskNodeMetadata is, that we may use for other types of nodes as well in the future
-enum CatalogCacheStatus {
-  // Used to indicate that caching was disabled
-  CACHE_DISABLED = 0;
-  // Used to indicate that the cache lookup resulted in no matches
-  CACHE_MISS = 1;
-  // used to indicate that the associated artifact was a result of a previous execution
-  CACHE_HIT = 2;
-  // used to indicate that the resultant artifact was added to the cache
-  CACHE_POPULATED = 3;
-  // Used to indicate that cache lookup failed because of an error
-  CACHE_LOOKUP_FAILURE = 4;
-  // Used to indicate that cache lookup failed because of an error
-  CACHE_PUT_FAILURE = 5;
-  // Used to indicate the cache lookup was skipped
-  CACHE_SKIPPED = 6;
-  // Used to indicate that the cache was evicted
-  CACHE_EVICTED = 7;
-};
-
-message CatalogArtifactTag {
-     // Artifact ID is generated name
-     string artifact_id = 1;
-     // Flyte computes the tag automatically, as the hash of the values
-     string name = 2;
-};
-
-// Catalog artifact information with specific metadata
-message CatalogMetadata {
-    // Dataset ID in the catalog
-    Identifier dataset_id = 1;
-    // Artifact tag in the catalog
-    CatalogArtifactTag artifact_tag = 2;
-    // Optional: Source Execution identifier, if this dataset was generated by another execution in Flyte. This is a one-of field and will depend on the caching context
-    oneof source_execution {
-       // Today we only support TaskExecutionIdentifier as a source, as catalog caching only works for task executions
-       TaskExecutionIdentifier source_task_execution = 3;
-    }
-};
-
-message CatalogReservation {
-    // Indicates the status of a catalog reservation operation.
-    enum Status {
-      // Used to indicate that reservations are disabled
-      RESERVATION_DISABLED = 0;
-      // Used to indicate that a reservation was successfully acquired or extended
-      RESERVATION_ACQUIRED = 1;
-      // Used to indicate that an active reservation currently exists
-      RESERVATION_EXISTS = 2;
-      // Used to indicate that the reservation has been successfully released
-      RESERVATION_RELEASED = 3;
-      // Used to indicate that a reservation operation resulted in failure
-      RESERVATION_FAILURE = 4;
-    }
-}

package/protos/flyteidl/core/compiler.proto

@@ -1,64 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.core;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core";
-
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/interface.proto";
-import "flyteidl/core/workflow.proto";
-import "flyteidl/core/tasks.proto";
-
-// Adjacency list for the workflow. This is created as part of the compilation process. Every process after the compilation
-// step uses this created ConnectionSet
-message ConnectionSet {
-    message IdList {
-        repeated string ids = 1;
-    }
-
-    // A list of all the node ids that are downstream from a given node id
-    map<string, IdList> downstream = 7;
-
-    // A list of all the node ids, that are upstream of this node id
-    map<string, IdList> upstream = 8;
-}
-
-// Output of the compilation Step. This object represents one workflow. We store more metadata at this layer
-message CompiledWorkflow {
-    // Completely contained Workflow Template
-    WorkflowTemplate template = 1;
-    // For internal use only! This field is used by the system and must not be filled in. Any values set will be ignored.
-    ConnectionSet connections = 2;
-}
-
-// Output of the compilation step. This object represents one LaunchPlan. We store more metadata at this layer
-message CompiledLaunchPlan {
-    // Completely contained LaunchPlan Template
-    LaunchPlanTemplate template = 1;
-}
-
-// Output of the Compilation step. This object represent one Task. We store more metadata at this layer
-message CompiledTask {
-    // Completely contained TaskTemplate
-    TaskTemplate template = 1;
-}
-
-// A Compiled Workflow Closure contains all the information required to start a new execution, or to visualize a workflow
-// and its details. The CompiledWorkflowClosure should always contain a primary workflow, that is the main workflow that
-// will being the execution. All subworkflows are denormalized. WorkflowNodes refer to the workflow identifiers of
-// compiled subworkflows.
-message CompiledWorkflowClosure {
-    //+required
-    CompiledWorkflow primary = 1;
-    // Guaranteed that there will only exist one and only one workflow with a given id, i.e., every sub workflow has a
-    // unique identifier. Also every enclosed subworkflow is used either by a primary workflow or by a subworkflow
-    // as an inlined workflow
-    //+optional
-    repeated CompiledWorkflow sub_workflows = 2;
-    // Guaranteed that there will only exist one and only one task with a given id, i.e., every task has a unique id
-    //+required (at least 1)
-    repeated CompiledTask tasks = 3;
-    // A collection of launch plans that are compiled. Guaranteed that there will only exist one and only one launch plan
-    // with a given id, i.e., every launch plan has a unique id.
-    repeated CompiledLaunchPlan launch_plans = 4;
-}

package/protos/flyteidl/core/condition.proto

@@ -1,63 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.core;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core";
-
-import "flyteidl/core/literals.proto";
-
-// Defines a 2-level tree where the root is a comparison operator and Operands are primitives or known variables.
-// Each expression results in a boolean result.
-message ComparisonExpression {
-    // Binary Operator for each expression
-    enum Operator {
-        EQ = 0;
-        NEQ = 1;
-        // Greater Than
-        GT = 2;
-        GTE = 3;
-        // Less Than
-        LT = 4;
-        LTE = 5;
-    }
-
-    Operator operator = 1;
-    Operand left_value = 2;
-    Operand right_value = 3;
-}
-
-// Defines an operand to a comparison expression.
-message Operand {
-    oneof val {
-        // Can be a constant
-        core.Primitive primitive = 1 [deprecated = true];
-        // Or one of this node's input variables
-        string var = 2;
-        // Replace the primitive field
-        core.Scalar scalar = 3;
-    }
-}
-
-// Defines a boolean expression tree. It can be a simple or a conjunction expression.
-// Multiple expressions can be combined using a conjunction or a disjunction to result in a final boolean result.
-message BooleanExpression {
-    oneof expr {
-        ConjunctionExpression conjunction = 1;
-        ComparisonExpression comparison = 2;
-    }
-}
-
-// Defines a conjunction expression of two boolean expressions.
-message ConjunctionExpression {
-    // Nested conditions. They can be conjoined using AND / OR
-    // Order of evaluation is not important as the operators are Commutative
-    enum LogicalOperator {
-        // Conjunction
-        AND = 0;
-        OR = 1;
-    }
-
-    LogicalOperator operator = 1;
-    BooleanExpression left_expression = 2;
-    BooleanExpression right_expression = 3;
-}

package/protos/flyteidl/core/dynamic_job.proto

@@ -1,32 +0,0 @@
-syntax = "proto3";
-
-import "flyteidl/core/tasks.proto";
-import "flyteidl/core/workflow.proto";
-import "flyteidl/core/literals.proto";
-
-package flyteidl.core;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/core";
-
-// Describes a set of tasks to execute and how the final outputs are produced.
-message DynamicJobSpec {
-    // A collection of nodes to execute.
-    repeated Node nodes = 1;
-
-    // An absolute number of successful completions of nodes required to mark this job as succeeded. As soon as this
-    // criteria is met, the dynamic job will be marked as successful and outputs will be computed. If this number
-    // becomes impossible to reach (e.g. number of currently running tasks + number of already succeeded tasks <
-    // min_successes) the task will be aborted immediately and marked as failed. The default value of this field, if not
-    // specified, is the count of nodes repeated field.
-    int64 min_successes = 2;
-
-    // Describes how to bind the final output of the dynamic job from the outputs of executed nodes. The referenced ids
-    // in bindings should have the generated id for the subtask.
-    repeated Binding outputs = 3;
-
-    // [Optional] A complete list of task specs referenced in nodes.
-    repeated TaskTemplate tasks = 4;
-
-    // [Optional] A complete list of task specs referenced in nodes.
-    repeated WorkflowTemplate subworkflows = 5;
-}