Module: run_request

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from pydantic import BaseModel
from pydantic import Field


class RunRequest(BaseModel):
    """Request data type for the /tasks/run route."""

    user: str | None = Field(None)
    """User who triggered the task."""

    headers: dict[str, str] | None = Field(None)
    """Headers from the request."""

    db: str | None = Field(None)
    """Database to be used."""

    dataset: str | None = Field(None)
    """Dataset to be used."""

    table: str | None = Field(None)
    """Type with the handler."""

    method: str | None = Field(None)
    """Method (handler) to be executed."""

    keys: list[str | None] | str | None = Field(None)
    """Keys to be used."""

    arguments_: dict[str, str] | None = Field(None, alias="arguments")
    """Arguments for the task."""

    data_: dict[str, str] | None = Field(None, alias="data")
    """Data for the data handler"""

Classes

class RunRequest (**data: Any)

Request data type for the /tasks/run route.

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.

Expand source code

class RunRequest(BaseModel):
    """Request data type for the /tasks/run route."""

    user: str | None = Field(None)
    """User who triggered the task."""

    headers: dict[str, str] | None = Field(None)
    """Headers from the request."""

    db: str | None = Field(None)
    """Database to be used."""

    dataset: str | None = Field(None)
    """Dataset to be used."""

    table: str | None = Field(None)
    """Type with the handler."""

    method: str | None = Field(None)
    """Method (handler) to be executed."""

    keys: list[str | None] | str | None = Field(None)
    """Keys to be used."""

    arguments_: dict[str, str] | None = Field(None, alias="arguments")
    """Arguments for the task."""

    data_: dict[str, str] | None = Field(None, alias="data")
    """Data for the data handler"""

Ancestors

pydantic.main.BaseModel

Class variables

var arguments_: Arguments for the task.
var data_: Data for the data handler
var dataset: Dataset to be used.
var db: Database to be used.
var headers: Headers from the request.
var keys: Keys to be used.
var method: Method (handler) to be executed.
var model_computed_fields
var model_config
var model_fields
var table: Type with the handler.
var user: User who triggered the task.