@flyteorg/flyteidl 1.16.0 → 2.0.0-test1

package/protos/flyteidl/admin/notification.proto

@@ -1,27 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-// Represents the Email object that is sent to a publisher/subscriber
-// to forward the notification.
-// Note: This is internal to Admin and doesn't need to be exposed to other components.
-message EmailMessage {
-    // The list of email addresses to receive an email with the content populated in the other fields.
-    // Currently, each email recipient will receive its own email.
-    // This populates the TO field.
-    repeated string recipients_email = 1;
-
-    // The email of the sender.
-    // This populates the FROM field.
-    string sender_email = 2;
-
-    // The content of the subject line.
-    // This populates the SUBJECT field.
-    string subject_line = 3;
-
-    // The content of the email body.
-    // This populates the BODY field.
-    string body = 4;
-}

package/protos/flyteidl/admin/project.proto

@@ -1,132 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-
-import "flyteidl/admin/common.proto";
-
-// Empty request for GetDomain
-message GetDomainRequest {}
-
-// Namespace within a project commonly used to differentiate between different service instances.
-// e.g. "production", "development", etc.
-message Domain {
-    // Globally unique domain name.
-    string id    = 1;
-
-    // Display name.
-    string name  = 2;
-}
-
-// Represents a list of domains.
-message GetDomainsResponse {
-    repeated Domain domains = 1;
-}
-
-// Top-level namespace used to classify different entities like workflows and executions.
-message Project {
-    // Globally unique project name.
-    string id               = 1;
-
-    // Display name.
-    string name             = 2;
-
-    repeated Domain domains = 3;
-
-    string description      = 4;
-
-    // Leverage Labels from flyteidl.admin.common.proto to
-    // tag projects with ownership information.
-    Labels labels = 5;
-
-    // The state of the project is used to control its visibility in the UI and validity.
-    enum ProjectState {
-        // By default, all projects are considered active.
-        ACTIVE = 0;
-
-        // Archived projects are no longer visible in the UI and no longer valid.
-        ARCHIVED = 1;
-
-        // System generated projects that aren't explicitly created or managed by a user.
-        SYSTEM_GENERATED = 2;
-
-        // System archived projects that aren't explicitly archived by a user.
-        SYSTEM_ARCHIVED = 3;
-    }
-    ProjectState state = 6;
-
-    // Optional, org key applied to the resource.
-    string org = 7;
-}
-
-// Represents a list of projects.
-// See :ref:`ref_flyteidl.admin.Project` for more details
-message Projects {
-    repeated Project projects = 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;
-}
-
-// Request to retrieve a list of projects matching specified filters. 
-// See :ref:`ref_flyteidl.admin.Project` for more details
-message ProjectListRequest {
-    // Indicates the number of projects to be returned.
-    // +required
-    uint32 limit    = 1;
-
-    // In the case of multiple pages of results, this server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token    = 2;
-
-    // Indicates a list of filters passed as string.
-    // More info on constructing filters : <Link>
-    // +optional
-    string filters  = 3;
-
-    // Sort ordering.
-    // +optional
-    Sort sort_by    = 4;
-
-    // Optional, org filter applied to list project requests.
-    string org = 5;
-}
-
-// Adds a new user-project within the Flyte deployment.
-// See :ref:`ref_flyteidl.admin.Project` for more details
-message ProjectRegisterRequest {
-    // +required
-    Project project                       = 1;
-}
-
-// Purposefully empty, may be updated in the future.
-message ProjectRegisterResponse {
-}
-
-// Purposefully empty, may be updated in the future.
-message ProjectUpdateResponse {
-}
-
-message ProjectGetRequest {
-    // Indicates a unique project.
-    // +required
-    string id = 1;
-
-    // Optional, org key applied to the resource.
-    string org = 2;
-}
-
-
-// Error returned for inactive projects
-message InactiveProject {
-    // Indicates a unique project.
-    // +required
-    string id = 1;
-
-    // Optional, org key applied to the resource.
-    string org = 2;
-}
-

package/protos/flyteidl/admin/project_attributes.proto

@@ -1,69 +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 at the project level.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectAttributes {
-    // Unique project id for which this set of attributes will be applied.
-    string project = 1;
-
-    MatchingAttributes matching_attributes = 2;
-
-    // Optional, org key applied to the project.
-    string org = 3;
-}
-
-// Sets custom attributes for a project
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectAttributesUpdateRequest {
-    // +required
-    ProjectAttributes attributes = 1;
-}
-
-// Purposefully empty, may be populated in the future.
-message ProjectAttributesUpdateResponse {
-}
-
-// Request to get an individual project level attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectAttributesGetRequest {
-    // Unique project id which this set of attributes references.
-    // +required
-    string project = 1;
-
-    // Which type of matchable attributes to return.
-    // +required
-    MatchableResource resource_type = 2;
-
-    // Optional, org key applied to the project.
-    string org = 3;
-}
-
-// Response to get an individual project level attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectAttributesGetResponse {
-  ProjectAttributes attributes = 1;
-}
-
-// Request to delete a set matchable project level attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectAttributesDeleteRequest {
-    // Unique project id which this set of attributes references.
-    // +required
-    string project = 1;
-
-    // Which type of matchable attributes to delete.
-    // +required
-    MatchableResource resource_type = 2;
-
-    // Optional, org key applied to the project.
-    string org = 3;
-}
-
-// Purposefully empty, may be populated in the future.
-message ProjectAttributesDeleteResponse {
-}

package/protos/flyteidl/admin/project_domain_attributes.proto

@@ -1,80 +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 and domain.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectDomainAttributes {
-    // 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;
-
-    MatchingAttributes matching_attributes = 3;
-
-    // Optional, org key applied to the attributes.
-    string org = 4;
-}
-
-// Sets custom attributes for a project-domain combination.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectDomainAttributesUpdateRequest {
-    // +required
-    ProjectDomainAttributes attributes = 1;
-}
-
-// Purposefully empty, may be populated in the future.
-message ProjectDomainAttributesUpdateResponse {
-}
-
-// Request to get an individual project domain attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectDomainAttributesGetRequest {
-    // 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;
-
-    // Which type of matchable attributes to return.
-    // +required
-    MatchableResource resource_type = 3;
-
-    // Optional, org key applied to the attributes.
-    string org = 4;
-}
-
-// Response to get an individual project domain attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectDomainAttributesGetResponse {
-  ProjectDomainAttributes attributes = 1;
-}
-
-// Request to delete a set matchable project domain attribute override.
-// For more info on matchable attributes, see :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration`
-message ProjectDomainAttributesDeleteRequest {
-    // 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;
-
-    // Which type of matchable attributes to delete.
-    // +required
-    MatchableResource resource_type = 3;
-
-    // Optional, org key applied to the attributes.
-    string org = 4;
-}
-
-// Purposefully empty, may be populated in the future.
-message ProjectDomainAttributesDeleteResponse {
-}

package/protos/flyteidl/admin/schedule.proto

@@ -1,43 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-// Represents a frequency at which to run a schedule.
-enum FixedRateUnit {
-    MINUTE = 0;
-    HOUR = 1;
-    DAY = 2;
-}
-
-// Option for schedules run at a certain frequency e.g. every 2 minutes.
-message FixedRate {
-    uint32 value = 1;
-    FixedRateUnit unit = 2;
-}
-
-// Options for schedules to run according to a cron expression.
-message CronSchedule {
-    // Standard/default cron implementation as described by https://en.wikipedia.org/wiki/Cron#CRON_expression;
-    // Also supports nonstandard predefined scheduling definitions
-    // as described by https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
-    // except @reboot
-    string schedule = 1;
-    // ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations
-    string offset = 2;
-}
-
-// Defines complete set of information required to trigger an execution on a schedule.
-message Schedule {
-
-    oneof ScheduleExpression {
-        // Uses AWS syntax: Minutes Hours Day-of-month Month Day-of-week Year
-        // e.g. for a schedule that runs every 15 minutes: 0/15 * * * ? *
-        string cron_expression = 1 [deprecated=true];
-        FixedRate rate = 2;
-        CronSchedule cron_schedule = 4;
-    }
-
-    // Name of the input variable that the kickoff time will be supplied to when the workflow is kicked off.
-    string kickoff_time_input_arg = 3;
-}

package/protos/flyteidl/admin/signal.proto

@@ -1,86 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/admin/common.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/literals.proto";
-import "flyteidl/core/types.proto";
-
-// SignalGetOrCreateRequest represents a request structure to retrieve or create a signal.
-// See :ref:`ref_flyteidl.admin.Signal` for more details
-message SignalGetOrCreateRequest {
-    // A unique identifier for the requested signal.
-    core.SignalIdentifier id = 1;
-
-    // A type denoting the required value type for this signal.
-    core.LiteralType type = 2;
-}
-
-// SignalListRequest represents a request structure to retrieve a collection of signals.
-// See :ref:`ref_flyteidl.admin.Signal` for more details
-message SignalListRequest {
-    // Indicates the workflow execution to filter by.
-    // +required
-    core.WorkflowExecutionIdentifier workflow_execution_id = 1;
-
-    // Indicates the number of resources to be returned.
-    // +required
-    uint32 limit = 2;
-
-    // In the case of multiple pages of results, the, server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token = 3;
-
-    // Indicates a list of filters passed as string.
-    // +optional
-    string filters = 4;
-
-    // Sort ordering.
-    // +optional
-    Sort sort_by = 5;
-}
-
-// SignalList represents collection of signals along with the token of the last result.
-// See :ref:`ref_flyteidl.admin.Signal` for more details
-message SignalList {
-    // A list of signals matching the input filters.
-    repeated Signal signals = 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;
-}
-
-// SignalSetRequest represents a request structure to set the value on a signal. Setting a signal
-// effetively satisfies the signal condition within a Flyte workflow.
-// See :ref:`ref_flyteidl.admin.Signal` for more details
-message SignalSetRequest {
-    // A unique identifier for the requested signal.
-    core.SignalIdentifier id = 1;    
-
-    // The value of this signal, must match the defining signal type.
-    core.Literal value = 2;
-}
-
-// SignalSetResponse represents a response structure if signal setting succeeds.
-message SignalSetResponse {
-    // Purposefully empty, may be populated in the future.
-}
-
-// Signal encapsulates a unique identifier, associated metadata, and a value for a single Flyte
-// signal. Signals may exist either without a set value (representing a signal request) or with a
-// populated value (indicating the signal has been given).
-message Signal {
-    // A unique identifier for the requested signal.
-    core.SignalIdentifier id = 1;
-
-    // A type denoting the required value type for this signal.
-    core.LiteralType type = 2;
-
-    // The value of the signal. This is only available if the signal has been "set" and must match
-    // the defined the type.
-    core.Literal value = 3;
-}

package/protos/flyteidl/admin/task.proto

@@ -1,71 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/tasks.proto";
-import "flyteidl/core/compiler.proto";
-import "flyteidl/admin/description_entity.proto";
-import "google/protobuf/timestamp.proto";
-
-// Represents a request structure to create a revision of a task.
-// See :ref:`ref_flyteidl.admin.Task` for more details
-message TaskCreateRequest {
-    // id represents the unique identifier of the task.
-    // +required
-    core.Identifier id           = 1;
-    
-    // Represents the specification for task.
-    // +required
-    TaskSpec spec                = 2;
-}
-
-// Represents a response structure if task creation succeeds.
-message TaskCreateResponse {
-    // Purposefully empty, may be populated in the future.
-}
-
-// Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks
-// arranged to process workflow inputs and produce a deterministic set of outputs.
-// Tasks can come in many varieties tuned for specialized behavior. 
-message Task {
-    // id represents the unique identifier of the task.
-    core.Identifier id       = 1;
-
-    // closure encapsulates all the fields that maps to a compiled version of the task.
-    TaskClosure closure      = 2;
-
-    // One-liner overview of the entity.
-    string short_description = 3;
-}
-
-// Represents a list of tasks returned from the admin.
-// See :ref:`ref_flyteidl.admin.Task` for more details
-message TaskList {
-    // A list of tasks returned based on the request.
-    repeated Task tasks = 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 user-configured specification of the task.
-message TaskSpec {
-    // Template of the task that encapsulates all the metadata of the task.
-    core.TaskTemplate template = 1;
-
-    // Represents the specification for description entity.
-    DescriptionEntity description        = 2;
-}
-
-// Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data
-// and task metadata.
-message TaskClosure {
-    // Represents the compiled representation of the task from the specification provided.
-    core.CompiledTask compiled_task = 1;
-        
-    // Time at which the task was created.
-    google.protobuf.Timestamp created_at = 2;
-}

package/protos/flyteidl/admin/task_execution.proto

@@ -1,171 +0,0 @@
-syntax = "proto3";
-
-package flyteidl.admin;
-option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/admin";
-
-import "flyteidl/admin/common.proto";
-import "flyteidl/core/execution.proto";
-import "flyteidl/core/identifier.proto";
-import "flyteidl/core/literals.proto";
-import "flyteidl/event/event.proto";
-import "google/protobuf/timestamp.proto";
-import "google/protobuf/duration.proto";
-import "google/protobuf/struct.proto";
-
-// A message used to fetch a single task execution entity.
-// See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-message TaskExecutionGetRequest {
-    // Unique identifier for the task execution.
-    // +required
-    core.TaskExecutionIdentifier id = 1;
-}
-
-// Represents a request structure to retrieve a list of task execution entities yielded by a specific node execution.
-// See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-message TaskExecutionListRequest {
-    // Indicates the node execution to filter by.
-    // +required
-    core.NodeExecutionIdentifier node_execution_id = 1;
-
-    // Indicates the number of resources to be returned.
-    // +required
-    uint32 limit    = 2;
-
-    // In the case of multiple pages of results, the server-provided token can be used to fetch the next page
-    // in a query.
-    // +optional
-    string token    = 3;
-
-    // Indicates a list of filters passed as string.
-    // More info on constructing filters : <Link>
-    // +optional
-    string filters  = 4;
-
-    // Sort ordering for returned list.
-    // +optional
-    Sort sort_by    = 5;
-}
-
-// Encapsulates all details for a single task execution entity.
-// A task execution represents an instantiated task, including all inputs and additional
-// metadata as well as computed results included state, outputs, and duration-based attributes.
-message TaskExecution {
-    // Unique identifier for the task execution.
-    core.TaskExecutionIdentifier id = 1;
-
-    // Path to remote data store where input blob is stored.
-    string input_uri                       = 2;
-
-    // Task execution details and results.
-    TaskExecutionClosure closure           = 3;
-
-    // Whether this task spawned nodes.
-    bool is_parent                         = 4;
-}
-
-// Response structure for a query to list of task execution entities.
-// See :ref:`ref_flyteidl.admin.TaskExecution` for more details
-message TaskExecutionList {
-    repeated TaskExecution task_executions = 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;
-}
-
-// Container for task execution details and results.
-message TaskExecutionClosure {
-    oneof output_result {
-        // Path to remote data store where output blob is stored if the execution succeeded (and produced outputs).
-        // DEPRECATED. Use GetTaskExecutionData to fetch output data instead.
-        string output_uri                  = 1 [deprecated = true];
-
-        // Error information for the task execution. Populated if the execution failed.
-        core.ExecutionError error          = 2;
-
-        // Raw output data produced by this task execution.
-        // DEPRECATED. Use GetTaskExecutionData to fetch output data instead.
-        core.LiteralMap output_data        = 12 [deprecated = true];
-    }
-
-    // The last recorded phase for this task execution.
-    core.TaskExecution.Phase phase          = 3;
-
-    // Detailed log information output by the task execution.
-    repeated core.TaskLog logs = 4;
-
-    // Time at which the task execution began running.
-    google.protobuf.Timestamp started_at   = 5;
-
-    // The amount of time the task execution spent running.
-    google.protobuf.Duration duration      = 6;
-
-    // Time at which the task execution was created.
-    google.protobuf.Timestamp created_at   = 7;
-
-    // Time at which the task execution was last updated.
-    google.protobuf.Timestamp updated_at   = 8;
-
-    // Custom data specific to the task plugin.
-    google.protobuf.Struct custom_info     = 9;
-
-    // If there is an explanation for the most recent phase transition, the reason will capture it.
-    string reason                         = 10;
-
-    // A predefined yet extensible Task type identifier.
-    string task_type                      = 11;
-
-    // Metadata around how a task was executed.
-    event.TaskExecutionMetadata metadata  = 16;
-
-    // The event version is used to indicate versioned changes in how data is maintained using this
-    // proto message. For example, event_verison > 0 means that maps tasks logs use the
-    // TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
-    // in this message.
-    int32 event_version = 17;
-
-    // A time-series of the phase transition or update explanations. This, when compared to storing a singular reason
-    // as previously done, is much more valuable in visualizing and understanding historical evaluations.
-    repeated Reason reasons = 18;
-
-    // Contains metadata required to identify logs related to this task execution
-    core.LogContext log_context = 19;
-}
-
-// Reason is a single message annotated with a timestamp to indicate the instant the reason occurred.
-message Reason {
-    // occurred_at is the timestamp indicating the instant that this reason happened.
-    google.protobuf.Timestamp occurred_at = 1;
-
-    // message is the explanation for the most recent phase transition or status update.
-    string message = 2;
-}
-
-// Request structure to fetch inputs and output for a task execution.
-// By default this data is not returned inline in :ref:`ref_flyteidl.admin.TaskExecutionGetRequest`
-message TaskExecutionGetDataRequest {
-    // The identifier of the task execution for which to fetch inputs and outputs.
-    // +required
-    core.TaskExecutionIdentifier id        = 1;
-}
-
-// Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.
-message TaskExecutionGetDataResponse {
-    // Signed url to fetch a core.LiteralMap of task execution inputs.
-    // Deprecated: Please use full_inputs instead.
-    UrlBlob inputs                             = 1 [deprecated = true];
-
-    // Signed url to fetch a core.LiteralMap of task execution outputs.
-    // Deprecated: Please use full_outputs instead.
-    UrlBlob outputs                            = 2 [deprecated = true];
-
-    // Full_inputs will only be populated if they are under a configured size threshold.
-    core.LiteralMap full_inputs                = 3;
-
-    // Full_outputs will only be populated if they are under a configured size threshold.
-    core.LiteralMap full_outputs               = 4;
-
-    // flyte tiny url to fetch a core.LiteralMap of task execution's IO
-    // Deck will be empty for task
-    FlyteURLs flyte_urls = 5;
-}