Skip to main content

Project

A class representing a project in the Union API.

Attributes​

  • pb2: project_pb2.Project
    • A class representing a project in the Union API.

Constructors​

  • Initializes a Project instance with the provided protobuf object.

  • Parameters

    • pb2: project_pb2.Project
      • The protobuf object representing the project.

Methods​

def get(name: string, org: string) - > [Project](src_flyte_remote__project_project)

  • Get a run by its ID or name. If both are provided, the ID will take precedence.

  • Parameters

    • name: string
      • The name of the project.
    • org: string
      • The organization of the project (if applicable).

  • Return Value: Project

    • The Project object.
def listall(filters: string, sort_by: Tuple[str, Literal["asc", "desc"]]) - > Union[AsyncIterator[[Project](src_flyte_remote__project_project)], Iterator[[Project](src_flyte_remote__project_project)]]

  • Get a run by its ID or name. If both are provided, the ID will take precedence.

  • Parameters

    • filters: string
      • The filters to apply to the project list.
    • sort_by: Tuple[str, Literal["asc", "desc"]]
      • The sorting criteria for the project list, in the format (field, order).

  • Return Value: Union[AsyncIterator[Project], Iterator[Project]]

    • An iterator of projects.