thousandeyes-sdk-python/thousandeyes-sdk-snapshots/src/thousandeyes_sdk/snapshots/models/snapshot_request.py
Shahid Hussain Khan 9f18f0f6f2
[GitHub Bot] Generated python SDK (#42)
Co-authored-by: API Team <api-team@thousandeyes.com>
2024-08-11 09:57:09 +01:00

95 lines
3.1 KiB
Python

# coding: utf-8
"""
Test Snapshots API
Creates a new test snapshot in ThousandEyes.
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from __future__ import annotations
import pprint
import re # noqa: F401
import json
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from typing import Optional, Set
from typing_extensions import Self
class SnapshotRequest(BaseModel):
"""
SnapshotRequest
""" # noqa: E501
display_name: StrictStr = Field(description="Snapshot title.", alias="displayName")
start_date: datetime = Field(description="The start date for the snapshot in UTC time, formatted in ISO date-time.", alias="startDate")
end_date: datetime = Field(description="The end date for the snapshot in UTC time, formatted in ISO date-time.", alias="endDate")
is_public: Optional[StrictBool] = Field(default=None, description="Set to `true` for saved events and `false` for share links. Its default value is `false`.", alias="isPublic")
__properties: ClassVar[List[str]] = ["displayName", "startDate", "endDate", "isPublic"]
model_config = ConfigDict(
populate_by_name=True,
validate_assignment=True,
protected_namespaces=(),
extra="allow",
)
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 self.model_dump_json(by_alias=True, exclude_unset=True, exclude_none=True)
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
"""Create an instance of SnapshotRequest 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 SnapshotRequest from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
_obj = cls.model_validate({
"displayName": obj.get("displayName"),
"startDate": obj.get("startDate"),
"endDate": obj.get("endDate"),
"isPublic": obj.get("isPublic")
})
return _obj