@flyteorg/flyteidl2 2.0.0-alpha10

package/flyteidl2/core/identifier_pb.ts

@@ -0,0 +1,237 @@
+// @generated by protoc-gen-es v2.2.5 with parameter "target=ts,import_extension=.ts"
+// @generated from file flyteidl2/core/identifier.proto (package flyteidl2.core, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file flyteidl2/core/identifier.proto.
+ */
+export const file_flyteidl2_core_identifier: GenFile = /*@__PURE__*/
+  fileDesc("Ch9mbHl0ZWlkbDIvY29yZS9pZGVudGlmaWVyLnByb3RvEg5mbHl0ZWlkbDIuY29yZSKOAQoKSWRlbnRpZmllchIzCg1yZXNvdXJjZV90eXBlGAEgASgOMhwuZmx5dGVpZGwyLmNvcmUuUmVzb3VyY2VUeXBlEg8KB3Byb2plY3QYAiABKAkSDgoGZG9tYWluGAMgASgJEgwKBG5hbWUYBCABKAkSDwoHdmVyc2lvbhgFIAEoCRILCgNvcmcYBiABKAkiWQobV29ya2Zsb3dFeGVjdXRpb25JZGVudGlmaWVyEg8KB3Byb2plY3QYASABKAkSDgoGZG9tYWluGAIgASgJEgwKBG5hbWUYBCABKAkSCwoDb3JnGAUgASgJIm0KF05vZGVFeGVjdXRpb25JZGVudGlmaWVyEg8KB25vZGVfaWQYASABKAkSQQoMZXhlY3V0aW9uX2lkGAIgASgLMisuZmx5dGVpZGwyLmNvcmUuV29ya2Zsb3dFeGVjdXRpb25JZGVudGlmaWVyIqEBChdUYXNrRXhlY3V0aW9uSWRlbnRpZmllchIrCgd0YXNrX2lkGAEgASgLMhouZmx5dGVpZGwyLmNvcmUuSWRlbnRpZmllchJCChFub2RlX2V4ZWN1dGlvbl9pZBgCIAEoCzInLmZseXRlaWRsMi5jb3JlLk5vZGVFeGVjdXRpb25JZGVudGlmaWVyEhUKDXJldHJ5X2F0dGVtcHQYAyABKA0iaAoQU2lnbmFsSWRlbnRpZmllchIRCglzaWduYWxfaWQYASABKAkSQQoMZXhlY3V0aW9uX2lkGAIgASgLMisuZmx5dGVpZGwyLmNvcmUuV29ya2Zsb3dFeGVjdXRpb25JZGVudGlmaWVyKlUKDFJlc291cmNlVHlwZRIPCgtVTlNQRUNJRklFRBAAEggKBFRBU0sQARIMCghXT1JLRkxPVxACEg8KC0xBVU5DSF9QTEFOEAMSCwoHREFUQVNFVBAEQrQBChJjb20uZmx5dGVpZGwyLmNvcmVCD0lkZW50aWZpZXJQcm90b0gCUAFaMmdpdGh1Yi5jb20vZmx5dGVvcmcvZmx5dGUvdjIvZ2VuL2dvL2ZseXRlaWRsMi9jb3JlogIDRkNYqgIORmx5dGVpZGwyLkNvcmXKAg5GbHl0ZWlkbDJcQ29yZeICGkZseXRlaWRsMlxDb3JlXEdQQk1ldGFkYXRh6gIPRmx5dGVpZGwyOjpDb3JlYgZwcm90bzM");
+
+/**
+ * Encapsulation of fields that uniquely identifies a Flyte resource.
+ *
+ * @generated from message flyteidl2.core.Identifier
+ */
+export type Identifier = Message<"flyteidl2.core.Identifier"> & {
+  /**
+   * Identifies the specific type of resource that this identifier corresponds to.
+   *
+   * @generated from field: flyteidl2.core.ResourceType resource_type = 1;
+   */
+  resourceType: ResourceType;
+
+  /**
+   * Name of the project the resource belongs to.
+   *
+   * @generated from field: string project = 2;
+   */
+  project: string;
+
+  /**
+   * Name of the domain the resource belongs to.
+   * A domain can be considered as a subset within a specific project.
+   *
+   * @generated from field: string domain = 3;
+   */
+  domain: string;
+
+  /**
+   * User provided value for the resource.
+   *
+   * @generated from field: string name = 4;
+   */
+  name: string;
+
+  /**
+   * Specific version of the resource.
+   *
+   * @generated from field: string version = 5;
+   */
+  version: string;
+
+  /**
+   * Optional, org key applied to the resource.
+   *
+   * @generated from field: string org = 6;
+   */
+  org: string;
+};
+
+/**
+ * Describes the message flyteidl2.core.Identifier.
+ * Use `create(IdentifierSchema)` to create a new message.
+ */
+export const IdentifierSchema: GenMessage<Identifier> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_identifier, 0);
+
+/**
+ * Encapsulation of fields that uniquely identifies a Flyte workflow execution
+ *
+ * @generated from message flyteidl2.core.WorkflowExecutionIdentifier
+ */
+export type WorkflowExecutionIdentifier = Message<"flyteidl2.core.WorkflowExecutionIdentifier"> & {
+  /**
+   * Name of the project the resource belongs to.
+   *
+   * @generated from field: string project = 1;
+   */
+  project: string;
+
+  /**
+   * Name of the domain the resource belongs to.
+   * A domain can be considered as a subset within a specific project.
+   *
+   * @generated from field: string domain = 2;
+   */
+  domain: string;
+
+  /**
+   * User or system provided value for the resource.
+   *
+   * @generated from field: string name = 4;
+   */
+  name: string;
+
+  /**
+   * Optional, org key applied to the resource.
+   *
+   * @generated from field: string org = 5;
+   */
+  org: string;
+};
+
+/**
+ * Describes the message flyteidl2.core.WorkflowExecutionIdentifier.
+ * Use `create(WorkflowExecutionIdentifierSchema)` to create a new message.
+ */
+export const WorkflowExecutionIdentifierSchema: GenMessage<WorkflowExecutionIdentifier> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_identifier, 1);
+
+/**
+ * Encapsulation of fields that identify a Flyte node execution entity.
+ *
+ * @generated from message flyteidl2.core.NodeExecutionIdentifier
+ */
+export type NodeExecutionIdentifier = Message<"flyteidl2.core.NodeExecutionIdentifier"> & {
+  /**
+   * @generated from field: string node_id = 1;
+   */
+  nodeId: string;
+
+  /**
+   * @generated from field: flyteidl2.core.WorkflowExecutionIdentifier execution_id = 2;
+   */
+  executionId?: WorkflowExecutionIdentifier;
+};
+
+/**
+ * Describes the message flyteidl2.core.NodeExecutionIdentifier.
+ * Use `create(NodeExecutionIdentifierSchema)` to create a new message.
+ */
+export const NodeExecutionIdentifierSchema: GenMessage<NodeExecutionIdentifier> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_identifier, 2);
+
+/**
+ * Encapsulation of fields that identify a Flyte task execution entity.
+ *
+ * @generated from message flyteidl2.core.TaskExecutionIdentifier
+ */
+export type TaskExecutionIdentifier = Message<"flyteidl2.core.TaskExecutionIdentifier"> & {
+  /**
+   * @generated from field: flyteidl2.core.Identifier task_id = 1;
+   */
+  taskId?: Identifier;
+
+  /**
+   * @generated from field: flyteidl2.core.NodeExecutionIdentifier node_execution_id = 2;
+   */
+  nodeExecutionId?: NodeExecutionIdentifier;
+
+  /**
+   * @generated from field: uint32 retry_attempt = 3;
+   */
+  retryAttempt: number;
+};
+
+/**
+ * Describes the message flyteidl2.core.TaskExecutionIdentifier.
+ * Use `create(TaskExecutionIdentifierSchema)` to create a new message.
+ */
+export const TaskExecutionIdentifierSchema: GenMessage<TaskExecutionIdentifier> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_identifier, 3);
+
+/**
+ * Encapsulation of fields the uniquely identify a signal.
+ *
+ * @generated from message flyteidl2.core.SignalIdentifier
+ */
+export type SignalIdentifier = Message<"flyteidl2.core.SignalIdentifier"> & {
+  /**
+   * Unique identifier for a signal.
+   *
+   * @generated from field: string signal_id = 1;
+   */
+  signalId: string;
+
+  /**
+   * Identifies the Flyte workflow execution this signal belongs to.
+   *
+   * @generated from field: flyteidl2.core.WorkflowExecutionIdentifier execution_id = 2;
+   */
+  executionId?: WorkflowExecutionIdentifier;
+};
+
+/**
+ * Describes the message flyteidl2.core.SignalIdentifier.
+ * Use `create(SignalIdentifierSchema)` to create a new message.
+ */
+export const SignalIdentifierSchema: GenMessage<SignalIdentifier> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_identifier, 4);
+
+/**
+ * Indicates a resource type within Flyte.
+ *
+ * @generated from enum flyteidl2.core.ResourceType
+ */
+export enum ResourceType {
+  /**
+   * @generated from enum value: UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: TASK = 1;
+   */
+  TASK = 1,
+
+  /**
+   * @generated from enum value: WORKFLOW = 2;
+   */
+  WORKFLOW = 2,
+
+  /**
+   * @generated from enum value: LAUNCH_PLAN = 3;
+   */
+  LAUNCH_PLAN = 3,
+
+  /**
+   * A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.
+   * Eventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI  and CLI to act on the objects
+   * in a similar manner to other Flyte objects
+   *
+   * @generated from enum value: DATASET = 4;
+   */
+  DATASET = 4,
+}
+
+/**
+ * Describes the enum flyteidl2.core.ResourceType.
+ */
+export const ResourceTypeSchema: GenEnum<ResourceType> = /*@__PURE__*/
+  enumDesc(file_flyteidl2_core_identifier, 0);
+

package/flyteidl2/core/interface_pb.ts

@@ -0,0 +1,187 @@
+// @generated by protoc-gen-es v2.2.5 with parameter "target=ts,import_extension=.ts"
+// @generated from file flyteidl2/core/interface.proto (package flyteidl2.core, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1";
+import type { ArtifactID, ArtifactQuery, ArtifactTag } from "./artifact_id_pb.ts";
+import { file_flyteidl2_core_artifact_id } from "./artifact_id_pb.ts";
+import type { Literal } from "./literals_pb.ts";
+import { file_flyteidl2_core_literals } from "./literals_pb.ts";
+import type { LiteralType } from "./types_pb.ts";
+import { file_flyteidl2_core_types } from "./types_pb.ts";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file flyteidl2/core/interface.proto.
+ */
+export const file_flyteidl2_core_interface: GenFile = /*@__PURE__*/
+  fileDesc("Ch5mbHl0ZWlkbDIvY29yZS9pbnRlcmZhY2UucHJvdG8SDmZseXRlaWRsMi5jb3JlIrYBCghWYXJpYWJsZRIpCgR0eXBlGAEgASgLMhsuZmx5dGVpZGwyLmNvcmUuTGl0ZXJhbFR5cGUSEwoLZGVzY3JpcHRpb24YAiABKAkSNwoTYXJ0aWZhY3RfcGFydGlhbF9pZBgDIAEoCzIaLmZseXRlaWRsMi5jb3JlLkFydGlmYWN0SUQSMQoMYXJ0aWZhY3RfdGFnGAQgASgLMhsuZmx5dGVpZGwyLmNvcmUuQXJ0aWZhY3RUYWcimAEKC1ZhcmlhYmxlTWFwEj0KCXZhcmlhYmxlcxgBIAMoCzIqLmZseXRlaWRsMi5jb3JlLlZhcmlhYmxlTWFwLlZhcmlhYmxlc0VudHJ5GkoKDlZhcmlhYmxlc0VudHJ5EgsKA2tleRgBIAEoCRInCgV2YWx1ZRgCIAEoCzIYLmZseXRlaWRsMi5jb3JlLlZhcmlhYmxlOgI4ASJrCg5UeXBlZEludGVyZmFjZRIrCgZpbnB1dHMYASABKAsyGy5mbHl0ZWlkbDIuY29yZS5WYXJpYWJsZU1hcBIsCgdvdXRwdXRzGAIgASgLMhsuZmx5dGVpZGwyLmNvcmUuVmFyaWFibGVNYXAi6gEKCVBhcmFtZXRlchIlCgN2YXIYASABKAsyGC5mbHl0ZWlkbDIuY29yZS5WYXJpYWJsZRIqCgdkZWZhdWx0GAIgASgLMhcuZmx5dGVpZGwyLmNvcmUuTGl0ZXJhbEgAEhIKCHJlcXVpcmVkGAMgASgISAASNwoOYXJ0aWZhY3RfcXVlcnkYBCABKAsyHS5mbHl0ZWlkbDIuY29yZS5BcnRpZmFjdFF1ZXJ5SAASMQoLYXJ0aWZhY3RfaWQYBSABKAsyGi5mbHl0ZWlkbDIuY29yZS5BcnRpZmFjdElESABCCgoIYmVoYXZpb3IingEKDFBhcmFtZXRlck1hcBJACgpwYXJhbWV0ZXJzGAEgAygLMiwuZmx5dGVpZGwyLmNvcmUuUGFyYW1ldGVyTWFwLlBhcmFtZXRlcnNFbnRyeRpMCg9QYXJhbWV0ZXJzRW50cnkSCwoDa2V5GAEgASgJEigKBXZhbHVlGAIgASgLMhkuZmx5dGVpZGwyLmNvcmUuUGFyYW1ldGVyOgI4AUKzAQoSY29tLmZseXRlaWRsMi5jb3JlQg5JbnRlcmZhY2VQcm90b0gCUAFaMmdpdGh1Yi5jb20vZmx5dGVvcmcvZmx5dGUvdjIvZ2VuL2dvL2ZseXRlaWRsMi9jb3JlogIDRkNYqgIORmx5dGVpZGwyLkNvcmXKAg5GbHl0ZWlkbDJcQ29yZeICGkZseXRlaWRsMlxDb3JlXEdQQk1ldGFkYXRh6gIPRmx5dGVpZGwyOjpDb3JlYgZwcm90bzM", [file_flyteidl2_core_artifact_id, file_flyteidl2_core_literals, file_flyteidl2_core_types]);
+
+/**
+ * Defines a strongly typed variable.
+ *
+ * @generated from message flyteidl2.core.Variable
+ */
+export type Variable = Message<"flyteidl2.core.Variable"> & {
+  /**
+   * Variable literal type.
+   *
+   * @generated from field: flyteidl2.core.LiteralType type = 1;
+   */
+  type?: LiteralType;
+
+  /**
+   * +optional string describing input variable
+   *
+   * @generated from field: string description = 2;
+   */
+  description: string;
+
+  /**
+   * +optional This object allows the user to specify how Artifacts are created.
+   * name, tag, partitions can be specified. The other fields (version and project/domain) are ignored.
+   *
+   * @generated from field: flyteidl2.core.ArtifactID artifact_partial_id = 3;
+   */
+  artifactPartialId?: ArtifactID;
+
+  /**
+   * @generated from field: flyteidl2.core.ArtifactTag artifact_tag = 4;
+   */
+  artifactTag?: ArtifactTag;
+};
+
+/**
+ * Describes the message flyteidl2.core.Variable.
+ * Use `create(VariableSchema)` to create a new message.
+ */
+export const VariableSchema: GenMessage<Variable> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_interface, 0);
+
+/**
+ * A map of Variables
+ *
+ * @generated from message flyteidl2.core.VariableMap
+ */
+export type VariableMap = Message<"flyteidl2.core.VariableMap"> & {
+  /**
+   * Defines a map of variable names to variables.
+   *
+   * @generated from field: map<string, flyteidl2.core.Variable> variables = 1;
+   */
+  variables: { [key: string]: Variable };
+};
+
+/**
+ * Describes the message flyteidl2.core.VariableMap.
+ * Use `create(VariableMapSchema)` to create a new message.
+ */
+export const VariableMapSchema: GenMessage<VariableMap> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_interface, 1);
+
+/**
+ * Defines strongly typed inputs and outputs.
+ *
+ * @generated from message flyteidl2.core.TypedInterface
+ */
+export type TypedInterface = Message<"flyteidl2.core.TypedInterface"> & {
+  /**
+   * @generated from field: flyteidl2.core.VariableMap inputs = 1;
+   */
+  inputs?: VariableMap;
+
+  /**
+   * @generated from field: flyteidl2.core.VariableMap outputs = 2;
+   */
+  outputs?: VariableMap;
+};
+
+/**
+ * Describes the message flyteidl2.core.TypedInterface.
+ * Use `create(TypedInterfaceSchema)` to create a new message.
+ */
+export const TypedInterfaceSchema: GenMessage<TypedInterface> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_interface, 2);
+
+/**
+ * A parameter is used as input to a launch plan and has
+ * the special ability to have a default value or mark itself as required.
+ *
+ * @generated from message flyteidl2.core.Parameter
+ */
+export type Parameter = Message<"flyteidl2.core.Parameter"> & {
+  /**
+   * +required Variable. Defines the type of the variable backing this parameter.
+   *
+   * @generated from field: flyteidl2.core.Variable var = 1;
+   */
+  var?: Variable;
+
+  /**
+   * +optional
+   *
+   * @generated from oneof flyteidl2.core.Parameter.behavior
+   */
+  behavior: {
+    /**
+     * Defines a default value that has to match the variable type defined.
+     *
+     * @generated from field: flyteidl2.core.Literal default = 2;
+     */
+    value: Literal;
+    case: "default";
+  } | {
+    /**
+     * +optional, is this value required to be filled.
+     *
+     * @generated from field: bool required = 3;
+     */
+    value: boolean;
+    case: "required";
+  } | {
+    /**
+     * This is an execution time search basically that should result in exactly one Artifact with a Type that
+     * matches the type of the variable.
+     *
+     * @generated from field: flyteidl2.core.ArtifactQuery artifact_query = 4;
+     */
+    value: ArtifactQuery;
+    case: "artifactQuery";
+  } | {
+    /**
+     * @generated from field: flyteidl2.core.ArtifactID artifact_id = 5;
+     */
+    value: ArtifactID;
+    case: "artifactId";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message flyteidl2.core.Parameter.
+ * Use `create(ParameterSchema)` to create a new message.
+ */
+export const ParameterSchema: GenMessage<Parameter> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_interface, 3);
+
+/**
+ * A map of Parameters.
+ *
+ * @generated from message flyteidl2.core.ParameterMap
+ */
+export type ParameterMap = Message<"flyteidl2.core.ParameterMap"> & {
+  /**
+   * Defines a map of parameter names to parameters.
+   *
+   * @generated from field: map<string, flyteidl2.core.Parameter> parameters = 1;
+   */
+  parameters: { [key: string]: Parameter };
+};
+
+/**
+ * Describes the message flyteidl2.core.ParameterMap.
+ * Use `create(ParameterMapSchema)` to create a new message.
+ */
+export const ParameterMapSchema: GenMessage<ParameterMap> = /*@__PURE__*/
+  messageDesc(file_flyteidl2_core_interface, 4);
+