Managers

class ManagerStatusEnum(value)

Bases: str, Enum

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

active = 'active'

inactive = 'inactive'

class ManagerName(*, cluster, hostname, uuid)

Bases: BaseModel

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• cluster (str)

• hostname (str)

• uuid (str)

model_config = {'extra': 'forbid'}

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

cluster: str

hostname: str

uuid: str

property fullname

class ComputeManager(*, id, name, cluster, hostname, username, compute_tags, claimed, successes, failures, rejected, total_cpu_hours, active_tasks, active_cores, active_memory, status, created_on, modified_on, manager_version, programs)

Bases: BaseModel

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• 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]])

model_config = {'extra': 'forbid'}

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

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)

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(*, name_data, manager_version, username, programs, compute_tags)

Bases: RestModelBase

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• name_data (ManagerName)

• manager_version (str)

• username (str | None)

• 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]])

• 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)]])

name_data: ManagerName

manager_version: str

username: str | None

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]]

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

classmethod validate_tags(v)

classmethod validate_programs(v)

model_config = {'extra': 'forbid', 'validate_assignment': True}

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

class ManagerUpdateBody(*, status, active_tasks, active_cores, active_memory, total_cpu_hours)

Bases: RestModelBase

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• status (ManagerStatusEnum)

• active_tasks (int)

• active_cores (int)

• active_memory (float)

• total_cpu_hours (float)

status: ManagerStatusEnum

active_tasks: int

active_cores: int

active_memory: float

total_cpu_hours: float

model_config = {'extra': 'forbid', 'validate_assignment': True}

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

class ManagerQueryFilters(*, include=None, exclude=None, limit=None, cursor=None, manager_id=None, name=None, cluster=None, hostname=None, status=None, modified_before=None, modified_after=None)

Bases: QueryProjModelBase

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• include (list[str] | None)

• exclude (list[str] | None)

• limit (int | None)

• cursor (int | None)

• 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)

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)

model_config = {'extra': 'forbid', 'validate_assignment': True}

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

classmethod validate_lists(v)

limit

cursor

include

exclude

class ManagerQueryAvailableFilters(*, compute_tag, programs)

Bases: RestModelBase

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• 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]])

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]]

model_config = {'extra': 'forbid', 'validate_assignment': True}

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

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