Module: record_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 Field
from cl.runtime.routers.user_request import UserRequest


class RecordRequest(UserRequest):
    """Request data type for the /storage/record route."""

    type: str
    """Class name."""

    # TODO: Check if it should be made optional for singletons
    key: str | None = None
    """Primary key fields in semicolon-delimited format."""

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

    dataset: str | None = None
    """Dataset string."""

    ignore_record_absence: bool = False
    """If true, empty response will be returned without error if the record is not found."""

Classes

class RecordRequest (**data: Any)

Request data type for the /storage/record 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 RecordRequest(UserRequest):
    """Request data type for the /storage/record route."""

    type: str
    """Class name."""

    # TODO: Check if it should be made optional for singletons
    key: str | None = None
    """Primary key fields in semicolon-delimited format."""

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

    dataset: str | None = None
    """Dataset string."""

    ignore_record_absence: bool = False
    """If true, empty response will be returned without error if the record is not found."""

Ancestors

UserRequest
pydantic.main.BaseModel

Class variables

var dataset: Dataset string.
var ignore_record_absence: If true, empty response will be returned without error if the record is not found.
var key: Primary key fields in semicolon-delimited format.
var model_computed_fields
var model_config
var model_fields
var module: Dot-delimited module string.
var type: Class name.
var user: Inherited from: UserRequest.user

User identifier or identity token