Server Information

class GroupByEnum(value)

Bases: str, Enum

user = 'user'

day = 'day'

hour = 'hour'

country = 'country'

subdivision = 'subdivision'

class DeleteBeforeDateBody(*, before=None)

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.

Parameters:

before (datetime | None)

before: datetime | None

class Config

Bases: object

extra = 'forbid'

validate_assignment = True

class AccessLogQueryFilters(*, include=None, exclude=None, limit=None, cursor=None, module=None, method=None, user=None, before=None, after=None)

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.

Parameters:

• include (List[str] | None)

• exclude (List[str] | None)

• limit (int | None)

• cursor (int | None)

• module (List[ConstrainedStrValue] | None)

• method (List[ConstrainedStrValue] | None)

• user (List[int | str] | None)

• before (datetime | None)

• after (datetime | None)

module: List[ConstrainedStrValue] | None

method: List[ConstrainedStrValue] | None

user: List[int | str] | None

before: datetime | None

after: datetime | None

classmethod parse_dates(v)

class Config

Bases: object

extra = 'forbid'

validate_assignment = True

classmethod validate_lists(v)

limit: int | None

cursor: int | None

include: List[str] | None

exclude: List[str] | None

class AccessLogEntry(*, id, timestamp, method, module=None, full_uri=None, request_duration=None, request_bytes=None, response_bytes=None, user=None, ip_address=None, user_agent=None, country_code=None, subdivision=None, city=None, ip_lat=None, ip_long=None)

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.

Parameters:

• id (int)

• timestamp (datetime)

• method (str)

• module (str | None)

• full_uri (str | None)

• request_duration (float | None)

• request_bytes (float | None)

• response_bytes (float | None)

• user (str | None)

• ip_address (IPvAnyAddress | None)

• user_agent (str | None)

• country_code (str | None)

• subdivision (str | None)

• city (str | None)

• ip_lat (float | None)

• ip_long (float | None)

class Config

Bases: object

extra = 'forbid'

id: int

timestamp: datetime

method: str

module: str | None

full_uri: str | None

request_duration: float | None

request_bytes: float | None

response_bytes: float | None

user: str | None

ip_address: IPvAnyAddress | None

user_agent: str | None

country_code: str | None

subdivision: str | None

city: str | None

ip_lat: float | None

ip_long: float | None

class AccessLogQueryIterator(client, query_filters)

Bases: QueryIteratorBase[AccessLogEntry]

Iterator for access log queries

This iterator transparently handles batching and pagination over the results of an access log query

Construct an iterator

Parameters:

• client – QCPortal client object used to contact/retrieve data from the server

• query_filters (AccessLogQueryFilters) – The actual query information to send to the server

reset()

Starts retrieval of results from the beginning again

class AccessLogSummaryFilters(*, group_by=GroupByEnum.day, before=None, after=None)

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.

Parameters:

• group_by (GroupByEnum)

• before (datetime | None)

• after (datetime | None)

group_by: GroupByEnum

before: datetime | None

after: datetime | None

classmethod validate_lists(v)

classmethod parse_dates(v)

class Config

Bases: object

extra = 'forbid'

validate_assignment = True

class AccessLogSummaryEntry(*, module=None, method, count, request_duration_info, response_bytes_info)

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.

Parameters:

• module (str | None)

• method (str)

• count (int)

• request_duration_info (List[float])

• response_bytes_info (List[float])

class Config

Bases: object

extra = 'forbid'

module: str | None

method: str

count: int

request_duration_info: List[float]

response_bytes_info: List[float]

class AccessLogSummary(*, entries)

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.

Parameters:

entries (Dict[str, List[AccessLogSummaryEntry]])

class Config

Bases: object

extra = 'forbid'

entries: Dict[str, List[AccessLogSummaryEntry]]

class ErrorLogQueryFilters(*, limit=None, cursor=None, error_id=None, user=None, before=None, after=None)

Bases: QueryModelBase

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.

Parameters:

• limit (int | None)

• cursor (int | None)

• error_id (List[int] | None)

• user (List[int | str] | None)

• before (datetime | None)

• after (datetime | None)

error_id: List[int] | None

user: List[int | str] | None

before: datetime | None

after: datetime | None

classmethod parse_dates(v)

class Config

Bases: object

extra = 'forbid'

validate_assignment = True

classmethod validate_lists(v)

limit: int | None

cursor: int | None

class ErrorLogEntry(*, id, error_date, qcfractal_version, error_text=None, user=None, request_path=None, request_headers=None, request_body=None)

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.

Parameters:

• id (int)

• error_date (datetime)

• qcfractal_version (str)

• error_text (str | None)

• user (str | None)

• request_path (str | None)

• request_headers (str | None)

• request_body (str | None)

class Config

Bases: object

extra = 'forbid'

id: int

error_date: datetime

qcfractal_version: str

error_text: str | None

user: str | None

request_path: str | None

request_headers: str | None

request_body: str | None

class ErrorLogQueryIterator(client, query_filters)

Bases: QueryIteratorBase[ErrorLogEntry]

Iterator for error log queries

This iterator transparently handles batching and pagination over the results of an error log query

Construct an iterator

Parameters:

• client – QCPortal client object used to contact/retrieve data from the server

• query_filters (ErrorLogQueryFilters) – The actual query information to send to the server

reset()

Starts retrieval of results from the beginning again