Module: select_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 typing import Dict
from pydantic import BaseModel


class SelectRequest(BaseModel):
    """Request data type for the /storage/select route."""

    type_: str
    """The type of records."""

    query_dict: Dict | None = None
    """Query dictionary."""

    threshold: int | None = None
    """Select a specified number of records from the beginning of the list."""

    skip: int = 0
    """Number of skipped records from the beginning of the list."""

    module: str | None = None
    """Dot-delimited module string."""

    table_format: bool = False
    """If true, response will be returned in the table format."""

Classes

class SelectRequest (**data: Any)

Request data type for the /storage/select 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 SelectRequest(BaseModel):
    """Request data type for the /storage/select route."""

    type_: str
    """The type of records."""

    query_dict: Dict | None = None
    """Query dictionary."""

    threshold: int | None = None
    """Select a specified number of records from the beginning of the list."""

    skip: int = 0
    """Number of skipped records from the beginning of the list."""

    module: str | None = None
    """Dot-delimited module string."""

    table_format: bool = False
    """If true, response will be returned in the table format."""

Ancestors

pydantic.main.BaseModel

Class variables

var model_computed_fields
var model_config
var model_fields
var module: Dot-delimited module string.
var query_dict: Query dictionary.
var skip: Number of skipped records from the beginning of the list.
var table_format: If true, response will be returned in the table format.
var threshold: Select a specified number of records from the beginning of the list.
var type_: The type of records.