create_resource_pool_payload.py

# coding: utf-8

"""
    STACKIT File Storage (SFS)

    API used to create and manage NFS Shares.

    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
from typing import Any, ClassVar, Dict, List, Optional, Set

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


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

    availability_zone: StrictStr = Field(description="Availability zone", alias="availabilityZone")
    ip_acl: List[StrictStr] = Field(
        description='List of IPs that can mount the Resource Pool in read-only; IPs must have a subnet mask (e.g. "172.16.0.0/24" for a range of IPs,  or "172.16.0.250/32" for a specific IP)',
        alias="ipAcl",
    )
    labels: Optional[Dict[str, StrictStr]] = Field(
        default=None,
        description="An optional object that represents the labels associated with the resource pool  keys are validated using the following regex '^[\\\\p{Ll}][\\\\p{Ll}\\\\p{N}_-]*$' and cannot be empty  values are validated using the following regex '^[\\\\p{Ll}\\\\p{N}_-]*$'",
    )
    name: StrictStr = Field(description="Name of the Resource Pool")
    performance_class: StrictStr = Field(description="Name of the performance class", alias="performanceClass")
    size_gigabytes: StrictInt = Field(
        description="Size of the Resource Pool   (unit: gibibytes)", alias="sizeGigabytes"
    )
    snapshots_are_visible: Optional[StrictBool] = Field(
        default=None,
        description="Whether the .snapshot directory is visible when mounting the resource pool.  Setting this value to false might prevent you from accessing the snapshots (e.g.  for security reasons). Additionally, the access to the snapshots is always controlled  by the export policy of the resource pool. That means, if snapshots are visible and  the export policy allows for reading the resource pool, then it also allows reading  the snapshot of all shares.",
        alias="snapshotsAreVisible",
    )
    __properties: ClassVar[List[str]] = [
        "availabilityZone",
        "ipAcl",
        "labels",
        "name",
        "performanceClass",
        "sizeGigabytes",
        "snapshotsAreVisible",
    ]

    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 CreateResourcePoolPayload 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 CreateResourcePoolPayload from a dict"""
        if obj is None:
            return None

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

        _obj = cls.model_validate(
            {
                "availabilityZone": obj.get("availabilityZone"),
                "ipAcl": obj.get("ipAcl"),
                "labels": obj.get("labels"),
                "name": obj.get("name"),
                "performanceClass": obj.get("performanceClass"),
                "sizeGigabytes": obj.get("sizeGigabytes"),
                "snapshotsAreVisible": obj.get("snapshotsAreVisible"),
            }
        )
        return _obj