@flyteorg/flyteidl2/flyteidl2/core/identifier_pb.ts

Compiled protocol buffers and gRPC service and connect clients/servers for Flyte IDLs

// @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);