instance.py

# coding: utf-8

"""
    STACKIT Secrets Manager API

    This API provides endpoints for managing the Secrets-Manager. 

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

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

from __future__ import annotations

import json
import pprint
from typing import Any, ClassVar, Dict, List, Optional, Set

from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
from typing_extensions import Self

from stackit.secretsmanager.models.kms_key_payload import KmsKeyPayload


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

    api_url: StrictStr = Field(description="The API endpoint for connecting to the secrets engine.", alias="apiUrl")
    creation_finished_date: Optional[StrictStr] = Field(
        default=None,
        description="The date and time the creation of the Secrets Manager instance was finished.",
        alias="creationFinishedDate",
    )
    creation_start_date: StrictStr = Field(
        description="The date and time the creation of the Secrets Manager instance was triggered.",
        alias="creationStartDate",
    )
    id: StrictStr = Field(description="A auto generated unique id which identifies the secrets manager instances.")
    kms_key: Optional[KmsKeyPayload] = Field(default=None, alias="kmsKey")
    name: StrictStr = Field(description="A user chosen name to distinguish multiple secrets manager instances.")
    secret_count: StrictInt = Field(
        description="The number of secrets currently stored inside of the instance. This value will be updated once per hour.",
        alias="secretCount",
    )
    secrets_engine: StrictStr = Field(description="The name of the secrets engine.", alias="secretsEngine")
    state: StrictStr = Field(description="The current state of the Secrets Manager instance.")
    update_finished_date: Optional[StrictStr] = Field(default=None, alias="updateFinishedDate")
    update_start_date: Optional[StrictStr] = Field(default=None, alias="updateStartDate")
    __properties: ClassVar[List[str]] = [
        "apiUrl",
        "creationFinishedDate",
        "creationStartDate",
        "id",
        "kmsKey",
        "name",
        "secretCount",
        "secretsEngine",
        "state",
        "updateFinishedDate",
        "updateStartDate",
    ]

    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 Instance 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,
        )
        # override the default output from pydantic by calling `to_dict()` of kms_key
        if self.kms_key:
            _dict["kmsKey"] = self.kms_key.to_dict()
        return _dict

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

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

        _obj = cls.model_validate(
            {
                "apiUrl": obj.get("apiUrl"),
                "creationFinishedDate": obj.get("creationFinishedDate"),
                "creationStartDate": obj.get("creationStartDate"),
                "id": obj.get("id"),
                "kmsKey": KmsKeyPayload.from_dict(obj["kmsKey"]) if obj.get("kmsKey") is not None else None,
                "name": obj.get("name"),
                "secretCount": obj.get("secretCount"),
                "secretsEngine": obj.get("secretsEngine"),
                "state": obj.get("state"),
                "updateFinishedDate": obj.get("updateFinishedDate"),
                "updateStartDate": obj.get("updateStartDate"),
            }
        )
        return _obj