Warning

This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.schema package

class galaxy.schema.BootstrapAdminUser(*, id: int = 0, email: str | None = None, username: str | None = None, preferences: Dict[str, str] = {}, bootstrap_admin_user: bool = True)

Bases: BaseModel

id: int

email: str | None

username: str | None

preferences: Dict[str, str]

bootstrap_admin_user: bool

all_roles() → list

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.ValueFilterQueryParams(*, q: List[str] | str | None = None, qv: List[str] | str | None = None)

Bases: BaseModel

Allows filtering/querying elements by value like q=<property>-<operator>&qv=<value>

Multiple q/qv queries can be concatenated.

q: List[str] | str | None

qv: List[str] | str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.PaginationQueryParams(*, offset: int | None[int | None] = 0, limit: int | None[int | None] = None)

Bases: BaseModel

Used to paginate a the request results by limiting and offsetting.

offset: int | None

limit: int | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.FilterQueryParams(*, offset: int | None[int | None] = 0, limit: int | None[int | None] = None, q: List[str] | str | None = None, qv: List[str] | str | None = None, order: str | None = None)

Bases: ValueFilterQueryParams, PaginationQueryParams

Contains full filtering options to query elements, paginate and order them.

order: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.SerializationParams(*, view: str | None = None, keys: List[str] | None = None, default_view: str | None = None)

Bases: BaseModel

Contains common parameters for customizing model serialization.

view: str | None

keys: List[str] | None

default_view: str | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.PdfDocumentType(value)

Bases: str, Enum

An enumeration.

invocation_report = 'invocation_report'

page = 'page'

class galaxy.schema.APIKeyModel(*, key: str, create_time: datetime)

Bases: BaseModel

key: str

create_time: datetime

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

galaxy.schema.partial_model(include: List[str] | None = None, exclude: List[str] | None = None) → Callable[[Type[T]], Type[T]]

Decorator to make all model fields optional

Submodules

galaxy.schema.fetch_data module

class galaxy.schema.fetch_data.FetchBaseModel

Bases: Model

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.ElementsFromType(value)

Bases: str, Enum

An enumeration.

archive = 'archive'

bagit = 'bagit'

bagit_archive = 'bagit_archive'

directory = 'directory'

class galaxy.schema.fetch_data.BaseFetchDataTarget(*, auto_decompress: bool = False)

Bases: FetchBaseModel

auto_decompress: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.ItemsFromSrc(value)

Bases: str, Enum

An enumeration.

url = 'url'

files = 'files'

path = 'path'

ftp_import = 'ftp_import'

server_dir = 'server_dir'

class galaxy.schema.fetch_data.Src(value)

Bases: str, Enum

An enumeration.

url = 'url'

pasted = 'pasted'

files = 'files'

path = 'path'

composite = 'composite'

ftp_import = 'ftp_import'

server_dir = 'server_dir'

class galaxy.schema.fetch_data.DestinationType(value)

Bases: str, Enum

An enumeration.

library = 'library'

library_folder = 'library_folder'

hdcas = 'hdcas'

hdas = 'hdas'

class galaxy.schema.fetch_data.HdaDestination(*, type: typing_extensions.Literal[hdas])

Bases: FetchBaseModel

type: typing_extensions.Literal[hdas]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.HdcaDestination(*, type: typing_extensions.Literal[hdca])

Bases: FetchBaseModel

type: typing_extensions.Literal[hdca]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.LibraryFolderDestination(*, type: typing_extensions.Literal[library_folder], library_folder_id: int[int])

Bases: FetchBaseModel

type: typing_extensions.Literal[library_folder]

library_folder_id: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.BaseCollectionTarget(*, auto_decompress: bool = False, destination: HdcaDestination, collection_type: str | None = None, tags: List[str] | None = None, name: str | None = None)

Bases: BaseFetchDataTarget

destination: HdcaDestination

collection_type: str | None

tags: List[str] | None

name: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.LibraryDestination(*, type: typing_extensions.Literal[library], name: str, description: str | None = None, synopsis: str | None = None)

Bases: FetchBaseModel

type: typing_extensions.Literal[library]

name: str

description: str | None

synopsis: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.ExtraFiles(*, items_from: str | None = None, src: Src, fuzzy_root: bool | None = True)

Bases: FetchBaseModel

items_from: str | None

src: Src

fuzzy_root: bool | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FetchDatasetHash(*, hash_function: typing_extensions.Literal[MD5, SHA - 1, SHA - 256, SHA - 512], hash_value: str)

Bases: Model

hash_function: typing_extensions.Literal[MD5, SHA-1, SHA-256, SHA-512]

hash_value: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.BaseDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None)

Bases: FetchBaseModel

name: str | int | float | bool[str | int | float | bool] | None

dbkey: str

info: str | None

ext: str

space_to_tab: bool

to_posix_lines: bool

deferred: bool

tags: List[str] | None

created_from_basename: str | None

extra_files: ExtraFiles | None

auto_decompress: bool

items_from: ElementsFromType | None

collection_type: str | None

MD5: str | None

SHA1: str | None

SHA256: str | None

SHA512: str | None

hashes: List[FetchDatasetHash] | None

description: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FileDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[files])

Bases: BaseDataElement

src: typing_extensions.Literal[files]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.PastedDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[pasted], paste_content: str | int | float | bool[str | int | float | bool])

Bases: BaseDataElement

src: typing_extensions.Literal[pasted]

paste_content: str | int | float | bool[str | int | float | bool]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.UrlDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[url], url: str)

Bases: BaseDataElement

src: typing_extensions.Literal[url]

url: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.ServerDirElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[server_dir], server_dir: str, link_data_only: bool | None = None)

Bases: BaseDataElement

src: typing_extensions.Literal[server_dir]

server_dir: str

link_data_only: bool | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FtpImportElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[ftp_import], ftp_path: str)

Bases: BaseDataElement

src: typing_extensions.Literal[ftp_import]

ftp_path: str

collection_type: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.ItemsFromModel(*, src: ItemsFromSrc, path: str | None = None, ftp_path: str | None = None, server_dir: str | None = None, url: str | None = None)

Bases: Model

src: ItemsFromSrc

path: str | None

ftp_path: str | None

server_dir: str | None

url: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FtpImportTarget(*, auto_decompress: bool = False, destination: HdcaDestination, collection_type: str | None = None, tags: List[str] | None = None, name: str | None = None, src: typing_extensions.Literal[ftp_import], ftp_path: str, elements_from: ElementsFromType | None = None)

Bases: BaseCollectionTarget

src: typing_extensions.Literal[ftp_import]

ftp_path: str

items_from: ElementsFromType | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.PathDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[path], path: str, link_data_only: bool | None = None)

Bases: BaseDataElement

src: typing_extensions.Literal[path]

path: str

items_from: ElementsFromType | None

link_data_only: bool | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.CompositeDataElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, src: typing_extensions.Literal[composite], composite: CompositeItems)

Bases: BaseDataElement

src: typing_extensions.Literal[composite]

composite: CompositeItems

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.CompositeItems(*, elements: List[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement])

Bases: FetchBaseModel

items: List[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.NestedElement(*, name: str | int | float | bool[str | int | float | bool] | None = None, dbkey: str = '?', info: str | None = None, ext: str = 'auto', space_to_tab: bool = False, to_posix_lines: bool = False, deferred: bool = False, tags: List[str] | None = None, created_from_basename: str | None = None, extra_files: ExtraFiles | None = None, auto_decompress: bool = False, elements_from: ElementsFromType | None = None, collection_type: str | None = None, MD5: str | None = None, SHA1: str | None = None, SHA256: str | None = None, SHA512: str | None = None, hashes: List[FetchDatasetHash] | None = None, description: str | None = None, elements: List[FileDataElement | galaxy.schema.fetch_data.PastedDataElement | galaxy.schema.fetch_data.UrlDataElement | galaxy.schema.fetch_data.PathDataElement | galaxy.schema.fetch_data.ServerDirElement | galaxy.schema.fetch_data.FtpImportElement | galaxy.schema.fetch_data.CompositeDataElement[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement | CompositeDataElement] | NestedElement])

Bases: BaseDataElement

items: List[AnyElement | NestedElement]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.BaseDataTarget(*, auto_decompress: bool = False, destination: HdaDestination | LibraryFolderDestination | LibraryDestination)

Bases: BaseFetchDataTarget

destination: HdaDestination | LibraryFolderDestination | LibraryDestination

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.DataElementsTarget(*, auto_decompress: bool = False, destination: HdaDestination | LibraryFolderDestination | LibraryDestination, elements: List[FileDataElement | galaxy.schema.fetch_data.PastedDataElement | galaxy.schema.fetch_data.UrlDataElement | galaxy.schema.fetch_data.PathDataElement | galaxy.schema.fetch_data.ServerDirElement | galaxy.schema.fetch_data.FtpImportElement | galaxy.schema.fetch_data.CompositeDataElement[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement | CompositeDataElement] | NestedElement])

Bases: BaseDataTarget

items: List[FileDataElement | galaxy.schema.fetch_data.PastedDataElement | galaxy.schema.fetch_data.UrlDataElement | galaxy.schema.fetch_data.PathDataElement | galaxy.schema.fetch_data.ServerDirElement | galaxy.schema.fetch_data.FtpImportElement | galaxy.schema.fetch_data.CompositeDataElement[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement | CompositeDataElement] | NestedElement]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.DataElementsFromTarget(*, src: ItemsFromSrc, path: str | None = None, ftp_path: str | None = None, server_dir: str | None = None, url: str | None = None, auto_decompress: bool = False, destination: HdaDestination | LibraryFolderDestination | LibraryDestination, elements_from: ElementsFromType)

Bases: BaseDataTarget, ItemsFromModel

items_from: ElementsFromType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.HdcaDataItemsTarget(*, auto_decompress: bool = False, destination: HdcaDestination, collection_type: str | None = None, tags: List[str] | None = None, name: str | None = None, elements: List[FileDataElement | galaxy.schema.fetch_data.PastedDataElement | galaxy.schema.fetch_data.UrlDataElement | galaxy.schema.fetch_data.PathDataElement | galaxy.schema.fetch_data.ServerDirElement | galaxy.schema.fetch_data.FtpImportElement | galaxy.schema.fetch_data.CompositeDataElement[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement | CompositeDataElement] | NestedElement])

Bases: BaseCollectionTarget

items: List[FileDataElement | galaxy.schema.fetch_data.PastedDataElement | galaxy.schema.fetch_data.UrlDataElement | galaxy.schema.fetch_data.PathDataElement | galaxy.schema.fetch_data.ServerDirElement | galaxy.schema.fetch_data.FtpImportElement | galaxy.schema.fetch_data.CompositeDataElement[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement | CompositeDataElement] | NestedElement]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.HdcaDataItemsFromTarget(*, src: ItemsFromSrc, path: str | None = None, ftp_path: str | None = None, server_dir: str | None = None, url: str | None = None, auto_decompress: bool = False, destination: HdcaDestination, collection_type: str | None = None, tags: List[str] | None = None, name: str | None = None, elements_from: ElementsFromType)

Bases: BaseCollectionTarget, ItemsFromModel

items_from: ElementsFromType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FilesPayload(*, filename: str, local_filename: str)

Bases: Model

filename: str

local_filename: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.BaseDataPayload(*, history_id: int[int], **extra_data: Any)

Bases: FetchBaseModel

history_id: int[int]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod targets_string_to_json(v)

class galaxy.schema.fetch_data.FetchDataPayload(*, history_id: int[int], targets: List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget], **extra_data: Any)

Bases: BaseDataPayload

targets: List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.fetch_data.FetchDataFormPayload(*, history_id: int[int], targets: List[galaxy.schema.fetch_data.DataElementsTarget | galaxy.schema.fetch_data.HdcaDataItemsTarget | galaxy.schema.fetch_data.DataElementsFromTarget | galaxy.schema.fetch_data.HdcaDataItemsFromTarget | galaxy.schema.fetch_data.FtpImportTarget][List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget]] | List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget], **extra_data: Any)

Bases: BaseDataPayload

targets: List[galaxy.schema.fetch_data.DataElementsTarget | galaxy.schema.fetch_data.HdcaDataItemsTarget | galaxy.schema.fetch_data.DataElementsFromTarget | galaxy.schema.fetch_data.HdcaDataItemsFromTarget | galaxy.schema.fetch_data.FtpImportTarget][List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget]] | List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

galaxy.schema.fields module

class galaxy.schema.fields.Security

Bases: object

security: IdEncodingHelper

galaxy.schema.fields.ensure_valid_id(v: str) → str

galaxy.schema.fields.ensure_valid_folder_id(v)

galaxy.schema.fields.literal_to_value(arg)

galaxy.schema.fields.is_optional(field)

galaxy.schema.fields.ModelClassField(default_value)

Represents a database model class name annotated as a constant pydantic Field. :param class_name: The name of the database class. :return: A constant pydantic Field with default annotations for model classes.

galaxy.schema.fields.accept_wildcard_defaults_to_json(v)

galaxy.schema.remote_files module

class galaxy.schema.remote_files.RemoteFilesTarget(value)

Bases: str, Enum

An enumeration.

ftpdir = 'ftpdir'

userdir = 'userdir'

importdir = 'importdir'

class galaxy.schema.remote_files.RemoteFilesFormat(value)

Bases: str, Enum

An enumeration.

flat = 'flat'

jstree = 'jstree'

uri = 'uri'

class galaxy.schema.remote_files.RemoteFilesDisableMode(value)

Bases: str, Enum

An enumeration.

folders = 'folders'

files = 'files'

class galaxy.schema.remote_files.FilesSourceSupports(*, pagination: bool = False, search: bool = False, sorting: bool = False)

Bases: Model

pagination: bool[bool]

search: bool[bool]

sorting: bool[bool]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.FilesSourcePlugin(*, id: str, type: str, label: str, doc: str | None = None, browsable: bool, writable: bool, requires_roles: str | None = None, requires_groups: str | None = None, url: str | None = None, supports: FilesSourceSupports = FilesSourceSupports(pagination=False, search=False, sorting=False))

Bases: Model

id: str

type: str

label: str

doc: str | None

browsable: bool

writable: bool

requires_roles: str | None

requires_groups: str | None

url: str | None

supports: FilesSourceSupports[FilesSourceSupports]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.BrowsableFilesSourcePlugin(*, id: str, type: str, label: str, doc: str | None = None, browsable: typing_extensions.Literal[True], writable: bool, requires_roles: str | None = None, requires_groups: str | None = None, url: str | None = None, supports: FilesSourceSupports = FilesSourceSupports(pagination=False, search=False, sorting=False), uri_root: str)

Bases: FilesSourcePlugin

browsable: typing_extensions.Literal[True]

uri_root: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.FilesSourcePluginList(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[BrowsableFilesSourcePlugin | FilesSourcePlugin]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.RemoteEntry(*, name: str, uri: str, path: str)

Bases: Model

name: str

uri: str

path: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.RemoteDirectory(*, name: str, uri: str, path: str, class_: typing_extensions.Literal[Directory])

Bases: RemoteEntry

class_: typing_extensions.Literal[Directory]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.RemoteFile(*, name: str, uri: str, path: str, class_: typing_extensions.Literal[File], size: int, ctime: str)

Bases: RemoteEntry

class_: typing_extensions.Literal[File]

size: int

ctime: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.ListJstreeResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[Any]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.ListUriResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[RemoteFile | galaxy.schema.remote_files.RemoteDirectory[RemoteFile | RemoteDirectory]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.CreateEntryPayload(*, target: str, name: str)

Bases: Model

target: str

name: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.remote_files.CreatedEntryResponse(*, name: str, uri: str, external_link: str | None = None)

Bases: Model

name: str

uri: str

external_link: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

galaxy.schema.schema module

This module contains general pydantic models and common schema field annotations for them.

class galaxy.schema.schema.DatasetState(value)

Bases: str, Enum

An enumeration.

NEW = 'new'

UPLOAD = 'upload'

QUEUED = 'queued'

RUNNING = 'running'

OK = 'ok'

EMPTY = 'empty'

ERROR = 'error'

PAUSED = 'paused'

SETTING_METADATA = 'setting_metadata'

FAILED_METADATA = 'failed_metadata'

DEFERRED = 'deferred'

DISCARDED = 'discarded'

classmethod values()

class galaxy.schema.schema.JobState(value)

Bases: str, Enum

An enumeration.

NEW = 'new'

RESUBMITTED = 'resubmitted'

UPLOAD = 'upload'

WAITING = 'waiting'

QUEUED = 'queued'

RUNNING = 'running'

OK = 'ok'

ERROR = 'error'

FAILED = 'failed'

PAUSED = 'paused'

DELETING = 'deleting'

DELETED = 'deleted'

STOPPING = 'stop'

STOPPED = 'stopped'

SKIPPED = 'skipped'

class galaxy.schema.schema.DatasetCollectionPopulatedState(value)

Bases: str, Enum

An enumeration.

NEW = 'new'

OK = 'ok'

FAILED = 'failed'

class galaxy.schema.schema.Model

Bases: BaseModel

Base model definition with common configuration used by all derived models.

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.RequireOneSetOption

Bases: Model

check_some_ids_passed()

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.BaseUserModel(*, id: str[str], username: str, email: str, deleted: bool)

Bases: Model

id: str[str]

username: str

email: str

deleted: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WithModelClass

Bases: object

model_class: str

classmethod set_default(data)

class galaxy.schema.schema.UserModel(*, model_class: typing_extensions.Literal[User], id: str[str], username: str, email: str, deleted: bool, active: bool, last_password_change: datetime | None)

Bases: BaseUserModel, WithModelClass

User in a transaction context.

active: bool

model_class: typing_extensions.Literal[User]

last_password_change: datetime | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LimitedUserModel(*, id: str[str], username: str | None = None, email: str | None = None)

Bases: Model

This is used when config options (expose_user_name and expose_user_email) are in place.

id: str[str]

username: str | None

email: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DiskUsageUserModel(*, total_disk_usage: float, nice_total_disk_usage: str)

Bases: Model

total_disk_usage: float

nice_total_disk_usage: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreatedUserModel(*, model_class: typing_extensions.Literal[User], total_disk_usage: float, nice_total_disk_usage: str, id: str[str], username: str, email: str, deleted: bool, active: bool, last_password_change: datetime | None, preferred_object_store_id: str | None = None)

Bases: UserModel, DiskUsageUserModel

preferred_object_store_id: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.AnonUserModel(*, total_disk_usage: float, nice_total_disk_usage: str, quota_percent: float | None = None)

Bases: DiskUsageUserModel

quota_percent: float | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DetailedUserModel(*, total_disk_usage: float, nice_total_disk_usage: str, quota_percent: float | None = None, id: str[str], username: str, email: str, deleted: bool, is_admin: bool, purged: bool, preferences: Dict[Any, Any], preferred_object_store_id: str | None = None, quota: str, quota_bytes: int | None = None, tags_used: List[str])

Bases: BaseUserModel, AnonUserModel

is_admin: bool

purged: bool

preferences: Dict[Any, Any]

preferred_object_store_id: str | None

quota: str

quota_bytes: int | None

tags_used: List[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UserUpdatePayload(*, active: bool | None = None, username: str | None = None, preferred_object_store_id: str | None = None)

Bases: Model

active: bool | None[bool | None]

username: str | None[str | None]

preferred_object_store_id: str | None[str | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UserCreationPayload(*, password: str, email: str, username: str)

Bases: Model

password: str

email: str

username: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.RemoteUserCreationPayload(*, remote_user_email: str)

Bases: Model

remote_user_email: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UserDeletionPayload(*, purge: bool = False)

Bases: Model

purge: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.FavoriteObject(*, object_id: str)

Bases: Model

object_id: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.FavoriteObjectsSummary(*, tools: List[str])

Bases: Model

tools: List[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.FavoriteObjectType(value)

Bases: str, Enum

An enumeration.

tools = 'tools'

class galaxy.schema.schema.DeletedCustomBuild(*, message: str)

Bases: Model

message: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomBuildBaseModel(*, name: str)

Bases: Model

name: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomBuildLenType(value)

Bases: str, Enum

An enumeration.

file = 'file'

fasta = 'fasta'

text = 'text'

class galaxy.schema.schema.CustomBuildCreationPayload(*, name: str, len_type: CustomBuildLenType, len_value: str)

Bases: CustomBuildBaseModel

len_type: CustomBuildLenType

len_value: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreatedCustomBuild(*, name: str, len: str[str], count: str | None = None, fasta: str[str] | None = None, linecount: str[str] | None = None)

Bases: CustomBuildBaseModel

len: str[str]

count: str | None

fasta: str[str] | None

linecount: str[str] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomBuildModel(*, name: str, len: str[str], count: str | None = None, fasta: str[str] | None = None, linecount: str[str] | None = None, id: str)

Bases: CreatedCustomBuild

id: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomBuildsCollection(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[CustomBuildModel]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.GroupModel(*, model_class: typing_extensions.Literal[Group], id: int[int], name: str)

Bases: Model, WithModelClass

User group model

model_class: typing_extensions.Literal[Group]

id: int[int]

name: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobSourceType(value)

Bases: str, Enum

Available types of job sources (model classes) that produce dataset collections.

Job = 'Job'

ImplicitCollectionJobs = 'ImplicitCollectionJobs'

WorkflowInvocation = 'WorkflowInvocation'

class galaxy.schema.schema.HistoryContentType(value)

Bases: str, Enum

Available types of History contents.

dataset = 'dataset'

dataset_collection = 'dataset_collection'

class galaxy.schema.schema.HistoryImportArchiveSourceType(value)

Bases: str, Enum

Available types of History archive sources.

url = 'url'

file = 'file'

class galaxy.schema.schema.DCEType(value)

Bases: str, Enum

Available types of dataset collection elements.

hda = 'hda'

dataset_collection = 'dataset_collection'

class galaxy.schema.schema.DatasetSourceType(value)

Bases: str, Enum

An enumeration.

hda = 'hda'

ldda = 'ldda'

class galaxy.schema.schema.DataItemSourceType(value)

Bases: str, Enum

An enumeration.

hda = 'hda'

ldda = 'ldda'

hdca = 'hdca'

dce = 'dce'

dc = 'dc'

class galaxy.schema.schema.ColletionSourceType(value)

Bases: str, Enum

An enumeration.

hda = 'hda'

ldda = 'ldda'

hdca = 'hdca'

new_collection = 'new_collection'

class galaxy.schema.schema.HistoryContentSource(value)

Bases: str, Enum

An enumeration.

hda = 'hda'

hdca = 'hdca'

library = 'library'

library_folder = 'library_folder'

new_collection = 'new_collection'

class galaxy.schema.schema.TagCollection(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

Represents the collection of tags associated with an item.

root: List[str[str]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.MetadataFile(*, file_type: str, download_url: str)

Bases: Model

Metadata file associated with a dataset.

file_type: str

download_url: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetPermissions(*, manage: List[int[int]] = [], access: List[int[int]] = [])

Bases: Model

Role-based permissions for accessing and managing a dataset.

manage: List[int[int]]

access: List[int[int]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Hyperlink(*, target: str, href: str, text: str)

Bases: Model

Represents some text with an Hyperlink.

target: str

href: str[str]

text: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DisplayApp(*, label: str, links: List[Hyperlink])

Bases: Model

Basic linked information about an application that can display certain datatypes.

label: str

links: List[Hyperlink]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Visualization

Bases: Model

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryItemBase(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool)

Bases: Model

Basic information provided by items contained in a History.

id: str[str]

name: str | None

history_id: str[str]

hid: int

deleted: bool

visible: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryItemCommon(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection)

Bases: HistoryItemBase

Common information provided by items contained in a History.

type_id: str | None

type: str

create_time: datetime | None

update_time: datetime | None

url: str[str]

tags: TagCollection

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDACommon(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset], copied_from_ldda_id: str[str] | None = None)

Bases: HistoryItemCommon

history_content_type: typing_extensions.Literal[dataset][typing_extensions.Literal[dataset]]

copied_from_ldda_id: str[str] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDASummary(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset], copied_from_ldda_id: str[str] | None = None, dataset_id: str[str], state: DatasetState[DatasetState], extension: str | None, purged: bool, genome_build: str | None = '?')

Bases: HDACommon

History Dataset Association summary information.

dataset_id: str[str]

state: DatasetState[DatasetState]

extension: str | None

purged: bool

genome_build: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDAInaccessible(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset], copied_from_ldda_id: str[str] | None = None, accessible: typing_extensions.Literal[False], state: DatasetState[DatasetState])

Bases: HDACommon

History Dataset Association information when the user can not access it.

accessible: typing_extensions.Literal[False]

state: DatasetState[DatasetState]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetValidatedState(value)

Bases: str, Enum

An enumeration.

UNKNOWN = 'unknown'

INVALID = 'invalid'

OK = 'ok'

class galaxy.schema.schema.DatasetHash(*, model_class: typing_extensions.Literal[DatasetHash], id: str[str], hash_function: HashFunctionNameEnum, hash_value: str, extra_files_path: str | None = None)

Bases: Model

model_class: typing_extensions.Literal[DatasetHash]

id: str[str]

hash_function: HashFunctionNameEnum

hash_value: str

extra_files_path: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetSource(*, id: str[str], source_uri: str, extra_files_path: str | None = None, transform: List[Any] | None = None)

Bases: Model

id: str[str]

source_uri: str[str]

extra_files_path: str | None[str | None]

transform: List[Any] | None[List[Any] | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDADetailed(*, model_class: typing_extensions.Literal[HistoryDatasetAssociation], id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[file] = 'file', create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset], copied_from_ldda_id: str[str] | None = None, dataset_id: str[str], state: DatasetState[DatasetState], extension: str | None, purged: bool, genome_build: str | None = '?', hda_ldda: DatasetSourceType = DatasetSourceType.hda, accessible: bool, misc_info: str | None = None, misc_blurb: str | None = None, file_ext: str, file_size: int, resubmitted: bool, metadata: Any | None = None, meta_files: List[MetadataFile], data_type: str, peek: str | None = None, creating_job: str, rerunnable: bool, uuid: UUID[UUID], permissions: DatasetPermissions, file_name: str | None = None, display_apps: List[DisplayApp], display_types: List[DisplayApp], validated_state: DatasetValidatedState, validated_state_message: str | None = None, annotation: str | None, download_url: str, api_type: typing_extensions.Literal[file] = 'file', created_from_basename: str | None = None, hashes: List[DatasetHash], drs_id: str, sources: List[DatasetSource], copied_from_history_dataset_association_id: str[str] | None = None)

Bases: HDASummary, WithModelClass

History Dataset Association detailed information.

model_class: typing_extensions.Literal[HistoryDatasetAssociation][typing_extensions.Literal[HistoryDatasetAssociation]]

hda_ldda: DatasetSourceType

accessible: bool

misc_info: str | None

misc_blurb: str | None

file_ext: str

file_size: int

resubmitted: bool

metadata: Any | None

meta_files: List[MetadataFile]

data_type: str

peek: str | None

creating_job: str

rerunnable: bool

uuid: UUID[UUID]

permissions: DatasetPermissions

file_name: str | None

display_apps: List[DisplayApp]

display_types: List[DisplayApp]

validated_state: DatasetValidatedState

validated_state_message: str | None

annotation: str | None

download_url: str

type: typing_extensions.Literal[file][typing_extensions.Literal[file]]

api_type: typing_extensions.Literal[file][typing_extensions.Literal[file]]

created_from_basename: str | None

hashes: List[galaxy.schema.schema.DatasetHash][List[DatasetHash]]

drs_id: str[str]

sources: List[galaxy.schema.schema.DatasetSource][List[DatasetSource]]

copied_from_history_dataset_association_id: str[str] | None[str[str] | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDAExtended(*, model_class: typing_extensions.Literal[HistoryDatasetAssociation], id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[file] = 'file', create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset], copied_from_ldda_id: str[str] | None = None, dataset_id: str[str], state: DatasetState[DatasetState], extension: str | None, purged: bool, genome_build: str | None = '?', hda_ldda: DatasetSourceType = DatasetSourceType.hda, accessible: bool, misc_info: str | None = None, misc_blurb: str | None = None, file_ext: str, file_size: int, resubmitted: bool, metadata: Any | None = None, meta_files: List[MetadataFile], data_type: str, peek: str | None = None, creating_job: str, rerunnable: bool, uuid: UUID[UUID], permissions: DatasetPermissions, file_name: str | None = None, display_apps: List[DisplayApp], display_types: List[DisplayApp], validated_state: DatasetValidatedState, validated_state_message: str | None = None, annotation: str | None, download_url: str, api_type: typing_extensions.Literal[file] = 'file', created_from_basename: str | None = None, hashes: List[DatasetHash], drs_id: str, sources: List[DatasetSource], copied_from_history_dataset_association_id: str[str] | None = None, tool_version: str, parent_id: int[int] | None = None, designation: str | None = None)

Bases: HDADetailed

History Dataset Association extended information.

tool_version: str

parent_id: int[int] | None

designation: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DCSummary(*, model_class: typing_extensions.Literal[DatasetCollection], id: str[str], create_time: datetime, update_time: datetime, collection_type: str, populated_state: DatasetCollectionPopulatedState, populated_state_message: str | None = None, element_count: int | None = None)

Bases: Model, WithModelClass

Dataset Collection summary information.

model_class: typing_extensions.Literal[DatasetCollection]

id: str[str]

create_time: datetime

update_time: datetime

collection_type: str

populated_state: DatasetCollectionPopulatedState

populated_state_message: str | None

element_count: int | None[int | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDAObject(*, model_class: typing_extensions.Literal[HistoryDatasetAssociation], id: str[str], state: DatasetState[DatasetState], hda_ldda: DatasetSourceType = DatasetSourceType.hda, history_id: str[str], tags: List[str], copied_from_ldda_id: str[str] | None = None, accessible: bool | None = None, purged: bool, **extra_data: Any)

Bases: Model, WithModelClass

History Dataset Association Object

id: str[str]

model_class: typing_extensions.Literal[HistoryDatasetAssociation]

state: DatasetState[DatasetState]

hda_ldda: DatasetSourceType

history_id: str[str]

tags: List[str]

copied_from_ldda_id: str[str] | None

accessible: bool | None

purged: bool

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DCObject(*, model_class: typing_extensions.Literal[DatasetCollection], id: str[str], collection_type: str, populated: bool = None, element_count: int | None = None, contents_url: str[str] | None = None, elements: List[DCESummary] = [])

Bases: Model, WithModelClass

Dataset Collection Object

id: str[str]

model_class: typing_extensions.Literal[DatasetCollection]

collection_type: str

populated: bool[bool]

element_count: int | None[int | None]

contents_url: str[str] | None

elements: List[DCESummary]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DCESummary(*, model_class: typing_extensions.Literal[DatasetCollectionElement], id: str[str], element_index: int, element_identifier: str, element_type: DCEType | None = None, object: HDAObject | HDADetailed | DCObject | None = None)

Bases: Model, WithModelClass

Dataset Collection Element summary information.

id: str[str]

model_class: typing_extensions.Literal[DatasetCollectionElement]

element_index: int

element_identifier: str

element_type: DCEType | None

object: HDAObject | HDADetailed | DCObject | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DCDetailed(*, model_class: typing_extensions.Literal[DatasetCollection], id: str[str], create_time: datetime, update_time: datetime, collection_type: str, populated_state: DatasetCollectionPopulatedState, populated_state_message: str | None = None, element_count: int | None = None, populated: bool = None, elements: List[DCESummary] = [])

Bases: DCSummary

Dataset Collection detailed information.

populated: bool[bool]

elements: List[DCESummary]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDCJobStateSummary(*, all_jobs: int = 0, new: int = 0, waiting: int = 0, running: int = 0, error: int = 0, paused: int = 0, skipped: int = 0, deleted_new: int = 0, resubmitted: int = 0, queued: int = 0, ok: int = 0, failed: int = 0, deleted: int = 0, upload: int = 0)

Bases: Model

Overview of the job states working inside a dataset collection.

all_jobs: int

new: int

waiting: int

running: int

error: int

paused: int

skipped: int

deleted_new: int

resubmitted: int

queued: int

ok: int

failed: int

deleted: int

upload: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDCACommon(*, id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset_collection])

Bases: HistoryItemCommon

history_content_type: typing_extensions.Literal[dataset_collection][typing_extensions.Literal[dataset_collection]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDCASummary(*, model_class: typing_extensions.Literal[HistoryDatasetCollectionAssociation], id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[collection] = 'collection', create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset_collection], collection_type: str, populated_state: DatasetCollectionPopulatedState, populated_state_message: str | None = None, element_count: int | None = None, elements_datatypes: Set[str], job_source_id: str[str] | None = None, job_source_type: JobSourceType | None = None, job_state_summary: HDCJobStateSummary | None = None, contents_url: str, collection_id: str[str])

Bases: HDCACommon, WithModelClass

History Dataset Collection Association summary information.

model_class: typing_extensions.Literal[HistoryDatasetCollectionAssociation]

type: typing_extensions.Literal[collection][typing_extensions.Literal[collection]]

collection_type: str

populated_state: DatasetCollectionPopulatedState

populated_state_message: str | None

element_count: int | None[int | None]

elements_datatypes: Set[str]

job_source_id: str[str] | None

job_source_type: JobSourceType | None

job_state_summary: HDCJobStateSummary | None

contents_url: str[str]

collection_id: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDCADetailed(*, model_class: typing_extensions.Literal[HistoryDatasetCollectionAssociation], id: str[str], name: str | None, history_id: str[str], hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[collection] = 'collection', create_time: datetime | None, update_time: datetime | None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset_collection], collection_type: str, populated_state: DatasetCollectionPopulatedState, populated_state_message: str | None = None, element_count: int | None = None, elements_datatypes: Set[str], job_source_id: str[str] | None = None, job_source_type: JobSourceType | None = None, job_state_summary: HDCJobStateSummary | None = None, contents_url: str, collection_id: str[str], populated: bool = None, elements: List[DCESummary] = [], implicit_collection_jobs_id: str[str] | None = None)

Bases: HDCASummary

History Dataset Collection Association detailed information.

populated: bool[bool]

elements: List[DCESummary]

implicit_collection_jobs_id: str[str] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentItemBase(*, history_content_type: HistoryContentType)

Bases: Model

Identifies a dataset or collection contained in a History.

history_content_type: HistoryContentType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentItem(*, history_content_type: HistoryContentType, id: int[int])

Bases: HistoryContentItemBase

id: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.EncodedHistoryContentItem(*, history_content_type: HistoryContentType, id: str[str])

Bases: HistoryContentItemBase

id: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateContentItem(*, history_content_type: HistoryContentType, id: int[int], **extra_data: Any)

Bases: HistoryContentItem

Used for updating a particular history item. All fields are optional.

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

id: int[int]

history_content_type: HistoryContentType

class galaxy.schema.schema.UpdateHistoryContentsBatchPayload(*, items: List[UpdateContentItem], **extra_data: Any)

Bases: Model

Contains property values that will be updated for all the history items provided.

items: List[UpdateContentItem]

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'json_schema_extra': {'example': {'items': [{'history_content_type': 'dataset', 'id': 'string'}], 'visible': False}}, 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentItemOperation(value)

Bases: str, Enum

An enumeration.

hide = 'hide'

unhide = 'unhide'

delete = 'delete'

undelete = 'undelete'

purge = 'purge'

change_datatype = 'change_datatype'

change_dbkey = 'change_dbkey'

add_tags = 'add_tags'

remove_tags = 'remove_tags'

class galaxy.schema.schema.BulkOperationParams(*, type: str)

Bases: Model

type: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ChangeDatatypeOperationParams(*, type: typing_extensions.Literal[change_datatype], datatype: str)

Bases: BulkOperationParams

type: typing_extensions.Literal[change_datatype]

datatype: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ChangeDbkeyOperationParams(*, type: typing_extensions.Literal[change_dbkey], dbkey: str)

Bases: BulkOperationParams

type: typing_extensions.Literal[change_dbkey]

dbkey: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.TagOperationParams(*, type: typing_extensions.Literal[add_tags] | typing_extensions.Literal[remove_tags], tags: List[str])

Bases: BulkOperationParams

type: typing_extensions.Literal[add_tags] | typing_extensions.Literal[remove_tags]

tags: List[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentBulkOperationPayload(*, operation: HistoryContentItemOperation, items: List[HistoryContentItem] | None = None, params: ChangeDatatypeOperationParams | ChangeDbkeyOperationParams | TagOperationParams | None = None)

Bases: Model

operation: HistoryContentItemOperation

items: List[HistoryContentItem] | None

params: ChangeDatatypeOperationParams | ChangeDbkeyOperationParams | TagOperationParams | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.BulkOperationItemError(*, item: EncodedHistoryContentItem, error: str)

Bases: Model

item: EncodedHistoryContentItem

error: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentBulkOperationResult(*, success_count: int, errors: List[BulkOperationItemError])

Bases: Model

success_count: int

errors: List[BulkOperationItemError]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateHistoryContentsPayload(*, name: str | None = None, deleted: bool | None = None, visible: bool | None = None, annotation: str | None = None, tags: TagCollection | None = None, **extra_data: Any)

Bases: Model

Can contain arbitrary/dynamic fields that will be updated for a particular history item.

name: str | None

deleted: bool | None

visible: bool | None

annotation: str | None

tags: TagCollection | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'json_schema_extra': {'example': {'annotation': 'Test', 'visible': False}}, 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistorySummary(*, model_class: typing_extensions.Literal[History], id: str[str], name: str, deleted: bool, purged: bool, archived: bool, url: str, published: bool, count: int, annotation: str | None, tags: TagCollection, update_time: datetime, preferred_object_store_id: str | None = None)

Bases: Model, WithModelClass

History summary information.

model_class: typing_extensions.Literal[History]

id: str[str]

name: str

deleted: bool

purged: bool

archived: bool

url: str[str]

published: bool

count: int

annotation: str | None

tags: TagCollection

update_time: datetime

preferred_object_store_id: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryActiveContentCounts(*, active: int, hidden: int, deleted: int)

Bases: Model

Contains the number of active, deleted or hidden items in a History.

active: int

hidden: int

deleted: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryDetailed(*, model_class: typing_extensions.Literal[History], id: str[str], name: str, deleted: bool, purged: bool, archived: bool, url: str, published: bool, count: int, annotation: str | None, tags: TagCollection, update_time: datetime, preferred_object_store_id: str | None = None, contents_url: str, size: int, user_id: str[str] | None = None, create_time: datetime, importable: bool, slug: str | None = None, username: str | None = None, username_and_slug: str | None = None, genome_build: str | None = '?', state: DatasetState, state_ids: Dict[DatasetState, List[int[int]]], state_details: Dict[DatasetState, int])

Bases: HistorySummary

History detailed information.

contents_url: str[str]

size: int

user_id: str[str] | None

create_time: datetime

importable: bool

slug: str | None

username: str | None

username_and_slug: str | None

genome_build: str | None

state: DatasetState

state_ids: Dict[DatasetState, List[int[int]]]

state_details: Dict[DatasetState, int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomHistoryView(*, model_class: typing_extensions.Literal[History] | None = None, id: str | None[str | None] = None, name: str | None = None, deleted: bool | None = None, purged: bool | None = None, archived: bool | None = None, url: str | None = None, published: bool | None = None, count: int | None = None, annotation: str | None = None, tags: TagCollection | None = None, update_time: datetime | None = None, preferred_object_store_id: str | None = None, contents_url: str | None = None, size: int | None = None, user_id: str[str] | None = None, create_time: datetime | None = None, importable: bool | None = None, slug: str | None = None, username: str | None = None, username_and_slug: str | None = None, genome_build: str | None = None, state: DatasetState | None = None, state_ids: Dict[DatasetState, List[int[int]]] | None = None, state_details: Dict[DatasetState, int] | None = None, contents_active: HistoryActiveContentCounts | None = None, contents_states: Dict[DatasetState | DatasetCollectionPopulatedState, int] | None = None, nice_size: str | None = None)

Bases: CustomHistoryView

contents_active: HistoryActiveContentCounts | None

contents_states: Dict[DatasetState | DatasetCollectionPopulatedState, int] | None

nice_size: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_class: typing_extensions.Literal[History] | None

id: str | None

name: str | None

deleted: bool | None

purged: bool | None

archived: bool | None

url: str | None

published: bool | None

count: int | None

annotation: str | None

tags: TagCollection | None

update_time: datetime | None

preferred_object_store_id: str | None

contents_url: str | None

size: int | None

user_id: str[str] | None

create_time: datetime | None

importable: bool | None

slug: str | None

username: str | None

username_and_slug: str | None

genome_build: str | None

state: DatasetState | None

state_ids: Dict[DatasetState, List[int[int]]] | None

state_details: Dict[DatasetState, int] | None

class galaxy.schema.schema.UpdateHistoryPayload(*, name: str | None = None, annotation: str | None = None, tags: TagCollection | None = None, published: bool | None = None, importable: bool | None = None, deleted: bool | None = None, purged: bool | None = None, genome_build: str | None = None, preferred_object_store_id: str | None = None)

Bases: Model

name: str | None

annotation: str | None

tags: TagCollection | None

published: bool | None

importable: bool | None

deleted: bool | None

purged: bool | None

genome_build: str | None

preferred_object_store_id: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportHistoryArchivePayload(*, gzip: bool | None = True, include_hidden: bool | None = False, include_deleted: bool | None = False, file_name: str | None = None, directory_uri: str | None = None, force: bool | None = None)

Bases: Model

gzip: bool | None

include_hidden: bool | None

include_deleted: bool | None

file_name: str | None

directory_uri: str | None

force: bool | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowIndexQueryPayload(*, show_deleted: bool = False, show_hidden: bool = False, show_published: bool | None = None, show_shared: bool | None = None, sort_by: typing_extensions.Literal[create_time, update_time, name] | None = None, sort_desc: bool | None = None, limit: int | None[int | None] = None, offset: int | None = 0, search: str | None = None, skip_step_counts: bool = False)

Bases: Model

show_deleted: bool

show_hidden: bool

show_published: bool | None

show_shared: bool | None

sort_by: typing_extensions.Literal[create_time, update_time, name] | None

sort_desc: bool | None

limit: int | None

offset: int | None

search: str | None

skip_step_counts: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobIndexSortByEnum(value)

Bases: str, Enum

An enumeration.

create_time = 'create_time'

update_time = 'update_time'

class galaxy.schema.schema.JobIndexQueryPayload(*, states: List[str] | None = None, user_details: bool = False, user_id: int[int] | None = None, tool_ids: List[str] | None = None, tool_ids_like: List[str] | None = None, date_range_min: datetime[datetime] | date | None = None, date_range_max: datetime[datetime] | date | None = None, history_id: int[int] | None = None, workflow_id: int[int] | None = None, invocation_id: int[int] | None = None, implicit_collection_jobs_id: int[int] | None = None, order_by: JobIndexSortByEnum = JobIndexSortByEnum.update_time, search: str | None = None, limit: int = 500, offset: int = 0)

Bases: Model

states: List[str] | None

user_details: bool

user_id: int[int] | None

tool_ids: List[str] | None

tool_ids_like: List[str] | None

date_range_min: datetime[datetime] | date | None

date_range_max: datetime[datetime] | date | None

history_id: int[int] | None

workflow_id: int[int] | None

invocation_id: int[int] | None

implicit_collection_jobs_id: int[int] | None

order_by: JobIndexSortByEnum

search: str | None

limit: int

offset: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InvocationSortByEnum(value)

Bases: str, Enum

An enumeration.

create_time = 'create_time'

update_time = 'update_time'

none = 'None'

class galaxy.schema.schema.InvocationIndexQueryPayload(*, workflow_id: int | None = None, history_id: int | None = None, job_id: int | None = None, user_id: int | None = None, sort_by: InvocationSortByEnum | None = None, sort_desc: bool = False, include_terminal: bool = True, limit: int | None[int | None] = 100, offset: int | None = 0, include_nested_invocations: bool = True)

Bases: Model

workflow_id: int | None

history_id: int | None

job_id: int | None

user_id: int | None

sort_by: InvocationSortByEnum | None

sort_desc: bool

include_terminal: bool

limit: int | None

offset: int | None

include_nested_invocations: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PageIndexQueryPayload(*, deleted: bool = False, limit: int | None[int | None] = 100, offset: int | None = 0, show_own: bool | None = None, show_published: bool | None = None, show_shared: bool | None = None, search: str | None = None, sort_by: typing_extensions.Literal[create_time, title, update_time, username] = 'update_time', sort_desc: bool | None = False, user_id: int[int] | None = None)

Bases: Model

deleted: bool

limit: int | None

offset: int | None

show_own: bool | None

show_published: bool | None

show_shared: bool | None

search: str | None

sort_by: typing_extensions.Literal[create_time, title, update_time, username]

sort_desc: bool | None

user_id: int[int] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateHistoryPayload(*, name: str | None = None, history_id: int[int] | None = None, all_datasets: bool | None = True, archive_source: str | None = None, archive_type: HistoryImportArchiveSourceType | None = HistoryImportArchiveSourceType.url, archive_file: Any | None = None)

Bases: Model

name: str | None

history_id: int[int] | None

all_datasets: bool | None

archive_source: str | None

archive_type: HistoryImportArchiveSourceType | None

archive_file: Any | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CollectionElementIdentifier(*, name: str | None = None, src: ColletionSourceType, id: int[int] | None = None, collection_type: str | None = None, element_identifiers: List[CollectionElementIdentifier] | None = None, tags: List[str] | None = None)

Bases: Model

name: str | None

src: ColletionSourceType

id: int[int] | None

collection_type: str | None

element_identifiers: List[CollectionElementIdentifier] | None

tags: List[str] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateNewCollectionPayload(*, collection_type: str | None = None, element_identifiers: List[CollectionElementIdentifier] | None = None, name: str | None = None, hide_source_items: bool | None = False, copy_elements: bool | None = True, instance_type: typing_extensions.Literal[history, library] | None = 'history', history_id: int[int] | None = None, folder_id: int[int] | None = None)

Bases: Model

collection_type: str | None

element_identifiers: List[CollectionElementIdentifier] | None

name: str | None

hide_source_items: bool | None

copy_elements: bool | None

instance_type: typing_extensions.Literal[history, library] | None

history_id: int[int] | None

folder_id: int[int] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ModelStoreFormat(value)

Bases: str, Enum

Available types of model stores for export.

TGZ = 'tgz'

TAR = 'tar'

TAR_DOT_GZ = 'tar.gz'

BAG_DOT_ZIP = 'bag.zip'

BAG_DOT_TAR = 'bag.tar'

BAG_DOT_TGZ = 'bag.tgz'

ROCRATE_ZIP = 'rocrate.zip'

BCO_JSON = 'bco.json'

classmethod is_compressed(value: ModelStoreFormat)

classmethod is_bag(value: ModelStoreFormat)

class galaxy.schema.schema.StoreContentSource(*, store_content_uri: str | None = None, store_dict: Dict[str, Any] | None = None, model_store_format: ModelStoreFormat | None = None)

Bases: Model

store_content_uri: str | None

store_dict: Dict[str, Any] | None

model_store_format: ModelStoreFormat | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateHistoryFromStore(*, store_content_uri: str | None = None, store_dict: Dict[str, Any] | None = None, model_store_format: ModelStoreFormat | None = None)

Bases: StoreContentSource

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

store_content_uri: str | None

store_dict: Dict[str, Any] | None

model_store_format: ModelStoreFormat | None

class galaxy.schema.schema.StoreExportPayload(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False)

Bases: Model

model_store_format: ModelStoreFormat

include_files: bool

include_deleted: bool

include_hidden: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ShortTermStoreExportPayload(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, short_term_storage_request_id: UUID, duration: int | float | None = None)

Bases: StoreExportPayload

short_term_storage_request_id: UUID

duration: int | float | None[int | float | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.BcoGenerationParametersMixin(*, bco_merge_history_metadata: bool = False, bco_override_environment_variables: Dict[str, str] | None = None, bco_override_empirical_error: Dict[str, str] | None = None, bco_override_algorithmic_error: Dict[str, str] | None = None, bco_override_xref: List[XrefItem] | None = None)

Bases: BaseModel

bco_merge_history_metadata: bool

bco_override_environment_variables: Dict[str, str] | None

bco_override_empirical_error: Dict[str, str] | None

bco_override_algorithmic_error: Dict[str, str] | None

bco_override_xref: List[XrefItem] | None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WriteStoreToPayload(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, target_uri: str)

Bases: StoreExportPayload

target_uri: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ObjectExportResponseBase(*, id: str[str], ready: bool, preparing: bool, up_to_date: bool)

Bases: Model

id: str[str]

ready: bool

preparing: bool

up_to_date: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobExportHistoryArchiveModel(*, id: str[str], ready: bool, preparing: bool, up_to_date: bool, job_id: str[str], download_url: str, external_download_latest_url: AnyUrl, external_download_permanent_url: AnyUrl)

Bases: ObjectExportResponseBase

job_id: str[str]

download_url: str

external_download_latest_url: AnyUrl

external_download_permanent_url: AnyUrl

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportObjectType(value)

Bases: str, Enum

Types of objects that can be exported.

HISTORY = 'history'

INVOCATION = 'invocation'

class galaxy.schema.schema.ExportObjectRequestMetadata(*, object_id: str[str], object_type: ExportObjectType, user_id: str[str] | None = None, payload: WriteStoreToPayload | ShortTermStoreExportPayload)

Bases: Model

object_id: str[str]

object_type: ExportObjectType

user_id: str[str] | None

payload: WriteStoreToPayload | ShortTermStoreExportPayload

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportObjectResultMetadata(*, success: bool, error: str | None = None)

Bases: Model

success: bool

error: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportObjectMetadata(*, request_data: ExportObjectRequestMetadata, result_data: ExportObjectResultMetadata | None = None)

Bases: Model

request_data: ExportObjectRequestMetadata

result_data: ExportObjectResultMetadata | None

is_short_term()

Whether the export is a short term export.

is_ready()

Whether the export has finished and it’s ready to be used.

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ObjectExportTaskResponse(*, id: str[str], ready: bool, preparing: bool, up_to_date: bool, task_uuid: UUID[UUID], create_time: datetime, export_metadata: ExportObjectMetadata | None = None)

Bases: ObjectExportResponseBase

task_uuid: UUID[UUID]

create_time: datetime

export_metadata: ExportObjectMetadata | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobExportHistoryArchiveListResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[JobExportHistoryArchiveModel]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportTaskListResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[ObjectExportTaskResponse]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ArchiveHistoryRequestPayload(*, archive_export_id: int[int] | None = None, purge_history: bool = False)

Bases: Model

archive_export_id: int[int] | None

purge_history: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ExportRecordData(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, target_uri: str)

Bases: WriteStoreToPayload

Data of an export record associated with a history that was archived.

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target_uri: str

model_store_format: ModelStoreFormat

include_files: bool

include_deleted: bool

include_hidden: bool

class galaxy.schema.schema.ExportAssociationData(*, export_record_data: ExportRecordData | None = None)

Bases: Model

export_record_data: ExportRecordData | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ArchivedHistorySummary(*, model_class: typing_extensions.Literal[History], export_record_data: ExportRecordData | None = None, id: str[str], name: str, deleted: bool, purged: bool, archived: bool, url: str, published: bool, count: int, annotation: str | None, tags: TagCollection, update_time: datetime, preferred_object_store_id: str | None = None)

Bases: HistorySummary, ExportAssociationData

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_class: typing_extensions.Literal[History]

id: str[str]

name: str

deleted: bool

purged: bool

archived: bool

url: str[str]

published: bool

count: int

annotation: str | None

tags: TagCollection

update_time: datetime

preferred_object_store_id: str | None

class galaxy.schema.schema.ArchivedHistoryDetailed(*, model_class: typing_extensions.Literal[History], export_record_data: ExportRecordData | None = None, id: str[str], name: str, deleted: bool, purged: bool, archived: bool, url: str, published: bool, count: int, annotation: str | None, tags: TagCollection, update_time: datetime, preferred_object_store_id: str | None = None, contents_url: str, size: int, user_id: str[str] | None = None, create_time: datetime, importable: bool, slug: str | None = None, username: str | None = None, username_and_slug: str | None = None, genome_build: str | None = '?', state: DatasetState, state_ids: Dict[DatasetState, List[int[int]]], state_details: Dict[DatasetState, int])

Bases: HistoryDetailed, ExportAssociationData

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

contents_url: str[str]

size: int

user_id: str[str] | None

create_time: datetime

importable: bool

slug: str | None

username: str | None

username_and_slug: str | None

genome_build: str | None

state: DatasetState

state_ids: Dict[DatasetState, List[int[int]]]

state_details: Dict[DatasetState, int]

model_class: HISTORY_MODEL_CLASS

id: HistoryID

name: str

deleted: bool

purged: bool

archived: bool

url: RelativeUrlField

published: bool

count: int

annotation: str | None

tags: TagCollection

update_time: datetime

preferred_object_store_id: str | None

class galaxy.schema.schema.CustomArchivedHistoryView(*, model_class: typing_extensions.Literal[History] | None = None, export_record_data: ExportRecordData | None = None, id: str | None[str | None] = None, name: str | None = None, deleted: bool | None = None, purged: bool | None = None, archived: bool | None = None, url: str | None = None, published: bool | None = None, count: int | None = None, annotation: str | None = None, tags: TagCollection | None = None, update_time: datetime | None = None, preferred_object_store_id: str | None = None, contents_url: str | None = None, size: int | None = None, user_id: str[str] | None = None, create_time: datetime | None = None, importable: bool | None = None, slug: str | None = None, username: str | None = None, username_and_slug: str | None = None, genome_build: str | None = None, state: DatasetState | None = None, state_ids: Dict[DatasetState, List[int[int]]] | None = None, state_details: Dict[DatasetState, int] | None = None, contents_active: HistoryActiveContentCounts | None = None, contents_states: Dict[DatasetState | DatasetCollectionPopulatedState, int] | None = None, nice_size: str | None = None)

Bases: CustomArchivedHistoryView

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_class: typing_extensions.Literal[History] | None

export_record_data: ExportRecordData | None

id: str | None

name: str | None

deleted: bool | None

purged: bool | None

archived: bool | None

url: str | None

published: bool | None

count: int | None

annotation: str | None

tags: TagCollection | None

update_time: datetime | None

preferred_object_store_id: str | None

contents_url: str | None

size: int | None

user_id: str[str] | None

create_time: datetime | None

importable: bool | None

slug: str | None

username: str | None

username_and_slug: str | None

genome_build: str | None

state: DatasetState | None

state_ids: Dict[DatasetState, List[int[int]]] | None

state_details: Dict[DatasetState, int] | None

contents_active: HistoryActiveContentCounts | None

contents_states: Dict[DatasetState | DatasetCollectionPopulatedState, int] | None

nice_size: str | None

class galaxy.schema.schema.LabelValuePair(*, label: str, value: str)

Bases: Model

Generic Label/Value pair model.

label: str

value: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CustomBuildsMetadataResponse(*, installed_builds: List[LabelValuePair], fasta_hdas: List[LabelValuePair])

Bases: Model

installed_builds: List[LabelValuePair]

fasta_hdas: List[LabelValuePair]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobIdResponse(*, job_id: str[str])

Bases: Model

Contains the ID of the job associated with a particular request.

job_id: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobBaseModel(*, model_class: typing_extensions.Literal[Job], id: str[str], history_id: str[str] | None = None, tool_id: str, state: JobState, exit_code: int | None = None, create_time: datetime, update_time: datetime, galaxy_version: str | None = None)

Bases: Model, WithModelClass

id: str[str]

history_id: str[str] | None

model_class: typing_extensions.Literal[Job]

tool_id: str

state: JobState

exit_code: int | None

create_time: datetime

update_time: datetime

galaxy_version: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobImportHistoryResponse(*, model_class: typing_extensions.Literal[Job], id: str[str], history_id: str[str] | None = None, tool_id: str, state: JobState, exit_code: int | None = None, create_time: datetime, update_time: datetime, galaxy_version: str | None = None, message: str)

Bases: JobBaseModel

message: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ItemStateSummary(*, id: str[str], populated_state: DatasetCollectionPopulatedState, states: Dict[JobState, int] = {})

Bases: Model

id: str[str]

populated_state: DatasetCollectionPopulatedState

states: Dict[JobState, int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobStateSummary(*, id: str[str], populated_state: DatasetCollectionPopulatedState, states: Dict[JobState, int] = {}, model: typing_extensions.Literal[Job])

Bases: ItemStateSummary

model: typing_extensions.Literal[Job]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ImplicitCollectionJobsStateSummary(*, id: str[str], populated_state: DatasetCollectionPopulatedState, states: Dict[JobState, int] = {}, model: typing_extensions.Literal[ImplicitCollectionJobs])

Bases: ItemStateSummary

model: typing_extensions.Literal[ImplicitCollectionJobs]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowInvocationStateSummary(*, id: str[str], populated_state: DatasetCollectionPopulatedState, states: Dict[JobState, int] = {}, model: typing_extensions.Literal[WorkflowInvocation])

Bases: ItemStateSummary

model: typing_extensions.Literal[WorkflowInvocation]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobSummary(*, model_class: typing_extensions.Literal[Job], id: str[str], history_id: str[str] | None = None, tool_id: str, state: JobState, exit_code: int | None = None, create_time: datetime, update_time: datetime, galaxy_version: str | None = None, external_id: str | None = None, handler: str | None = None, job_runner_name: str | None = None, command_line: str | None = None, user_email: str | None = None)

Bases: JobBaseModel

Basic information about a job.

external_id: str | None

handler: str | None

job_runner_name: str | None

command_line: str | None

user_email: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetSourceIdBase(*, src: DatasetSourceType)

Bases: Model

src: DatasetSourceType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetSourceId(*, src: DatasetSourceType, id: int[int])

Bases: DatasetSourceIdBase

id: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.EncodedDatasetSourceId(*, src: DatasetSourceType, id: str[str])

Bases: DatasetSourceIdBase

id: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.EncodedDataItemSourceId(*, id: str[str], src: DataItemSourceType)

Bases: Model

id: str[str]

src: DataItemSourceType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.EncodedJobParameterHistoryItem(*, id: str[str], src: DataItemSourceType, hid: int | None = None, name: str)

Bases: EncodedDataItemSourceId

hid: int | None

name: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetJobInfo(*, src: DatasetSourceType, id: int[int], uuid: UUID[UUID])

Bases: DatasetSourceId

uuid: UUID[UUID]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobDetails(*, model_class: typing_extensions.Literal[Job], id: str[str], history_id: str[str] | None = None, tool_id: str, state: JobState, exit_code: int | None = None, create_time: datetime, update_time: datetime, galaxy_version: str | None = None, external_id: str | None = None, handler: str | None = None, job_runner_name: str | None = None, command_line: str | None = None, user_email: str | None = None, command_version: str, params: Any = None, inputs: Dict[str, DatasetJobInfo] = {}, outputs: Dict[str, DatasetJobInfo] = {})

Bases: JobSummary

command_version: str

params: Any

inputs: Dict[str, DatasetJobInfo]

outputs: Dict[str, DatasetJobInfo]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobMetric(*, title: str, value: str, plugin: str, name: str, raw_value: str)

Bases: Model

title: str

value: str

plugin: str

name: str

raw_value: str

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'name': 'start_epoch', 'plugin': 'core', 'raw_value': '1614261340.0000000', 'title': 'Job Start Time', 'value': '2021-02-25 14:55:40'}}, 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowJobMetric(*, title: str, value: str, plugin: str, name: str, raw_value: str, tool_id: str, job_id: str, step_index: int, step_label: str | None)

Bases: JobMetric

tool_id: str

job_id: str

step_index: int

step_label: str | None

model_config: ClassVar[ConfigDict] = {'json_schema_extra': {'example': {'name': 'start_epoch', 'plugin': 'core', 'raw_value': '1614261340.0000000', 'title': 'Job Start Time', 'value': '2021-02-25 14:55:40'}}, 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobMetricCollection(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

Represents a collection of metrics associated with a Job.

root: List[JobMetric]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.JobFullDetails(*, model_class: typing_extensions.Literal[Job], id: str[str], history_id: str[str] | None = None, tool_id: str, state: JobState, exit_code: int | None = None, create_time: datetime, update_time: datetime, galaxy_version: str | None = None, external_id: str | None = None, handler: str | None = None, job_runner_name: str | None = None, command_line: str | None = None, user_email: str | None = None, command_version: str, params: Any = None, inputs: Dict[str, DatasetJobInfo] = {}, outputs: Dict[str, DatasetJobInfo] = {}, tool_stdout: str, tool_stderr: str, job_stdout: str, job_stderr: str, stdout: str, stderr: str, job_messages: List[str], job_metrics: JobMetricCollection | None = None)

Bases: JobDetails

tool_stdout: str

tool_stderr: str

job_stdout: str

job_stderr: str

stdout: str

stderr: str

job_messages: List[str]

job_metrics: JobMetricCollection | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.StoredWorkflowSummary(*, model_class: typing_extensions.Literal[StoredWorkflow], id: str[str], create_time: datetime, update_time: datetime, name: str, url: str, published: bool, annotations: List[str] | None = None, tags: TagCollection, deleted: bool, hidden: bool, owner: str, latest_workflow_uuid: UUID[UUID] | None = None, number_of_steps: int | None = None, show_in_tool_panel: bool | None = None)

Bases: Model, WithModelClass

id: str[str]

model_class: typing_extensions.Literal[StoredWorkflow]

create_time: datetime

update_time: datetime

name: str

url: str[str]

published: bool

annotations: List[str] | None

tags: TagCollection

deleted: bool

hidden: bool

owner: str

latest_workflow_uuid: UUID[UUID] | None

number_of_steps: int | None

show_in_tool_panel: bool | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowInput(*, label: str | None, value: Any | None, uuid: UUID[UUID] | None)

Bases: Model

label: str | None

value: Any | None

uuid: UUID[UUID] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowOutput(*, label: str | None = None, output_name: str, uuid: UUID[UUID] | None = None)

Bases: Model

label: str | None

output_name: str

uuid: UUID[UUID] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InputStep(*, source_step: int, step_output: str)

Bases: Model

source_step: int

step_output: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowStepBase(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None)

Bases: Model

id: int

annotation: str | None

input_steps: Dict[str, InputStep]

when: str | None

tool_id: str | None

tool_version: str | None

tool_inputs: Any

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InputDataStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[data_input])

Bases: WorkflowStepBase

type: typing_extensions.Literal[data_input]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InputDataCollectionStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[data_collection_input])

Bases: WorkflowStepBase

type: typing_extensions.Literal[data_collection_input]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InputParameterStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[parameter_input])

Bases: WorkflowStepBase

type: typing_extensions.Literal[parameter_input]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PauseStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[pause])

Bases: WorkflowStepBase

type: typing_extensions.Literal[pause]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[tool])

Bases: WorkflowStepBase

type: typing_extensions.Literal[tool]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SubworkflowStep(*, id: int, annotation: str | None, input_steps: Dict[str, InputStep], when: str | None, tool_id: str | None = None, tool_version: str | None = None, tool_inputs: Any = None, type: typing_extensions.Literal[subworkflow], workflow_id: str[str])

Bases: WorkflowStepBase

type: typing_extensions.Literal[subworkflow]

workflow_id: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Creator(*, class_: str, name: str | None = None, address: str | None = None, alternateName: str | None = None, email: str | None = None, faxNumber: str | None = None, identifier: str | None = None, image: AnyHttpUrl | None = None, telephone: str | None = None, url: AnyHttpUrl | None = None)

Bases: Model

class_: str

name: str | None

address: str | None

alternate_name: str | None

email: str | None

fax_number: str | None

identifier: str | None

image: AnyHttpUrl | None

telephone: str | None

url: AnyHttpUrl | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Organization(*, class_: str = 'Organization', name: str | None = None, address: str | None = None, alternateName: str | None = None, email: str | None = None, faxNumber: str | None = None, identifier: str | None = None, image: AnyHttpUrl | None = None, telephone: str | None = None, url: AnyHttpUrl | None = None)

Bases: Creator

class_: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Person(*, class_: str = 'Person', name: str | None = None, address: str | None = None, alternateName: str | None = None, email: str | None = None, faxNumber: str | None = None, identifier: str | None = None, image: AnyHttpUrl | None = None, telephone: str | None = None, url: AnyHttpUrl | None = None, familyName: str | None = None, givenName: str | None = None, honorificPrefix: str | None = None, honorificSuffix: str | None = None, jobTitle: str | None = None)

Bases: Creator

class_: str

family_name: str | None

givenName: str | None

honorific_prefix: str | None

honorific_suffix: str | None

job_title: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Input(*, name: str, description: str)

Bases: Model

name: str

description: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.Output(*, name: str, type: str)

Bases: Model

name: str

type: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InputConnection(*, id: int, output_name: str, input_subworkflow_step_id: int | None = None)

Bases: Model

id: int

output_name: str

input_subworkflow_step_id: int | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowStepLayoutPosition(*, bottom: int, top: int, left: int, right: int, x: int, y: int, height: int, width: int)

Bases: Model

Position and dimensions of the workflow step represented by a box on the graph.

bottom: int

top: int

left: int

right: int

x: int

y: int

height: int

width: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowStepToExportBase(*, id: int, type: str, name: str, annotation: str | None, tool_id: str | None = None, uuid: UUID[UUID], label: str | None = None, inputs: List[Input], outputs: List[Output], input_connections: Dict[str, InputConnection] = {}, position: WorkflowStepLayoutPosition, workflow_outputs: List[WorkflowOutput] = [])

Bases: Model

id: int

type: str

name: str

annotation: str | None

tool_id: str | None

uuid: UUID[UUID]

label: str | None

inputs: List[Input]

outputs: List[Output]

input_connections: Dict[str, InputConnection]

position: WorkflowStepLayoutPosition

workflow_outputs: List[WorkflowOutput]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowStepToExport(*, id: int, type: str, name: str, annotation: str | None, tool_id: str | None = None, uuid: UUID[UUID], label: str | None = None, inputs: List[Input], outputs: List[Output], input_connections: Dict[str, InputConnection] = {}, position: WorkflowStepLayoutPosition, workflow_outputs: List[WorkflowOutput] = [], content_id: str | None = None, tool_version: str | None = None, tool_state: Json, errors: str | None = None)

Bases: WorkflowStepToExportBase

content_id: str | None

tool_version: str | None

tool_state: Json

errors: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolShedRepositorySummary(*, name: str, owner: str, changeset_revision: str, tool_shed: str)

Bases: Model

name: str

owner: str

changeset_revision: str

tool_shed: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PostJobAction(*, action_type: str, output_name: str, action_arguments: Dict[str, Any])

Bases: Model

action_type: str

output_name: str

action_arguments: Dict[str, Any]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowToolStepToExport(*, id: int, type: str, name: str, annotation: str | None, tool_id: str | None = None, uuid: UUID[UUID], label: str | None = None, inputs: List[Input], outputs: List[Output], input_connections: Dict[str, InputConnection] = {}, position: WorkflowStepLayoutPosition, workflow_outputs: List[WorkflowOutput] = [], tool_shed_repository: ToolShedRepositorySummary, post_job_actions: Dict[str, PostJobAction])

Bases: WorkflowStepToExportBase

tool_shed_repository: ToolShedRepositorySummary

post_job_actions: Dict[str, PostJobAction]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SubworkflowStepToExport(*, id: int, type: str, name: str, annotation: str | None, tool_id: str | None = None, uuid: UUID[UUID], label: str | None = None, inputs: List[Input], outputs: List[Output], input_connections: Dict[str, InputConnection] = {}, position: WorkflowStepLayoutPosition, workflow_outputs: List[WorkflowOutput] = [])

Bases: WorkflowStepToExportBase

subworkflow: WorkflowToExport

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowToExport(*, a_galaxy_workflow: str = 'true', format_version: str = '0.1', name: str, annotation: str | None, tags: TagCollection, uuid: UUID[UUID] | None = None, creator: List[Person | Organization] | None = None, license: str | None = None, version: int, steps: Dict[int, SubworkflowStepToExport | WorkflowToolStepToExport | WorkflowStepToExport] = {})

Bases: Model

a_galaxy_workflow: str

format_version: str

name: str

annotation: str | None

tags: TagCollection

uuid: UUID[UUID] | None

creator: List[Person | Organization] | None

license: str | None

version: int

steps: Dict[int, SubworkflowStepToExport | WorkflowToolStepToExport | WorkflowStepToExport]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.BasicRoleModel(*, id: str[str], name: str, type: str)

Bases: Model

id: str[str]

name: str[str]

type: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.RoleModelResponse(*, model_class: typing_extensions.Literal[Role], id: str[str], name: str, type: str, description: str[str] | None, url: str)

Bases: BasicRoleModel, WithModelClass

description: str[str] | None

url: str[str]

model_class: typing_extensions.Literal[Role]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.RoleDefinitionModel(*, name: str, description: str, user_ids: List[int[int]] | None = [], group_ids: List[int[int]] | None = [])

Bases: Model

name: str[str]

description: str[str]

user_ids: List[int[int]] | None

group_ids: List[int[int]] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.RoleListResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[RoleModelResponse]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.GroupRoleResponse(*, id: str[str], name: str, url: str)

Bases: Model

id: str[str]

name: str[str]

url: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.GroupRoleListResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[GroupRoleResponse]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.GroupUserResponse(*, id: str[str], email: str, url: str)

Bases: Model

id: str[str]

email: str

url: str[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.GroupUserListResponse(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[GroupUserResponse]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ImportToolDataBundleUriSource(*, src: typing_extensions.Literal[uri], uri: str)

Bases: Model

src: typing_extensions.Literal[uri]

uri: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ImportToolDataBundleDatasetSource(*, src: typing_extensions.Literal[hda, ldda], id: int[int])

Bases: Model

src: typing_extensions.Literal[hda, ldda]

id: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolShedRepository(*, tool_shed_url: str = 'https://toolshed.g2.bx.psu.edu/', name: str, owner: str)

Bases: Model

tool_shed_url: str

name: str

owner: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolShedRepositoryChangeset(*, tool_shed_url: str = 'https://toolshed.g2.bx.psu.edu/', name: str, owner: str, changeset_revision: str)

Bases: ToolShedRepository

changeset_revision: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InstalledRepositoryToolShedStatus(*, latest_installable_revision: str | None, revision_update: str, revision_upgrade: str | None = None, repository_deprecated: str | None)

Bases: Model

latest_installable_revision: str | None

revision_update: str

revision_upgrade: str | None

repository_deprecated: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InstalledToolShedRepository(*, model_class: typing_extensions.Literal[ToolShedRepository], id: str[str], status: str, name: str, owner: str, deleted: bool, ctx_rev: str | None, error_message: str = 'Installation error message, the empty string means no error was recorded', installed_changeset_revision: str, tool_shed: str, dist_to_shed: bool, uninstalled: bool, changeset_revision: str, tool_shed_status: InstalledRepositoryToolShedStatus | None)

Bases: Model, WithModelClass

model_class: typing_extensions.Literal[ToolShedRepository]

id: str[str]

status: str

name: str

owner: str

deleted: bool

ctx_rev: str | None

error_message: str

installed_changeset_revision: str

tool_shed: str

dist_to_shed: bool

uninstalled: bool

changeset_revision: str

tool_shed_status: InstalledRepositoryToolShedStatus | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.InstalledToolShedRepositories(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[InstalledToolShedRepository]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CheckForUpdatesResponse(*, status: typing_extensions.Literal[ok, error], message: str)

Bases: Model

status: typing_extensions.Literal[ok, error]

message: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryPermissionScope(value)

Bases: str, Enum

An enumeration.

current = 'current'

available = 'available'

class galaxy.schema.schema.LibraryLegacySummary(*, model_class: typing_extensions.Literal[Library], id: str[str], name: str, description: str | None = '', synopsis: str | None = None, root_folder_id: str[str], create_time: datetime, deleted: bool)

Bases: Model, WithModelClass

model_class: typing_extensions.Literal[Library]

id: str[str]

name: str

description: str | None

synopsis: str | None

root_folder_id: str[str]

create_time: datetime

deleted: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibrarySummary(*, model_class: typing_extensions.Literal[Library], id: str[str], name: str, description: str | None = '', synopsis: str | None = None, root_folder_id: str[str], create_time: datetime, deleted: bool, create_time_pretty: str, public: bool, can_user_add: bool, can_user_modify: bool, can_user_manage: bool)

Bases: LibraryLegacySummary

create_time_pretty: str

public: bool

can_user_add: bool

can_user_modify: bool

can_user_manage: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibrarySummaryList(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[LibrarySummary]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateLibraryPayload(*, name: str, description: str | None = '', synopsis: str | None = '')

Bases: Model

name: str

description: str | None

synopsis: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateLibrariesFromStore(*, store_content_uri: str | None = None, store_dict: Dict[str, Any] | None = None, model_store_format: ModelStoreFormat | None = None)

Bases: StoreContentSource

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

store_content_uri: str | None

store_dict: Dict[str, Any] | None

model_store_format: ModelStoreFormat | None

class galaxy.schema.schema.UpdateLibraryPayload(*, name: str | None = None, description: str | None = None, synopsis: str | None = None)

Bases: Model

name: str | None

description: str | None

synopsis: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DeleteLibraryPayload(*, undelete: bool)

Bases: Model

undelete: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryCurrentPermissions(*, access_library_role_list: List[List[str]], modify_library_role_list: List[List[str]], manage_library_role_list: List[List[str]], add_library_item_role_list: List[List[str]])

Bases: Model

access_library_role_list: List[List[str]]

modify_library_role_list: List[List[str]]

manage_library_role_list: List[List[str]]

add_library_item_role_list: List[List[str]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LegacyLibraryPermissionsPayload(*, LIBRARY_ACCESS_in: List[int[int]] | int[int] | None = [], LIBRARY_MODIFY_in: List[int[int]] | int[int] | None = [], LIBRARY_ADD_in: List[int[int]] | int[int] | None = [], LIBRARY_MANAGE_in: List[int[int]] | int[int] | None = [])

Bases: RequireOneSetOption

LIBRARY_ACCESS_in: List[int[int]] | int[int] | None

LIBRARY_MODIFY_in: List[int[int]] | int[int] | None

LIBRARY_ADD_in: List[int[int]] | int[int] | None

LIBRARY_MANAGE_in: List[int[int]] | int[int] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryPermissionAction(value)

Bases: str, Enum

An enumeration.

set_permissions = 'set_permissions'

remove_restrictions = 'remove_restrictions'

class galaxy.schema.schema.DatasetPermissionAction(value)

Bases: str, Enum

An enumeration.

set_permissions = 'set_permissions'

make_private = 'make_private'

remove_restrictions = 'remove_restrictions'

class galaxy.schema.schema.LibraryPermissionsPayloadBase(*, add_ids: List[int[int]] | int[int] | None = [], manage_ids: List[int[int]] | int[int] | None = [], modify_ids: List[int[int]] | int[int] | None = [])

Bases: RequireOneSetOption

add_ids: List[int[int]] | int[int] | None

manage_ids: List[int[int]] | int[int] | None

modify_ids: List[int[int]] | int[int] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryPermissionsPayload(*, add_ids: List[int[int]] | int[int] | None = [], manage_ids: List[int[int]] | int[int] | None = [], modify_ids: List[int[int]] | int[int] | None = [], action: LibraryPermissionAction | None = None, access_ids: List[int[int]] | int[int] | None = [])

Bases: LibraryPermissionsPayloadBase

action: LibraryPermissionAction | None

access_ids: List[int[int]] | int[int] | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderPermissionAction(value)

Bases: str, Enum

An enumeration.

set_permissions = 'set_permissions'

class galaxy.schema.schema.LibraryFolderPermissionsPayload(*, add_ids: List[int[int]] | int[int] | None = [], manage_ids: List[int[int]] | int[int] | None = [], modify_ids: List[int[int]] | int[int] | None = [], action: LibraryFolderPermissionAction | None = None)

Bases: LibraryPermissionsPayloadBase

action: LibraryFolderPermissionAction | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderDetails(*, model_class: typing_extensions.Literal[LibraryFolder], id: str[str], name: str, description: str | None = '', item_count: int, parent_library_id: str[str], parent_id: str[str] | None = None, genome_build: str | None = '?', update_time: datetime, deleted: bool, library_path: List[str] = [])

Bases: Model, WithModelClass

model_class: typing_extensions.Literal[LibraryFolder]

id: str[str]

name: str

description: str | None

item_count: int

parent_library_id: str[str]

parent_id: str[str] | None

genome_build: str | None

update_time: datetime

deleted: bool

library_path: List[str]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateLibraryFolderPayload(*, name: str, description: str | None = '')

Bases: Model

name: str

description: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateLibraryFolderPayload(*, name: str | None = None, description: str | None = None)

Bases: Model

name: str | None

description: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryAvailablePermissions(*, roles: List[BasicRoleModel], page: int, page_limit: int, total: int)

Bases: Model

roles: List[BasicRoleModel]

page: int

page_limit: int

total: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderCurrentPermissions(*, modify_folder_role_list: List[List[str]], manage_folder_role_list: List[List[str]], add_library_item_role_list: List[List[str]])

Bases: Model

modify_folder_role_list: List[List[str]]

manage_folder_role_list: List[List[str]]

add_library_item_role_list: List[List[str]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderContentsIndexQueryPayload(*, limit: int = 10, offset: int = 0, search_text: str | None = None, include_deleted: bool | None = None, order_by: typing_extensions.Literal[name, description, type, size, update_time] = 'name', sort_desc: bool | None = False)

Bases: Model

limit: int

offset: int

search_text: str | None

include_deleted: bool | None

order_by: typing_extensions.Literal[name, description, type, size, update_time]

sort_desc: bool | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderItemBase(*, name: str, type: str, create_time: datetime, update_time: datetime, can_manage: bool, deleted: bool)

Bases: Model

name: str

type: str

create_time: datetime

update_time: datetime

can_manage: bool

deleted: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.FolderLibraryFolderItem(*, name: str, type: typing_extensions.Literal[folder], create_time: datetime, update_time: datetime, can_manage: bool, deleted: bool, id: str[str], can_modify: bool, description: str | None = '')

Bases: LibraryFolderItemBase

id: str[str]

type: typing_extensions.Literal[folder]

can_modify: bool

description: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.FileLibraryFolderItem(*, name: str, type: typing_extensions.Literal[file], create_time: datetime, update_time: datetime, can_manage: bool, deleted: bool, id: str[str], file_ext: str, date_uploaded: datetime, is_unrestricted: bool, is_private: bool, state: DatasetState[DatasetState], file_size: str, raw_size: int, ldda_id: str[str], tags: TagCollection, message: str | None = None)

Bases: LibraryFolderItemBase

id: str[str]

type: typing_extensions.Literal[file]

file_ext: str

date_uploaded: datetime

is_unrestricted: bool

is_private: bool

state: DatasetState[DatasetState]

file_size: str

raw_size: int

ldda_id: str[str]

tags: TagCollection

message: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderMetadata(*, parent_library_id: str[str], folder_name: str, folder_description: str, total_rows: int, can_modify_folder: bool, can_add_library_item: bool, full_path: List[Tuple[str[str], str]])

Bases: Model

parent_library_id: str[str]

folder_name: str

folder_description: str

total_rows: int

can_modify_folder: bool

can_add_library_item: bool

full_path: List[Tuple[str[str], str]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LibraryFolderContentsIndexResult(*, metadata: LibraryFolderMetadata, folder_contents: List[FileLibraryFolderItem | galaxy.schema.schema.FolderLibraryFolderItem[FileLibraryFolderItem | FolderLibraryFolderItem]])

Bases: Model

metadata: LibraryFolderMetadata

folder_contents: List[FileLibraryFolderItem | galaxy.schema.schema.FolderLibraryFolderItem[FileLibraryFolderItem | FolderLibraryFolderItem]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateLibraryFilePayload(*, from_hda_id: int[int] | None = None, from_hdca_id: int[int] | None = None, ldda_message: str | None = '')

Bases: Model

from_hda_id: int[int] | None

from_hdca_id: int[int] | None

ldda_message: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DatasetAssociationRoles(*, access_dataset_roles: List[List[str]] = [], manage_dataset_roles: List[List[str]] = [], modify_item_roles: List[List[str]] = [])

Bases: Model

access_dataset_roles: List[List[str]]

manage_dataset_roles: List[List[str]]

modify_item_roles: List[List[str]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateDatasetPermissionsPayloadBase(*, action: DatasetPermissionAction | None = DatasetPermissionAction.set_permissions)

Bases: Model

action: DatasetPermissionAction | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateDatasetPermissionsPayload(*, action: DatasetPermissionAction | None = DatasetPermissionAction.set_permissions, access_ids: List[int[int]] | int[int] | None = None, manage_ids: List[int[int]] | int[int] | None = None, modify_ids: List[int[int]] | int[int] | None = None)

Bases: UpdateDatasetPermissionsPayloadBase

access_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

manage_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

modify_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateDatasetPermissionsPayloadAliasB(*, action: DatasetPermissionAction | None = DatasetPermissionAction.set_permissions, access: List[int[int]] | int[int] | None = None, manage: List[int[int]] | int[int] | None = None, modify: List[int[int]] | int[int] | None = None)

Bases: UpdateDatasetPermissionsPayloadBase

access: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

manage: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

modify: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UpdateDatasetPermissionsPayloadAliasC(*, action: DatasetPermissionAction | None = DatasetPermissionAction.set_permissions, access_ids: List[int[int]] | int[int] | None = None, manage_ids: List[int[int]] | int[int] | None = None, modify_ids: List[int[int]] | int[int] | None = None)

Bases: UpdateDatasetPermissionsPayloadBase

access_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

manage_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

modify_ids: List[int[int]] | int[int] | None[List[int[int]] | int[int] | None]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDACustom(*, model_class: typing_extensions.Literal[HistoryDatasetAssociation] | None = None, id: str | None[str | None] = None, name: str | None = None, history_id: str | None[str | None] = None, hid: int | None = None, deleted: bool | None = None, visible: bool | None = None, type_id: str | None = None, type: typing_extensions.Literal[file] | None = None, create_time: datetime | None = None, update_time: datetime | None = None, url: str | None = None, tags: TagCollection | None = None, history_content_type: typing_extensions.Literal[dataset] | None = None, copied_from_ldda_id: str[str] | None = None, dataset_id: str | None[str | None] = None, state: DatasetState | None[DatasetState | None] = None, extension: str | None = None, purged: bool | None = None, genome_build: str | None = None, hda_ldda: DatasetSourceType | None = None, accessible: bool | None = None, misc_info: str | None = None, misc_blurb: str | None = None, file_ext: str | None = None, file_size: int | None = None, resubmitted: bool | None = None, metadata: Any | None = None, meta_files: List[MetadataFile] | None = None, data_type: str | None = None, peek: str | None = None, creating_job: str | None = None, rerunnable: bool | None = None, uuid: UUID[UUID] | None = None, permissions: DatasetPermissions | None = None, file_name: str | None = None, display_apps: List[DisplayApp] | None = None, display_types: List[DisplayApp] | None = None, validated_state: DatasetValidatedState | None = None, validated_state_message: str | None = None, annotation: str | None = None, download_url: str | None = None, api_type: typing_extensions.Literal[file] | None = None, created_from_basename: str | None = None, hashes: List[DatasetHash] | None = None, drs_id: str | None = None, sources: List[DatasetSource] | None = None, copied_from_history_dataset_association_id: str[str] | None = None, visualizations: List[Visualization] | None = None, **extra_data: Any)

Bases: HDACustom

uuid: UUID[UUID] | None

visualizations: List[Visualization] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_class: typing_extensions.Literal[HistoryDatasetAssociation] | None

id: str | None

name: str | None

history_id: str | None

hid: int | None

deleted: bool | None

visible: bool | None

type_id: str | None

type: typing_extensions.Literal[file] | None

create_time: datetime | None

update_time: datetime | None

url: str | None

tags: TagCollection | None

history_content_type: typing_extensions.Literal[dataset] | None

copied_from_ldda_id: str[str] | None

dataset_id: str | None

state: DatasetState | None

extension: str | None

purged: bool | None

genome_build: str | None

hda_ldda: DatasetSourceType | None

accessible: bool | None

misc_info: str | None

misc_blurb: str | None

file_ext: str | None

file_size: int | None

resubmitted: bool | None

metadata: Any | None

meta_files: List[MetadataFile] | None

data_type: str | None

peek: str | None

creating_job: str | None

rerunnable: bool | None

permissions: DatasetPermissions | None

file_name: str | None

display_apps: List[DisplayApp] | None

display_types: List[DisplayApp] | None

validated_state: DatasetValidatedState | None

validated_state_message: str | None

annotation: str | None

download_url: str | None

api_type: typing_extensions.Literal[file] | None

created_from_basename: str | None

hashes: List[DatasetHash] | None

drs_id: str | None

sources: List[DatasetSource] | None

copied_from_history_dataset_association_id: str[str] | None

class galaxy.schema.schema.HDCACustom(*, model_class: typing_extensions.Literal[HistoryDatasetCollectionAssociation] | None = None, id: str | None[str | None] = None, name: str | None = None, history_id: str | None[str | None] = None, hid: int | None = None, deleted: bool | None = None, visible: bool | None = None, type_id: str | None = None, type: typing_extensions.Literal[collection] | None = None, create_time: datetime | None = None, update_time: datetime | None = None, url: str | None = None, tags: TagCollection | None = None, history_content_type: typing_extensions.Literal[dataset_collection] | None = None, collection_type: str | None = None, populated_state: DatasetCollectionPopulatedState | None = None, populated_state_message: str | None = None, element_count: int | None = None, elements_datatypes: Set[str] | None = None, job_source_id: str[str] | None = None, job_source_type: JobSourceType | None = None, job_state_summary: HDCJobStateSummary | None = None, contents_url: str | None = None, collection_id: str | None[str | None] = None, populated: bool | None = None, elements: List[DCESummary] | None = None, implicit_collection_jobs_id: str[str] | None = None)

Bases: HDCACustom

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_class: typing_extensions.Literal[HistoryDatasetCollectionAssociation] | None

id: str | None

name: str | None

history_id: str | None

hid: int | None

deleted: bool | None

visible: bool | None

type_id: str | None

type: typing_extensions.Literal[collection] | None

create_time: datetime | None

update_time: datetime | None

url: str | None

tags: TagCollection | None

history_content_type: typing_extensions.Literal[dataset_collection] | None

collection_type: str | None

populated_state: DatasetCollectionPopulatedState | None

populated_state_message: str | None

element_count: int | None

elements_datatypes: Set[str] | None

job_source_id: str[str] | None

job_source_type: JobSourceType | None

job_state_summary: HDCJobStateSummary | None

contents_url: str | None

collection_id: str | None

populated: bool | None

elements: List[DCESummary] | None

implicit_collection_jobs_id: str[str] | None

class galaxy.schema.schema.DeleteHistoryContentPayload(*, purge: bool = False, recursive: bool = False, stop_job: bool = False)

Bases: Model

purge: bool

recursive: bool

stop_job: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.DeleteHistoryContentResult(*, id: int[int], deleted: bool, purged: bool | None = None)

Bases: Model

Contains minimum information about the deletion state of a history item.

Can also contain any other properties of the item.

id: int[int]

deleted: bool

purged: bool | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentsArchiveDryRunResult(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

Contains a collection of filepath/filename entries that represent the contents that would have been included in the archive. This is returned when the dry_run flag is active when creating an archive with the contents of the history.

This is used for debugging purposes.

root: List[Tuple[str, str]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentStats(*, total_matches: int)

Bases: Model

total_matches: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentsResult(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

List of history content items. Can contain different views and kinds of items.

root: List[HDACustom | galaxy.schema.schema.HDADetailed | galaxy.schema.schema.HDASummary | galaxy.schema.schema.HDAInaccessible | galaxy.schema.schema.HDCACustom | galaxy.schema.schema.HDCADetailed | galaxy.schema.schema.HDCASummary[HDACustom | HDADetailed | HDASummary | HDAInaccessible | HDCACustom | HDCADetailed | HDCASummary]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HistoryContentsWithStatsResult(*, stats: HistoryContentStats, contents: List[HDACustom | galaxy.schema.schema.HDADetailed | galaxy.schema.schema.HDASummary | galaxy.schema.schema.HDAInaccessible | galaxy.schema.schema.HDCACustom | galaxy.schema.schema.HDCADetailed | galaxy.schema.schema.HDCASummary[HDACustom | HDADetailed | HDASummary | HDAInaccessible | HDCACustom | HDCADetailed | HDCASummary]])

Bases: Model

Includes stats with items counting

stats: HistoryContentStats

contents: List[HDACustom | galaxy.schema.schema.HDADetailed | galaxy.schema.schema.HDASummary | galaxy.schema.schema.HDAInaccessible | galaxy.schema.schema.HDCACustom | galaxy.schema.schema.HDCADetailed | galaxy.schema.schema.HDCASummary[HDACustom | HDADetailed | HDASummary | HDAInaccessible | HDCACustom | HDCADetailed | HDCASummary]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SharingOptions(value)

Bases: str, Enum

Options for sharing resources that may have restricted access to all or part of their contents.

make_public = 'make_public'

make_accessible_to_shared = 'make_accessible_to_shared'

no_changes = 'no_changes'

class galaxy.schema.schema.ShareWithExtra(*, can_share: bool = False)

Bases: Model

can_share: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ShareWithPayload(*, user_ids: List[int[int] | str], share_option: SharingOptions | None = None)

Bases: Model

user_ids: List[int[int] | str]

share_option: SharingOptions | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SetSlugPayload(*, new_slug: str)

Bases: Model

new_slug: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UserEmail(*, id: str[str], email: str)

Bases: Model

id: str[str]

email: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.UserBeaconSetting(*, enabled: bool)

Bases: Model

enabled: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SharingStatus(*, id: str[str], title: str, importable: bool, published: bool, users_shared_with: List[UserEmail] = [], email_hash: str | None = None, username: str | None = None, username_and_slug: str | None = None)

Bases: Model

id: str[str]

title: str

importable: bool

published: bool

users_shared_with: List[UserEmail]

email_hash: str | None

username: str | None

username_and_slug: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.HDABasicInfo(*, id: str[str], name: str)

Bases: Model

id: str[str]

name: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ShareHistoryExtra(*, can_share: bool = False, can_change: List[HDABasicInfo] = [], cannot_change: List[HDABasicInfo] = [], accessible_count: int = 0)

Bases: ShareWithExtra

can_change: List[HDABasicInfo]

cannot_change: List[HDABasicInfo]

accessible_count: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ShareWithStatus(*, id: str[str], title: str, importable: bool, published: bool, users_shared_with: List[UserEmail] = [], email_hash: str | None = None, username: str | None = None, username_and_slug: str | None = None, errors: List[str] = [], extra: ShareWithExtra | None = None)

Bases: SharingStatus

errors: List[str]

extra: ShareWithExtra | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ShareHistoryWithStatus(*, id: str[str], title: str, importable: bool, published: bool, users_shared_with: List[UserEmail] = [], email_hash: str | None = None, username: str | None = None, username_and_slug: str | None = None, errors: List[str] = [], extra: ShareHistoryExtra)

Bases: ShareWithStatus

extra: ShareHistoryExtra

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PageContentFormat(value)

Bases: str, Enum

An enumeration.

markdown = 'markdown'

html = 'html'

class galaxy.schema.schema.PageSummaryBase(*, title: str, slug: str[str])

Bases: Model

title: str

slug: str

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.MaterializeDatasetInstanceAPIRequest(*, source: DatasetSourceType, content: int[int])

Bases: Model

source: DatasetSourceType

content: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.MaterializeDatasetInstanceRequest(*, source: DatasetSourceType, content: int[int], history_id: int[int])

Bases: MaterializeDatasetInstanceAPIRequest

history_id: int[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ChatPayload(*, query: str, context: str | None = '')

Bases: Model

query: str

context: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreatePagePayload(*, title: str, slug: str[str], content_format: PageContentFormat = PageContentFormat.html, content: str | None = '', annotation: str | None = None, invocation_id: int[int] | None = None, **extra_data: Any)

Bases: PageSummaryBase

content_format: PageContentFormat

content: str | None

annotation: str | None

invocation_id: int[int] | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.AsyncTaskResultSummary(*, id: str, ignored: bool, name: str | None = None, queue: str | None = None)

Bases: Model

id: str

ignored: bool

name: str | None

queue: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolRequestState(value)

Bases: str, Enum

An enumeration.

NEW = 'new'

SUBMITTED = 'submitted'

FAILED = 'failed'

class galaxy.schema.schema.ToolRequestModel(*, id: str[str], request: Dict[str, Any], state: ToolRequestState, state_message: str | None)

Bases: Model

id: str[str]

request: Dict[str, Any]

state: ToolRequestState

state_message: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.AsyncFile(*, storage_request_id: UUID, task: AsyncTaskResultSummary)

Bases: Model

storage_request_id: UUID

task: AsyncTaskResultSummary

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PageSummary(*, model_class: typing_extensions.Literal[Page], title: str, slug: str[str], id: str[str], username: str, email_hash: str, published: bool, importable: bool, deleted: bool, latest_revision_id: str[str], revision_ids: List[str[str]], create_time: datetime, update_time: datetime, tags: TagCollection)

Bases: PageSummaryBase, WithModelClass

id: str[str]

model_class: typing_extensions.Literal[Page]

username: str

email_hash: str

published: bool

importable: bool

deleted: bool

latest_revision_id: str[str]

revision_ids: List[str[str]]

create_time: datetime

update_time: datetime

tags: TagCollection

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.OAuth2State(*, route: str, nonce: str)

Bases: BaseModel

route: str

nonce: str

encode() → str

static decode(base64_param: str) → OAuth2State

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PageDetails(*, model_class: typing_extensions.Literal[Page], title: str, slug: str[str], id: str[str], username: str, email_hash: str, published: bool, importable: bool, deleted: bool, latest_revision_id: str[str], revision_ids: List[str[str]], create_time: datetime, update_time: datetime, tags: TagCollection, content_format: PageContentFormat = PageContentFormat.html, content: str | None = '', generate_version: str | None = None, generate_time: str | None = None, **extra_data: Any)

Bases: PageSummary

content_format: PageContentFormat

content: str | None

generate_version: str | None

generate_time: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.PageSummaryList(root: RootModelRootType = PydanticUndefined)

Bases: RootModel

root: List[PageSummary]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.LandingRequestState(value)

Bases: str, Enum

An enumeration.

UNCLAIMED = 'unclaimed'

CLAIMED = 'claimed'

class galaxy.schema.schema.CreateToolLandingRequestPayload(*, tool_id: str, tool_version: str | None = None, request_state: Dict[str, Any] | None = None, client_secret: str | None = None, public: bool = False)

Bases: Model

tool_id: str

tool_version: str | None

request_state: Dict[str, Any] | None

client_secret: str | None

public: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.CreateWorkflowLandingRequestPayload(*, workflow_id: str, workflow_target_type: typing_extensions.Literal[stored_workflow, workflow, trs_url], request_state: Dict[str, Any] | None = None, client_secret: str | None = None, public: bool = False)

Bases: Model

workflow_id: str

workflow_target_type: typing_extensions.Literal[stored_workflow, workflow, trs_url]

request_state: Dict[str, Any] | None

client_secret: str | None

public: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ClaimLandingPayload(*, client_secret: str | None = None)

Bases: Model

client_secret: str | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.ToolLandingRequest(*, uuid: UUID[UUID], tool_id: str, tool_version: str | None = None, request_state: Dict[str, Any] | None = None, state: LandingRequestState)

Bases: Model

uuid: UUID[UUID]

tool_id: str

tool_version: str | None

request_state: Dict[str, Any] | None

state: LandingRequestState

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.WorkflowLandingRequest(*, uuid: UUID[UUID], workflow_id: str, workflow_target_type: typing_extensions.Literal[stored_workflow, workflow, trs_url], request_state: Dict[str, Any], state: LandingRequestState)

Bases: Model

uuid: UUID[UUID]

workflow_id: str

workflow_target_type: typing_extensions.Literal[stored_workflow, workflow, trs_url]

request_state: Dict[str, Any]

state: LandingRequestState

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.MessageExceptionModel(*, err_msg: str, err_code: int)

Bases: BaseModel

err_msg: str

err_code: int

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.schema.SanitizedString

Bases: str

classmethod validate(value)

galaxy.schema.tasks module

class galaxy.schema.tasks.SetupHistoryExportJob(*, history_id: int, job_id: int, store_directory: str, include_files: bool, include_hidden: bool, include_deleted: bool)

Bases: Model

history_id: int

job_id: int

store_directory: str

include_files: bool

include_hidden: bool

include_deleted: bool

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.PrepareDatasetCollectionDownload(*, short_term_storage_request_id: UUID, history_dataset_collection_association_id: int)

Bases: Model

short_term_storage_request_id: UUID

history_dataset_collection_association_id: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.GeneratePdfDownload(*, short_term_storage_request_id: UUID, basic_markdown: str, document_type: PdfDocumentType)

Bases: Model

short_term_storage_request_id: UUID

basic_markdown: str

document_type: PdfDocumentType

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.RequestUser(*, user_id: int)

Bases: Model

user_id: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.GenerateHistoryDownload(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, short_term_storage_request_id: UUID, duration: int | float | None = None, history_id: int, user: RequestUser, export_association_id: int | None = None)

Bases: ShortTermStoreExportPayload

history_id: int

user: RequestUser

export_association_id: int | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.GenerateHistoryContentDownload(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, short_term_storage_request_id: UUID, duration: int | float | None = None, content_type: HistoryContentType, content_id: int, user: RequestUser)

Bases: ShortTermStoreExportPayload

content_type: HistoryContentType

content_id: int

user: RequestUser

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.BcoGenerationTaskParametersMixin(*, bco_merge_history_metadata: bool = False, bco_override_environment_variables: Dict[str, str] | None = None, bco_override_empirical_error: Dict[str, str] | None = None, bco_override_algorithmic_error: Dict[str, str] | None = None, bco_override_xref: List[XrefItem] | None = None, galaxy_url: str)

Bases: BcoGenerationParametersMixin

galaxy_url: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.GenerateInvocationDownload(*, bco_merge_history_metadata: bool = False, bco_override_environment_variables: Dict[str, str] | None = None, bco_override_empirical_error: Dict[str, str] | None = None, bco_override_algorithmic_error: Dict[str, str] | None = None, bco_override_xref: List[XrefItem] | None = None, galaxy_url: str, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, short_term_storage_request_id: UUID, duration: int | float | None = None, invocation_id: int, user: RequestUser)

Bases: ShortTermStoreExportPayload, BcoGenerationTaskParametersMixin

invocation_id: int

user: RequestUser

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.WriteInvocationTo(*, bco_merge_history_metadata: bool = False, bco_override_environment_variables: Dict[str, str] | None = None, bco_override_empirical_error: Dict[str, str] | None = None, bco_override_algorithmic_error: Dict[str, str] | None = None, bco_override_xref: List[XrefItem] | None = None, galaxy_url: str, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, target_uri: str, invocation_id: int, user: RequestUser)

Bases: WriteStoreToPayload, BcoGenerationTaskParametersMixin

invocation_id: int

user: RequestUser

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.WriteHistoryContentTo(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, target_uri: str, content_type: HistoryContentType, content_id: int, user: RequestUser)

Bases: WriteStoreToPayload

content_type: HistoryContentType

content_id: int

user: RequestUser

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.WriteHistoryTo(*, model_store_format: ModelStoreFormat = ModelStoreFormat.TAR_DOT_GZ, include_files: bool = True, include_deleted: bool = False, include_hidden: bool = False, target_uri: str, history_id: int, user: RequestUser, export_association_id: int | None = None)

Bases: WriteStoreToPayload

history_id: int

user: RequestUser

export_association_id: int | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.ImportModelStoreTaskRequest(*, user: RequestUser, history_id: int | None = None, source_uri: str, for_library: bool, model_store_format: ModelStoreFormat | None = None)

Bases: Model

user: RequestUser

history_id: int | None

source_uri: str

for_library: bool

model_store_format: ModelStoreFormat | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.MaterializeDatasetInstanceTaskRequest(*, history_id: int, user: RequestUser, source: DatasetSourceType, content: int)

Bases: Model

history_id: int

user: RequestUser

source: DatasetSourceType

content: int

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.ComputeDatasetHashTaskRequest(*, dataset_id: int, extra_files_path: str | None = None, hash_function: HashFunctionNameEnum, user: RequestUser | None = None)

Bases: Model

dataset_id: int

extra_files_path: str | None

hash_function: HashFunctionNameEnum

user: RequestUser | None

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.schema.tasks.PurgeDatasetsTaskRequest(*, dataset_ids: List[int])

Bases: Model

dataset_ids: List[int]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

galaxy.schema.types module

galaxy.schema.types.strip_tzinfo(v: datetime, info: ValidationInfo) → datetime