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(*, email: str | None = None, preferences: Dict[str, str] = {}, id: int = 0, bootstrap_admin_user: bool = True)[source]

Bases: BaseModel

email: str | None
preferences: Dict[str, str]
all_roles() list[source]
class galaxy.schema.ValueFilterQueryParams(*, q: List[str] | str | None = None, qv: List[str] | str | None = None)[source]

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
class galaxy.schema.PaginationQueryParams(*, offset: ConstrainedIntValue | None = 0, limit: ConstrainedIntValue | None = None)[source]

Bases: BaseModel

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

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

Bases: ValueFilterQueryParams, PaginationQueryParams

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

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

Bases: BaseModel

Contains common parameters for customizing model serialization.

view: str | None
keys: List[str] | None
default_view: str | None
class galaxy.schema.PdfDocumentType(value)[source]

Bases: str, Enum

An enumeration.

invocation_report = 'invocation_report'
page = 'page'
class galaxy.schema.APIKeyModel(*, key: str, create_time: datetime)[source]

Bases: BaseModel

key: str
create_time: datetime

Submodules

galaxy.schema.fetch_data module

class galaxy.schema.fetch_data.FetchBaseModel[source]

Bases: Model

class Config[source]

Bases: object

allow_population_by_field_name = True
class galaxy.schema.fetch_data.ElementsFromType(value)[source]

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)[source]

Bases: FetchBaseModel

auto_decompress: bool
class galaxy.schema.fetch_data.ItemsFromSrc(value)[source]

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)[source]

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)[source]

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])[source]

Bases: FetchBaseModel

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

Bases: FetchBaseModel

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

Bases: FetchBaseModel

type: typing_extensions.Literal[library_folder]
library_folder_id: DecodedDatabaseIdField
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)[source]

Bases: BaseFetchDataTarget

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

Bases: FetchBaseModel

type: typing_extensions.Literal[library]
name: str
description: str | None
synopsis: str | None
class galaxy.schema.fetch_data.ExtraFiles(*, items_from: str | None = None, src: Src, fuzzy_root: bool | None = True)[source]

Bases: FetchBaseModel

items_from: str | None
src: Src
fuzzy_root: bool | None
class galaxy.schema.fetch_data.BaseDataElement(*, name: str | 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, description: str | None = None)[source]

Bases: FetchBaseModel

name: str | 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
description: str | None
class Config[source]

Bases: object

extra = 'forbid'
class galaxy.schema.fetch_data.FileDataElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[files])[source]

Bases: BaseDataElement

src: typing_extensions.Literal[files]
class galaxy.schema.fetch_data.PastedDataElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[pasted], paste_content: str)[source]

Bases: BaseDataElement

src: typing_extensions.Literal[pasted]
paste_content: str
class galaxy.schema.fetch_data.UrlDataElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[url], url: str)[source]

Bases: BaseDataElement

src: typing_extensions.Literal[url]
url: str
class galaxy.schema.fetch_data.ServerDirElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[server_dir], server_dir: str, link_data_only: bool | None = None)[source]

Bases: BaseDataElement

src: typing_extensions.Literal[server_dir]
server_dir: str
class galaxy.schema.fetch_data.FtpImportElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[ftp_import], ftp_path: str)[source]

Bases: BaseDataElement

src: typing_extensions.Literal[ftp_import]
ftp_path: str
items_from: ElementsFromType | None
name: str | None
collection_type: str | None
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)[source]

Bases: Model

src: ItemsFromSrc
path: str | None
ftp_path: str | None
server_dir: str | None
url: str | None
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)[source]

Bases: BaseCollectionTarget

src: typing_extensions.Literal[ftp_import]
ftp_path: str
items_from: ElementsFromType | None
class galaxy.schema.fetch_data.PathDataElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[path], path: str, link_data_only: bool | None = None)[source]

Bases: BaseDataElement

src: typing_extensions.Literal[path]
path: str
items_from: ElementsFromType | None
class galaxy.schema.fetch_data.CompositeDataElement(*, name: str | 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, description: str | None = None, src: typing_extensions.Literal[composite], composite: CompositeItems)[source]

Bases: BaseDataElement

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

Bases: FetchBaseModel

items: List[FileDataElement | PastedDataElement | UrlDataElement | PathDataElement | ServerDirElement | FtpImportElement]
class galaxy.schema.fetch_data.NestedElement(*, name: str | 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, description: str | None = None, elements: List[AnyElement | NestedElement])[source]

Bases: BaseDataElement

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]
class galaxy.schema.fetch_data.BaseDataTarget(*, auto_decompress: bool = False, destination: HdaDestination | LibraryFolderDestination | LibraryDestination)[source]

Bases: BaseFetchDataTarget

destination: HdaDestination | LibraryFolderDestination | LibraryDestination
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])[source]

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]
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)[source]

Bases: BaseDataTarget, ItemsFromModel

items_from: ElementsFromType
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])[source]

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]
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)[source]

Bases: BaseCollectionTarget, ItemsFromModel

items_from: ElementsFromType
class galaxy.schema.fetch_data.FilesPayload(*, filename: str, local_filename: str)[source]

Bases: Model

filename: str
local_filename: str
class galaxy.schema.fetch_data.BaseDataPayload(*, history_id: DecodedDatabaseIdField, **extra_data: Any)[source]

Bases: FetchBaseModel

history_id: DecodedDatabaseIdField
class Config[source]

Bases: object

extra = 'allow'
classmethod targets_string_to_json(v)[source]
class galaxy.schema.fetch_data.FetchDataPayload(*, history_id: DecodedDatabaseIdField, targets: List[DataElementsTarget | HdcaDataItemsTarget | DataElementsFromTarget | HdcaDataItemsFromTarget | FtpImportTarget], **extra_data: Any)[source]

Bases: BaseDataPayload

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

Bases: BaseDataPayload

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

galaxy.schema.fields module

class galaxy.schema.fields.BaseDatabaseIdField[source]

Bases: object

Database ID validation.

security: IdEncodingHelper
classmethod validate(v)[source]
classmethod ensure_valid(v: str)[source]
class galaxy.schema.fields.DecodedDatabaseIdField[source]

Bases: int, BaseDatabaseIdField

classmethod validate(v)[source]
classmethod encode(v) str[source]
security: IdEncodingHelper
class galaxy.schema.fields.EncodedDatabaseIdField[source]

Bases: str, BaseDatabaseIdField

classmethod validate(v)[source]
classmethod decode(v) int[source]
security: IdEncodingHelper
class galaxy.schema.fields.LibraryFolderDatabaseIdField[source]

Bases: int, BaseDatabaseIdField

classmethod validate(v)[source]
classmethod encode(v) str[source]
security: IdEncodingHelper
class galaxy.schema.fields.EncodedLibraryFolderDatabaseIdField[source]

Bases: str, BaseDatabaseIdField

classmethod validate(v)[source]
classmethod decode(v: str) int[source]
security: IdEncodingHelper
galaxy.schema.fields.literal_to_value(arg)[source]
galaxy.schema.fields.ModelClassField(default_value=Ellipsis)[source]

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.remote_files module

class galaxy.schema.remote_files.RemoteFilesTarget(value)[source]

Bases: str, Enum

An enumeration.

ftpdir = 'ftpdir'
userdir = 'userdir'
importdir = 'importdir'
class galaxy.schema.remote_files.RemoteFilesFormat(value)[source]

Bases: str, Enum

An enumeration.

flat = 'flat'
jstree = 'jstree'
uri = 'uri'
class galaxy.schema.remote_files.RemoteFilesDisableMode(value)[source]

Bases: str, Enum

An enumeration.

folders = 'folders'
files = 'files'
class galaxy.schema.remote_files.FilesSourcePlugin(*, id: str, type: str, label: str, doc: str, browsable: bool, writable: bool, requires_roles: str | None = None, requires_groups: str | None = None)[source]

Bases: Model

id: str
type: str
label: str
doc: str
browsable: bool
writable: bool
requires_roles: str | None
requires_groups: str | None
class galaxy.schema.remote_files.BrowsableFilesSourcePlugin(*, id: str, type: str, label: str, doc: str, browsable: typing_extensions.Literal[True], writable: bool, requires_roles: str | None = None, requires_groups: str | None = None, uri_root: str)[source]

Bases: FilesSourcePlugin

browsable: typing_extensions.Literal[True]
uri_root: str
class galaxy.schema.remote_files.FilesSourcePluginList(*, __root__: List[BrowsableFilesSourcePlugin | FilesSourcePlugin] = [])[source]

Bases: Model

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

Bases: Model

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

Bases: RemoteEntry

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

Bases: RemoteEntry

class_: typing_extensions.Literal[File]
size: int
ctime: str
class galaxy.schema.remote_files.ListJstreeResponse(*, __root__: List[Any] = [])[source]

Bases: Model

class galaxy.schema.remote_files.ListUriResponse(*, __root__: List[RemoteFile | galaxy.schema.remote_files.RemoteDirectory[RemoteFile | RemoteDirectory]] = [])[source]

Bases: Model

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

Bases: Model

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

Bases: Model

name: str
uri: str

galaxy.schema.schema module

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

class galaxy.schema.schema.DatasetState(value)[source]

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()[source]
class galaxy.schema.schema.JobState(value)[source]

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)[source]

Bases: str, Enum

An enumeration.

NEW = 'new'
OK = 'ok'
FAILED = 'failed'
class galaxy.schema.schema.Model[source]

Bases: BaseModel

class Config[source]

Bases: object

use_enum_values = True
allow_population_by_field_name = True
json_encoders = {<class 'galaxy.schema.fields.DecodedDatabaseIdField'>: <function Model.Config.<lambda>>, <class 'galaxy.schema.fields.LibraryFolderDatabaseIdField'>: <function Model.Config.<lambda>>}
static schema_extra(schema: Dict[str, Any], model) None[source]
class galaxy.schema.schema.BaseUserModel(*, id: EncodedDatabaseIdField, username: str, email: str, deleted: bool)[source]

Bases: Model

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

Bases: BaseUserModel

User in a transaction context.

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

Bases: Model

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

id: EncodedDatabaseIdField
username: str | None
email: str | None
class galaxy.schema.schema.DiskUsageUserModel(*, total_disk_usage: float, nice_total_disk_usage: str)[source]

Bases: Model

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

Bases: UserModel, DiskUsageUserModel

preferred_object_store_id: str | None
class galaxy.schema.schema.AnonUserModel(*, total_disk_usage: float, nice_total_disk_usage: str, quota_percent: Any = None)[source]

Bases: DiskUsageUserModel

quota_percent: Any
class galaxy.schema.schema.DetailedUserModel(*, total_disk_usage: float, nice_total_disk_usage: str, quota_percent: Any = None, id: EncodedDatabaseIdField, 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: Any, tags_used: List[str])[source]

Bases: BaseUserModel, AnonUserModel

is_admin: bool
purged: bool
preferences: Dict[Any, Any]
preferred_object_store_id: str | None
quota: str
quota_bytes: Any
tags_used: List[str]
class galaxy.schema.schema.UserCreationPayload(*, password: str, email: str, username: str)[source]

Bases: Model

password: str
email: str
username: str
class galaxy.schema.schema.RemoteUserCreationPayload(*, remote_user_email: str)[source]

Bases: Model

remote_user_email: str
class galaxy.schema.schema.UserDeletionPayload(*, purge: bool)[source]

Bases: Model

purge: bool
class galaxy.schema.schema.FavoriteObject(*, object_id: str)[source]

Bases: Model

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

Bases: Model

tools: List[str]
class galaxy.schema.schema.FavoriteObjectType(value)[source]

Bases: str, Enum

An enumeration.

tools = 'tools'
class galaxy.schema.schema.DeletedCustomBuild(*, message: str)[source]

Bases: Model

message: str
class galaxy.schema.schema.CustomBuildBaseModel(*, name: str)[source]

Bases: Model

name: str
class galaxy.schema.schema.CustomBuildLenType(value)[source]

Bases: str, Enum

An enumeration.

file = 'file'
fasta = 'fasta'
text = 'text'
class galaxy.schema.schema.CustomBuildCreationPayload(*, name: str, len_type: CustomBuildLenType, len_value: str)[source]

Bases: CustomBuildBaseModel

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

Bases: CustomBuildBaseModel

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

Bases: CreatedCustomBuild

id: str
class galaxy.schema.schema.CustomBuildsCollection(*, __root__: List[CustomBuildModel])[source]

Bases: Model

class galaxy.schema.schema.GroupModel(*, model_class: typing_extensions.Literal[Group] = 'Group', id: DecodedDatabaseIdField, name: str)[source]

Bases: Model

User group model

model_class: typing_extensions.Literal[Group]
id: DecodedDatabaseIdField
name: str
class galaxy.schema.schema.JobSourceType(value)[source]

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)[source]

Bases: str, Enum

Available types of History contents.

dataset = 'dataset'
dataset_collection = 'dataset_collection'
class galaxy.schema.schema.HistoryImportArchiveSourceType(value)[source]

Bases: str, Enum

Available types of History archive sources.

url = 'url'
file = 'file'
class galaxy.schema.schema.DCEType(value)[source]

Bases: str, Enum

Available types of dataset collection elements.

hda = 'hda'
dataset_collection = 'dataset_collection'
class galaxy.schema.schema.DatasetSourceType(value)[source]

Bases: str, Enum

An enumeration.

hda = 'hda'
ldda = 'ldda'
class galaxy.schema.schema.DataItemSourceType(value)[source]

Bases: str, Enum

An enumeration.

hda = 'hda'
ldda = 'ldda'
hdca = 'hdca'
dce = 'dce'
dc = 'dc'
class galaxy.schema.schema.ColletionSourceType(value)[source]

Bases: str, Enum

An enumeration.

hda = 'hda'
ldda = 'ldda'
hdca = 'hdca'
new_collection = 'new_collection'
class galaxy.schema.schema.HistoryContentSource(value)[source]

Bases: str, Enum

An enumeration.

hda = 'hda'
hdca = 'hdca'
library = 'library'
library_folder = 'library_folder'
new_collection = 'new_collection'
class galaxy.schema.schema.TagItem[source]

Bases: ConstrainedStr

regex = re.compile('^([^\\s.:])+(.[^\\s.:]+)*(:[^\\s.:]+)?$')
class galaxy.schema.schema.TagCollection(*, __root__: List[TagItem])[source]

Bases: Model

Represents the collection of tags associated with an item.

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

Bases: Model

Metadata file associated with a dataset.

file_type: str
download_url: str
class galaxy.schema.schema.DatasetPermissions(*, manage: List[DecodedDatabaseIdField] = [], access: List[DecodedDatabaseIdField] = [])[source]

Bases: Model

Role-based permissions for accessing and managing a dataset.

manage: List[DecodedDatabaseIdField]
access: List[DecodedDatabaseIdField]

Bases: Model

Represents some text with an Hyperlink.

target: str
href: AnyUrl
text: str
class galaxy.schema.schema.DisplayApp(*, label: str, links: List[Hyperlink])[source]

Bases: Model

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

label: str
class galaxy.schema.schema.Visualization(**extra_data: Any)[source]

Bases: Model

class Config[source]

Bases: object

extra = 'allow'
class galaxy.schema.schema.HistoryItemBase(*, id: DecodedDatabaseIdField, name: str | None = None, history_id: DecodedDatabaseIdField, hid: int, deleted: bool, visible: bool)[source]

Bases: Model

Basic information provided by items contained in a History.

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

Bases: HistoryItemBase

Common information provided by items contained in a History.

class Config[source]

Bases: object

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

Bases: HistoryItemCommon

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

Bases: HDACommon

History Dataset Association summary information.

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

Bases: HDACommon

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

accessible: bool
state: DatasetState
class galaxy.schema.schema.DatasetValidatedState(value)[source]

Bases: str, Enum

An enumeration.

UNKNOWN = 'unknown'
INVALID = 'invalid'
OK = 'ok'
class galaxy.schema.schema.HDADetailed(*, id: DecodedDatabaseIdField, name: str | None = None, history_id: DecodedDatabaseIdField, hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[file][typing_extensions.Literal[file]] = 'file', create_time: datetime | None = None, update_time: datetime | None = None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset][typing_extensions.Literal[dataset]], dataset_id: DecodedDatabaseIdField, state: DatasetState, extension: str, purged: bool, model_class: typing_extensions.Literal[HistoryDatasetAssociation][typing_extensions.Literal[HistoryDatasetAssociation]], hda_ldda: DatasetSourceType = DatasetSourceType.hda, accessible: bool, genome_build: str | None = '?', misc_info: str | None = None, misc_blurb: str | None = None, file_ext: str, file_size: int, resubmitted: bool, metadata: Any | None = None, metadata_dbkey: str | None = '?', metadata_data_lines: int = 0, meta_files: List[MetadataFile], data_type: str, peek: str | None = None, creating_job: str, rerunnable: bool, uuid: UUID4, permissions: DatasetPermissions, file_name: str | None = None, display_apps: List[DisplayApp], display_types: List[DisplayApp], visualizations: List[Visualization], validated_state: DatasetValidatedState, validated_state_message: str | None, annotation: str | None, download_url: str, api_type: typing_extensions.Literal[file][typing_extensions.Literal[file]] = 'file', created_from_basename: str | None = None, **extra_data: Any)[source]

Bases: HDASummary

History Dataset Association detailed information.

model_class: typing_extensions.Literal[HistoryDatasetAssociation][typing_extensions.Literal[HistoryDatasetAssociation]]
hda_ldda: DatasetSourceType
accessible: bool
genome_build: str | None
misc_info: str | None
misc_blurb: str | None
file_ext: str
file_size: int
resubmitted: bool
metadata: Any | None
metadata_dbkey: str | None
metadata_data_lines: int
meta_files: List[MetadataFile]
data_type: str
peek: str | None
creating_job: str
rerunnable: bool
uuid: UUID4
permissions: DatasetPermissions
file_name: str | None
display_apps: List[DisplayApp]
display_types: List[DisplayApp]
visualizations: List[Visualization]
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
class galaxy.schema.schema.HDAExtended(*, id: DecodedDatabaseIdField, name: str | None = None, history_id: DecodedDatabaseIdField, hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: typing_extensions.Literal[file][typing_extensions.Literal[file]] = 'file', create_time: datetime | None = None, update_time: datetime | None = None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset][typing_extensions.Literal[dataset]], dataset_id: DecodedDatabaseIdField, state: DatasetState, extension: str, purged: bool, model_class: typing_extensions.Literal[HistoryDatasetAssociation][typing_extensions.Literal[HistoryDatasetAssociation]], hda_ldda: DatasetSourceType = DatasetSourceType.hda, accessible: bool, genome_build: str | None = '?', misc_info: str | None = None, misc_blurb: str | None = None, file_ext: str, file_size: int, resubmitted: bool, metadata: Any | None = None, metadata_dbkey: str | None = '?', metadata_data_lines: int = 0, meta_files: List[MetadataFile], data_type: str, peek: str | None = None, creating_job: str, rerunnable: bool, uuid: UUID4, permissions: DatasetPermissions, file_name: str | None = None, display_apps: List[DisplayApp], display_types: List[DisplayApp], visualizations: List[Visualization], validated_state: DatasetValidatedState, validated_state_message: str | None, annotation: str | None, download_url: str, api_type: typing_extensions.Literal[file][typing_extensions.Literal[file]] = 'file', created_from_basename: str | None = None, tool_version: str, parent_id: DecodedDatabaseIdField | None = None, designation: str | None = None, **extra_data: Any)[source]

Bases: HDADetailed

History Dataset Association extended information.

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

Bases: Model

Dataset Collection summary information.

model_class: typing_extensions.Literal[DatasetCollection]
id: DecodedDatabaseIdField
create_time: datetime
update_time: datetime
collection_type: str
populated_state: DatasetCollectionPopulatedState
populated_state_message: str | None
element_count: int | None
class galaxy.schema.schema.HDAObject(*, id: DecodedDatabaseIdField, model_class: typing_extensions.Literal[HistoryDatasetAssociation] = 'HistoryDatasetAssociation', state: DatasetState, hda_ldda: DatasetSourceType = DatasetSourceType.hda, history_id: DecodedDatabaseIdField, tags: List[str], **extra_data: Any)[source]

Bases: Model

History Dataset Association Object

id: DecodedDatabaseIdField
model_class: typing_extensions.Literal[HistoryDatasetAssociation]
state: DatasetState
hda_ldda: DatasetSourceType
history_id: DecodedDatabaseIdField
tags: List[str]
class Config[source]

Bases: object

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

Bases: Model

Dataset Collection Object

id: DecodedDatabaseIdField
model_class: typing_extensions.Literal[DatasetCollection]
collection_type: str
populated: bool | None
element_count: int | None
contents_url: str | None
elements: List[DCESummary]
class galaxy.schema.schema.DCESummary(*, id: DecodedDatabaseIdField, model_class: typing_extensions.Literal[DatasetCollectionElement] = 'DatasetCollectionElement', element_index: int, element_identifier: str, element_type: DCEType, object: HDAObject | HDADetailed | DCObject)[source]

Bases: Model

Dataset Collection Element summary information.

id: DecodedDatabaseIdField
model_class: typing_extensions.Literal[DatasetCollectionElement]
element_index: int
element_identifier: str
element_type: DCEType
object: HDAObject | HDADetailed | DCObject
class galaxy.schema.schema.DCDetailed(*, model_class: typing_extensions.Literal[DatasetCollection] = 'DatasetCollection', id: DecodedDatabaseIdField, 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, elements: List[DCESummary] = [])[source]

Bases: DCSummary

Dataset Collection detailed information.

populated: bool
elements: List[DCESummary]
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)[source]

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
class galaxy.schema.schema.HDCACommon(*, id: DecodedDatabaseIdField, name: str | None = None, history_id: DecodedDatabaseIdField, hid: int, deleted: bool, visible: bool, type_id: str | None = None, type: str, create_time: datetime | None = None, update_time: datetime | None = None, url: str, tags: TagCollection, history_content_type: typing_extensions.Literal[dataset_collection][typing_extensions.Literal[dataset_collection]], **extra_data: Any)[source]

Bases: HistoryItemCommon

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

Bases: HDCACommon

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

Bases: HDCASummary

History Dataset Collection Association detailed information.

populated: bool
elements: List[DCESummary]
elements_datatypes: Set[str]
class galaxy.schema.schema.HistoryBase(**extra_data: Any)[source]

Bases: Model

Provides basic configuration for all the History models.

class Config[source]

Bases: object

extra = 'allow'
class galaxy.schema.schema.HistoryContentItemBase(*, history_content_type: HistoryContentType)[source]

Bases: Model

Identifies a dataset or collection contained in a History.

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

Bases: HistoryContentItemBase

id: DecodedDatabaseIdField
class galaxy.schema.schema.EncodedHistoryContentItem(*, history_content_type: HistoryContentType, id: EncodedDatabaseIdField)[source]

Bases: HistoryContentItemBase

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

Bases: HistoryContentItem

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

class Config[source]

Bases: object

use_enum_values = True
extra = 'allow'
id: DecodedDatabaseIdField
history_content_type: HistoryContentType
class galaxy.schema.schema.UpdateHistoryContentsBatchPayload(*, items: List[UpdateContentItem], **extra_data: Any)[source]

Bases: HistoryBase

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

items: List[UpdateContentItem]
class Config[source]

Bases: object

schema_extra = {'example': {'items': [{'history_content_type': 'dataset', 'id': 'string'}], 'visible': False}}
class galaxy.schema.schema.HistoryContentItemOperation(value)[source]

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)[source]

Bases: Model

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

Bases: BulkOperationParams

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

Bases: BulkOperationParams

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

Bases: BulkOperationParams

type: typing_extensions.Literal[add_tags] | typing_extensions.Literal[remove_tags]
tags: List[str]
class galaxy.schema.schema.HistoryContentBulkOperationPayload(*, operation: HistoryContentItemOperation, items: List[HistoryContentItem] | None = None, params: ChangeDatatypeOperationParams | ChangeDbkeyOperationParams | TagOperationParams | None = None)[source]

Bases: Model

operation: HistoryContentItemOperation
items: List[HistoryContentItem] | None
params: ChangeDatatypeOperationParams | ChangeDbkeyOperationParams | TagOperationParams | None
class galaxy.schema.schema.BulkOperationItemError(*, item: EncodedHistoryContentItem, error: str)[source]

Bases: Model

item: EncodedHistoryContentItem
error: str
class galaxy.schema.schema.HistoryContentBulkOperationResult(*, success_count: int, errors: List[BulkOperationItemError])[source]

Bases: Model

success_count: int
errors: List[BulkOperationItemError]
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)[source]

Bases: HistoryBase

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
class Config[source]

Bases: object

schema_extra = {'example': {'annotation': 'Test', 'visible': False}}
class galaxy.schema.schema.HistorySummary(*, model_class: typing_extensions.Literal[History] = 'History', id: DecodedDatabaseIdField, 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, **extra_data: Any)[source]

Bases: HistoryBase

History summary information.

model_class: typing_extensions.Literal[History]
id: DecodedDatabaseIdField
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
class galaxy.schema.schema.HistoryActiveContentCounts(*, active: int, hidden: int, deleted: int)[source]

Bases: Model

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

active: int
hidden: int
deleted: int
class galaxy.schema.schema.HistoryDetailed(*, model_class: typing_extensions.Literal[History] = 'History', id: DecodedDatabaseIdField, 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: DecodedDatabaseIdField, create_time: datetime, importable: bool, slug: str | None = None, username_and_slug: str | None = None, genome_build: str | None = '?', state: DatasetState, state_ids: Dict[DatasetState, List[DecodedDatabaseIdField]], state_details: Dict[DatasetState, int], **extra_data: Any)[source]

Bases: HistorySummary

History detailed information.

contents_url: str
size: int
user_id: DecodedDatabaseIdField
create_time: datetime
importable: bool
slug: str | None
username_and_slug: str | None
genome_build: str | None
state: DatasetState
state_ids: Dict[DatasetState, List[DecodedDatabaseIdField]]
state_details: Dict[DatasetState, int]
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)[source]

Bases: Model

gzip: bool | None
include_hidden: bool | None
include_deleted: bool | None
file_name: str | None
directory_uri: str | None
force: bool | None
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: ConstrainedIntValue | None = None, offset: int | None = 0, search: str | None = None, skip_step_counts: bool = False)[source]

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
class galaxy.schema.schema.JobIndexSortByEnum(value)[source]

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: DecodedDatabaseIdField | None = None, tool_ids: List[str] | None = None, tool_ids_like: List[str] | None = None, date_range_min: OffsetNaiveDatetime | date | None = None, date_range_max: OffsetNaiveDatetime | date | None = None, history_id: DecodedDatabaseIdField | None = None, workflow_id: DecodedDatabaseIdField | None = None, invocation_id: DecodedDatabaseIdField | None = None, order_by: JobIndexSortByEnum = JobIndexSortByEnum.update_time, search: str | None = None, limit: int = 500, offset: int = 0)[source]

Bases: Model

states: List[str] | None
user_details: bool
user_id: DecodedDatabaseIdField | None
tool_ids: List[str] | None
tool_ids_like: List[str] | None
date_range_min: OffsetNaiveDatetime | date | None
date_range_max: OffsetNaiveDatetime | date | None
history_id: DecodedDatabaseIdField | None
workflow_id: DecodedDatabaseIdField | None
invocation_id: DecodedDatabaseIdField | None
order_by: JobIndexSortByEnum
search: str | None
limit: int
offset: int
class galaxy.schema.schema.InvocationSortByEnum(value)[source]

Bases: str, Enum

An enumeration.

create_time = 'create_time'
update_time = 'update_time'
none = 'None'
class galaxy.schema.schema.InvocationIndexQueryPayload(*, workflow_id: DecodedDatabaseIdField | None = None, history_id: DecodedDatabaseIdField | None = None, job_id: DecodedDatabaseIdField | None = None, user_id: DecodedDatabaseIdField | None = None, sort_by: InvocationSortByEnum | None = None, sort_desc: bool = False, include_terminal: bool = True, limit: ConstrainedIntValue | None = 100, offset: int | None = 0)[source]

Bases: Model

workflow_id: DecodedDatabaseIdField | None
history_id: DecodedDatabaseIdField | None
job_id: DecodedDatabaseIdField | None
user_id: DecodedDatabaseIdField | None
sort_by: InvocationSortByEnum | None
sort_desc: bool
include_terminal: bool
limit: int | None
offset: int | None
class galaxy.schema.schema.PageIndexQueryPayload(*, deleted: bool = False, show_published: bool | None = None, show_shared: bool | None = None, user_id: DecodedDatabaseIdField | None = None, sort_by: typing_extensions.Literal[update_time, title, username] = 'update_time', sort_desc: bool | None = False, search: str | None = None, limit: ConstrainedIntValue | None = 100, offset: int | None = 0)[source]

Bases: Model

deleted: bool
show_published: bool | None
show_shared: bool | None
user_id: DecodedDatabaseIdField | None
sort_by: typing_extensions.Literal[update_time, title, username]
sort_desc: bool | None
search: str | None
limit: int | None
offset: int | None
class galaxy.schema.schema.CreateHistoryPayload(*, name: str | None = None, history_id: DecodedDatabaseIdField | None = None, all_datasets: bool | None = True, archive_source: str | None = None, archive_type: HistoryImportArchiveSourceType | None = HistoryImportArchiveSourceType.url, archive_file: Any | None = None)[source]

Bases: Model

name: str | None
history_id: DecodedDatabaseIdField | None
all_datasets: bool | None
archive_source: str | None
archive_type: HistoryImportArchiveSourceType | None
archive_file: Any | None
class galaxy.schema.schema.CollectionElementIdentifier(*, name: str | None = None, src: ColletionSourceType, id: DecodedDatabaseIdField | None = None, collection_type: str | None = None, element_identifiers: List[CollectionElementIdentifier] | None = None, tags: List[str] | None = None)[source]

Bases: Model

name: str | None
src: ColletionSourceType
id: DecodedDatabaseIdField | None
collection_type: str | None
element_identifiers: List[CollectionElementIdentifier] | None
tags: List[str] | None
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: DecodedDatabaseIdField | None = None, folder_id: LibraryFolderDatabaseIdField | None = None)[source]

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: DecodedDatabaseIdField | None
folder_id: LibraryFolderDatabaseIdField | None
class galaxy.schema.schema.ModelStoreFormat(value)[source]

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)[source]
classmethod is_bag(value: ModelStoreFormat)[source]
class galaxy.schema.schema.StoreContentSource(*, store_content_uri: str | None = None, store_dict: Dict[str, Any] | None = None, model_store_format: ModelStoreFormat | None = None)[source]

Bases: Model

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

Bases: StoreContentSource

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)[source]

Bases: Model

model_store_format: ModelStoreFormat
include_files: bool
include_deleted: bool
include_hidden: bool
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)[source]

Bases: StoreExportPayload

short_term_storage_request_id: UUID
duration: int | float | None
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)[source]

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
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)[source]

Bases: StoreExportPayload

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

Bases: Model

id: EncodedDatabaseIdField
ready: bool
preparing: bool