Server Information

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

Bases: str, Enum

user = 'user'

day = 'day'

hour = 'hour'

country = 'country'

subdivision = 'subdivision'

pydantic model DeleteBeforeDateBody

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:

• before (datetime.datetime | None)

field before: datetime | None = None

pydantic model AccessLogQueryFilters

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:

• after (datetime.datetime | None)

• before (datetime.datetime | None)

• cursor (int | None)

• exclude (List[str] | None)

• include (List[str] | None)

• limit (int | None)

• method (List[qcportal.serverinfo.models.ConstrainedStrValue] | None)

• module (List[qcportal.serverinfo.models.ConstrainedStrValue] | None)

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

Validators:

• parse_dates » after

• parse_dates » before

• validate_lists » cursor

• validate_lists » limit

field module: List[ConstrainedStrValue] | None = None

field method: List[ConstrainedStrValue] | None = None

field user: List[int | str] | None = None

field before: datetime | None = None

Validated by:

• parse_dates

field after: datetime | None = None

Validated by:

• parse_dates

validator parse_dates  »  after, before

validator validate_lists  »  cursor, limit

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

pydantic model AccessLogEntry

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:

• city (str | None)

• country_code (str | None)

• full_uri (str | None)

• id (int)

• ip_address (pydantic.networks.IPvAnyAddress | None)

• ip_lat (float | None)

• ip_long (float | None)

• method (str)

• module (str | None)

• request_bytes (float | None)

• request_duration (float | None)

• response_bytes (float | None)

• subdivision (str | None)

• timestamp (datetime.datetime)

• user (str | None)

• user_agent (str | None)

field id: int [Required]

field timestamp: datetime [Required]

field method: str [Required]

field module: str | None = None

field full_uri: str | None = None

field request_duration: float | None = None

field request_bytes: float | None = None

field response_bytes: float | None = None

field user: str | None = None

field ip_address: IPvAnyAddress | None = None

Constraints:

• type = string

• format = ipvanyaddress

field user_agent: str | None = None

field country_code: str | None = None

field subdivision: str | None = None

field city: str | None = None

field ip_lat: float | None = None

field ip_long: float | None = 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

pydantic model AccessLogSummaryFilters

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:

• after (datetime.datetime | None)

• before (datetime.datetime | None)

• group_by (qcportal.serverinfo.models.GroupByEnum)

Validators:

• parse_dates » after

• parse_dates » before

• validate_lists » after

• validate_lists » before

• validate_lists » group_by

field group_by: GroupByEnum = GroupByEnum.day

Validated by:

• validate_lists

field before: datetime | None = None

Validated by:

• parse_dates

• validate_lists

field after: datetime | None = None

Validated by:

• parse_dates

• validate_lists

validator validate_lists  »  after, before, group_by

validator parse_dates  »  before, after

pydantic model AccessLogSummaryEntry

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:

• count (int)

• method (str)

• module (str | None)

• request_duration_info (List[float])

• response_bytes_info (List[float])

field module: str | None = None

field method: str [Required]

field count: int [Required]

field request_duration_info: List[float] [Required]

field response_bytes_info: List[float] [Required]

pydantic model AccessLogSummary

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:

• entries (Dict[str, List[qcportal.serverinfo.models.AccessLogSummaryEntry]])

field entries: Dict[str, List[AccessLogSummaryEntry]] [Required]

pydantic model ErrorLogQueryFilters

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.

Config:

• extra: Extra = Extra.forbid

• validate_assignment: bool = True

Fields:

• after (datetime.datetime | None)

• before (datetime.datetime | None)

• cursor (int | None)

• error_id (List[int] | None)

• limit (int | None)

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

Validators:

• parse_dates » after

• parse_dates » before

• validate_lists » cursor

• validate_lists » limit

field error_id: List[int] | None = None

field user: List[int | str] | None = None

field before: datetime | None = None

Validated by:

• parse_dates

field after: datetime | None = None

Validated by:

• parse_dates

validator parse_dates  »  after, before

validator validate_lists  »  cursor, limit

field limit: int | None = None

Validated by:

• validate_lists

field cursor: int | None = None

Validated by:

• validate_lists

pydantic model ErrorLogEntry

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:

• error_date (datetime.datetime)

• error_text (str | None)

• id (int)

• qcfractal_version (str)

• request_body (str | None)

• request_headers (str | None)

• request_path (str | None)

• user (str | None)

field id: int [Required]

field error_date: datetime [Required]

field qcfractal_version: str [Required]

field error_text: str | None = None

field user: str | None = None

field request_path: str | None = None

field request_headers: str | None = None

field request_body: str | None = 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