Managers#

class ManagerStatusEnum[source]#

Bases: str, Enum

The state of a Queue Manager. The states which are available are a finite set.

active = 'active'#

inactive = 'inactive'#

__init__(*args, **kwds)#

class ManagerName[source]#

Bases: BaseModel

Fields#
Field	Type	Required
`cluster`	`str`	Yes
`hostname`	`str`	Yes
`uuid`	`str`	Yes

cluster: str#

hostname: str#

uuid: str#

property fullname#

class ComputeManager[source]#

Bases: BaseModel

Fields#
Field	Type	Required
`active_cores`	`int`	Yes
`active_memory`	`float`	Yes
`active_tasks`	`int`	Yes
`claimed`	`int`	Yes
`cluster`	`str`	Yes
`compute_tags`	`list`[`str`]	Yes
`created_on`	`datetime`	Yes
`failures`	`int`	Yes
`hostname`	`str`	Yes
`id`	`int`	Yes
`manager_version`	`str`	Yes
`modified_on`	`datetime`	Yes
`name`	`str`	Yes
`programs`	`dict`[`str`, `list`[`str`]]	Yes
`rejected`	`int`	Yes
`status`	`ManagerStatusEnum`	Yes
`successes`	`int`	Yes
`total_cpu_hours`	`float`	Yes
`username`	`str` \| `None`	Yes

id: int#

name: str#

cluster: str#

hostname: str#

username: str | None#

compute_tags: list[str]#

claimed: int#

successes: int#

failures: int#

rejected: int#

total_cpu_hours: float#

active_tasks: int#

active_cores: int#

active_memory: float#

status: ManagerStatusEnum#

created_on: datetime#

modified_on: datetime#

manager_version: str#

programs: dict[str, list[str]]#

propagate_client(client, base_url_prefix)[source]#

Parameters:: base_url_prefix (str | None)

property tags: list[str]#

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

self (BaseModel) – The BaseModel instance.
context (Any) – The context.

Return type:

None

class ManagerActivationBody[source]#

Bases: RestModelBase

Fields#
Field	Type	Required
`compute_tags`	`list`[`Annotated`[`str`, `StringConstraints`(strip_whitespace=`None`, to_upper=`None`, to_lower=True, strict=`None`, min_length=`None`, max_length=`None`, pattern=`None`, ascii_only=`None`)]]	Yes
`manager_version`	`str`	Yes
`name_data`	`ManagerName`	Yes
`programs`	`dict`[`Annotated`[`str`, `StringConstraints`(strip_whitespace=`None`, to_upper=`None`, to_lower=True, strict=`None`, min_length=`None`, max_length=`None`, pattern=`None`, ascii_only=`None`)], `list`[`str`]]	Yes
`username`	`str` \| `None`	Yes

Validators#
Validator	Mode	Fields
`validate_programs`	after	`programs`
`validate_tags`	after	`compute_tags`

name_data: ManagerName#: Name information about this manager

manager_version: str#: Version of the manager itself

username: str | None#: Username this manager is connected with

programs: dict[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)], list[str]]#

Programs available on this manager

Validated by:: validate_programs

compute_tags: list[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)]]#

Tags this manager will compute for

Validated by:: validate_tags

classmethod validate_tags(v)[source]#

classmethod validate_programs(v)[source]#

class ManagerUpdateBody[source]#

Bases: RestModelBase

Fields#
Field	Type	Required
`active_cores`	`int`	Yes
`active_memory`	`float`	Yes
`active_tasks`	`int`	Yes
`status`	`ManagerStatusEnum`	Yes
`total_cpu_hours`	`float`	Yes

status: ManagerStatusEnum#

active_tasks: int#

active_cores: int#

active_memory: float#

total_cpu_hours: float#

class ManagerQueryFilters[source]#

Bases: QueryProjModelBase

Fields#
Field	Type	Required	Default
`cluster`	`list`[`str`] \| `None`	No	`None`
`cursor`	`int` \| `None`	No	`None`
`exclude`	`list`[`str`] \| `None`	No	`None`
`hostname`	`list`[`str`] \| `None`	No	`None`
`include`	`list`[`str`] \| `None`	No	`None`
`limit`	`int` \| `None`	No	`None`
`manager_id`	`list`[`int`] \| `None`	No	`None`
`modified_after`	`datetime` \| `None`	No	`None`
`modified_before`	`datetime` \| `None`	No	`None`
`name`	`list`[`str`] \| `None`	No	`None`
`status`	`list`[`ManagerStatusEnum`] \| `None`	No	`None`

Validators#
Validator	Mode	Fields
`parse_dates`	before	`modified_before`, `modified_after`
`validate_lists`	before	`limit`, `cursor`

manager_id: list[int] | None#

name: list[str] | None#

cluster: list[str] | None#

hostname: list[str] | None#

status: list[ManagerStatusEnum] | None#

modified_before: datetime | None#

modified_after: datetime | None#

classmethod parse_dates(v)[source]#

classmethod validate_lists(v)#

limit#

cursor#

include#

exclude#

class ManagerQueryAvailableFilters[source]#

Bases: RestModelBase

Fields#
Field	Type	Required	Default
`compute_tag`	`list`[`str`]	Yes
`programs`	`dict`[`Annotated`[`str`, `StringConstraints`(strip_whitespace=`None`, to_upper=`None`, to_lower=True, strict=`None`, min_length=`None`, max_length=`None`, pattern=`None`, ascii_only=`None`)], `list`[`str`]]	Yes

compute_tag: list[str]#

programs: dict[Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=True, strict=None, min_length=None, max_length=None, pattern=None, ascii_only=None)], list[str]]#

class ManagerQueryIterator[source]#

Bases: QueryIteratorBase[ComputeManager]

Iterator for manager queries

This iterator transparently handles batching and pagination over the results of a manager query

reset()#: Starts retrieval of results from the beginning again

__init__(client, query_filters)[source]#

Construct an iterator

Parameters:

client – QCPortal client object used to contact/retrieve data from the server
query_filters (ManagerQueryFilters) – The actual query information to send to the server