Managers

class ManagerStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

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

active = 'active'

inactive = 'inactive'

pydantic model ManagerName

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

Fields:

• cluster (str)

• hostname (str)

• uuid (str)

field cluster: str [Required]

field hostname: str [Required]

field uuid: str [Required]

property fullname

pydantic model ComputeManager

Bases: BaseModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

Fields:

• active_cores (int)

• active_memory (float)

• active_tasks (int)

• claimed (int)

• cluster (str)

• created_on (datetime.datetime)

• failures (int)

• hostname (str)

• id (int)

• manager_version (str)

• modified_on (datetime.datetime)

• name (str)

• programs (Dict[str, List[str]])

• rejected (int)

• status (qcportal.managers.models.ManagerStatusEnum)

• successes (int)

• tags (List[str])

• total_cpu_hours (float)

• username (str | None)

field id: int [Required]

field name: str [Required]

field cluster: str [Required]

field hostname: str [Required]

field username: str | None = None

field tags: List[str] [Required]

field claimed: int [Required]

field successes: int [Required]

field failures: int [Required]

field rejected: int [Required]

field total_cpu_hours: float [Required]

field active_tasks: int [Required]

field active_cores: int [Required]

field active_memory: float [Required]

field status: ManagerStatusEnum [Required]

field created_on: datetime [Required]

field modified_on: datetime [Required]

field manager_version: str [Required]

field programs: Dict[str, List[str]] [Required]

propagate_client(client)

pydantic model ManagerActivationBody

Bases: RestModelBase

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

• validate_assignment: bool = True

Fields:

• manager_version (str)

• name_data (qcportal.managers.models.ManagerName)

• programs (Dict[qcportal.managers.models.ConstrainedStrValue, List[str]])

• tags (List[qcportal.managers.models.ConstrainedStrValue])

• username (str | None)

Validators:

• validate_programs » programs

• validate_tags » tags

field name_data: ManagerName [Required]

Name information about this manager

field manager_version: str [Required]

Version of the manager itself

field username: str | None [Required]

Username this manager is connected with

field programs: Dict[ConstrainedStrValue, List[str]] [Required]

Programs available on this manager

Validated by:

• validate_programs

field tags: List[ConstrainedStrValue] [Required]

Tags this manager will compute for

Validated by:

• validate_tags

validator validate_tags  »  tags

validator validate_programs  »  programs

pydantic model ManagerUpdateBody

Bases: RestModelBase

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

• validate_assignment: bool = True

Fields:

• active_cores (int)

• active_memory (float)

• active_tasks (int)

• status (qcportal.managers.models.ManagerStatusEnum)

• total_cpu_hours (float)

field status: ManagerStatusEnum [Required]

field active_tasks: int [Required]

field active_cores: int [Required]

field active_memory: float [Required]

field total_cpu_hours: float [Required]

pydantic model ManagerQueryFilters

Bases: QueryProjModelBase

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Config:

• extra: Extra = Extra.forbid

• validate_assignment: bool = True

Fields:

• cluster (List[str] | None)

• cursor (int | None)

• exclude (List[str] | None)

• hostname (List[str] | None)

• include (List[str] | None)

• limit (int | None)

• manager_id (List[int] | None)

• modified_after (datetime.datetime | None)

• modified_before (datetime.datetime | None)

• name (List[str] | None)

• status (List[qcportal.managers.models.ManagerStatusEnum] | None)

Validators:

• parse_dates » modified_after

• parse_dates » modified_before

• validate_lists » cursor

• validate_lists » limit

field manager_id: List[int] | None = None

field name: List[str] | None = None

field cluster: List[str] | None = None

field hostname: List[str] | None = None

field status: List[ManagerStatusEnum] | None = None

field modified_before: datetime | None = None

Validated by:

• parse_dates

field modified_after: datetime | None = None

Validated by:

• parse_dates

validator parse_dates  »  modified_after, modified_before

validator validate_lists  »  limit, cursor

field limit: int | None = None

Validated by:

• validate_lists

field cursor: int | None = None

Validated by:

• validate_lists

field include: List[str] | None = None

field exclude: List[str] | None = None

class ManagerQueryIterator(client, query_filters)

Bases: QueryIteratorBase[ComputeManager]

Iterator for manager queries

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

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

reset()

Starts retrieval of results from the beginning again