qunicorn_core.api.models package

Submodules

qunicorn_core.api.models.deployment module

Module containing all API schemas for tasks in the Deployment API.

class qunicorn_core.api.models.deployment.PreDeploymentSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.models.devices module

Module containing all API schemas for tasks in the Devices API.

class qunicorn_core.api.models.devices.DeviceIDSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class qunicorn_core.api.models.devices.DevicesSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.models.jobs module

Module containing all API schemas for tasks in the Jobmanager API.

class qunicorn_core.api.models.jobs.JobIDSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class qunicorn_core.api.models.jobs.JobRegisterSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.models.root module

Module containing all API schemas for the root API endpoint.

class qunicorn_core.api.models.root.RootSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.models.services module

Module containing all API schemas for tasks in the Services API.

class qunicorn_core.api.models.services.ServiceIDSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class qunicorn_core.api.models.services.ServicesSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.models.users module

Module containing all API schemas for tasks in the Users API.

class qunicorn_core.api.models.users.UserIDSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class qunicorn_core.api.models.users.UsersSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Bases: MaBaseSchema

dump_fields: Dict[str, ma_fields.Field]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

Module contents

Module containing all schemas of the API.