create_key_payload.py

# coding: utf-8

"""
    STACKIT Key Management Service API

    This API provides endpoints for managing keys and key rings. 

    The version of the OpenAPI document: 1.0.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Optional, Set

from pydantic import (
    BaseModel,
    ConfigDict,
    Field,
    StrictBool,
    StrictStr,
    field_validator,
)
from typing_extensions import Annotated, Self

from stackit.kms.models.access_scope import AccessScope
from stackit.kms.models.algorithm import Algorithm
from stackit.kms.models.protection import Protection
from stackit.kms.models.purpose import Purpose


class CreateKeyPayload(BaseModel):
    """
    CreateKeyPayload
    """  # noqa: E501

    access_scope: Optional[AccessScope] = AccessScope.PUBLIC
    algorithm: Algorithm
    description: Optional[StrictStr] = Field(
        default=None, description="A user chosen description to distinguish multiple keys."
    )
    display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
        description="The display name to distinguish multiple keys. Valid characters: letters, digits, underscores and hyphens.",
        alias="displayName",
    )
    import_only: Optional[StrictBool] = Field(
        default=False, description="States whether versions can be created or only imported.", alias="importOnly"
    )
    protection: Protection
    purpose: Purpose
    __properties: ClassVar[List[str]] = [
        "access_scope",
        "algorithm",
        "description",
        "displayName",
        "importOnly",
        "protection",
        "purpose",
    ]

    @field_validator("display_name")
    def display_name_validate_regular_expression(cls, value):
        """Validates the regular expression"""
        if not re.match(r"^[a-zA-Z0-9_-]+$", value):
            raise ValueError(r"must validate the regular expression /^[a-zA-Z0-9_-]+$/")
        return value

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )

    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))

    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())

    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of CreateKeyPayload from a JSON string"""
        return cls.from_dict(json.loads(json_str))

    def to_dict(self) -> Dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: Set[str] = set([])

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        return _dict

    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of CreateKeyPayload from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate(
            {
                "access_scope": obj.get("access_scope") if obj.get("access_scope") is not None else AccessScope.PUBLIC,
                "algorithm": obj.get("algorithm"),
                "description": obj.get("description"),
                "displayName": obj.get("displayName"),
                "importOnly": obj.get("importOnly") if obj.get("importOnly") is not None else False,
                "protection": obj.get("protection"),
                "purpose": obj.get("purpose"),
            }
        )
        return _obj