vectorize_client.models.sharepoint

Vectorize API

API for Vectorize services (Beta)

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

Do not edit the class manually.

  1# coding: utf-8
  2
  3"""
  4    Vectorize API
  5
  6    API for Vectorize services (Beta)
  7
  8    The version of the OpenAPI document: 0.1.2
  9    Generated by OpenAPI Generator (https://openapi-generator.tech)
 10
 11    Do not edit the class manually.
 12"""  # noqa: E501
 13
 14
 15from __future__ import annotations
 16import pprint
 17import re  # noqa: F401
 18import json
 19
 20from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 21from typing import Any, ClassVar, Dict, List
 22from vectorize_client.models.sharepoint_auth_config import SHAREPOINTAuthConfig
 23from typing import Optional, Set
 24from typing_extensions import Self
 25
 26class Sharepoint(BaseModel):
 27    """
 28    Sharepoint
 29    """ # noqa: E501
 30    name: StrictStr = Field(description="Name of the connector")
 31    type: StrictStr = Field(description="Connector type (must be \"SHAREPOINT\")")
 32    config: SHAREPOINTAuthConfig
 33    __properties: ClassVar[List[str]] = ["name", "type", "config"]
 34
 35    @field_validator('type')
 36    def type_validate_enum(cls, value):
 37        """Validates the enum"""
 38        if value not in set(['SHAREPOINT']):
 39            raise ValueError("must be one of enum values ('SHAREPOINT')")
 40        return value
 41
 42    model_config = ConfigDict(
 43        populate_by_name=True,
 44        validate_assignment=True,
 45        protected_namespaces=(),
 46    )
 47
 48
 49    def to_str(self) -> str:
 50        """Returns the string representation of the model using alias"""
 51        return pprint.pformat(self.model_dump(by_alias=True))
 52
 53    def to_json(self) -> str:
 54        """Returns the JSON representation of the model using alias"""
 55        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 56        return json.dumps(self.to_dict())
 57
 58    @classmethod
 59    def from_json(cls, json_str: str) -> Optional[Self]:
 60        """Create an instance of Sharepoint from a JSON string"""
 61        return cls.from_dict(json.loads(json_str))
 62
 63    def to_dict(self) -> Dict[str, Any]:
 64        """Return the dictionary representation of the model using alias.
 65
 66        This has the following differences from calling pydantic's
 67        `self.model_dump(by_alias=True)`:
 68
 69        * `None` is only added to the output dict for nullable fields that
 70          were set at model initialization. Other fields with value `None`
 71          are ignored.
 72        """
 73        excluded_fields: Set[str] = set([
 74        ])
 75
 76        _dict = self.model_dump(
 77            by_alias=True,
 78            exclude=excluded_fields,
 79            exclude_none=True,
 80        )
 81        # override the default output from pydantic by calling `to_dict()` of config
 82        if self.config:
 83            _dict['config'] = self.config.to_dict()
 84        return _dict
 85
 86    @classmethod
 87    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 88        """Create an instance of Sharepoint from a dict"""
 89        if obj is None:
 90            return None
 91
 92        if not isinstance(obj, dict):
 93            return cls.model_validate(obj)
 94
 95        _obj = cls.model_validate({
 96            "name": obj.get("name"),
 97            "type": obj.get("type"),
 98            "config": SHAREPOINTAuthConfig.from_dict(obj["config"]) if obj.get("config") is not None else None
 99        })
100        return _obj
class Sharepoint(pydantic.main.BaseModel): 
 27class Sharepoint(BaseModel):
 28    """
 29    Sharepoint
 30    """ # noqa: E501
 31    name: StrictStr = Field(description="Name of the connector")
 32    type: StrictStr = Field(description="Connector type (must be \"SHAREPOINT\")")
 33    config: SHAREPOINTAuthConfig
 34    __properties: ClassVar[List[str]] = ["name", "type", "config"]
 35
 36    @field_validator('type')
 37    def type_validate_enum(cls, value):
 38        """Validates the enum"""
 39        if value not in set(['SHAREPOINT']):
 40            raise ValueError("must be one of enum values ('SHAREPOINT')")
 41        return value
 42
 43    model_config = ConfigDict(
 44        populate_by_name=True,
 45        validate_assignment=True,
 46        protected_namespaces=(),
 47    )
 48
 49
 50    def to_str(self) -> str:
 51        """Returns the string representation of the model using alias"""
 52        return pprint.pformat(self.model_dump(by_alias=True))
 53
 54    def to_json(self) -> str:
 55        """Returns the JSON representation of the model using alias"""
 56        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 57        return json.dumps(self.to_dict())
 58
 59    @classmethod
 60    def from_json(cls, json_str: str) -> Optional[Self]:
 61        """Create an instance of Sharepoint from a JSON string"""
 62        return cls.from_dict(json.loads(json_str))
 63
 64    def to_dict(self) -> Dict[str, Any]:
 65        """Return the dictionary representation of the model using alias.
 66
 67        This has the following differences from calling pydantic's
 68        `self.model_dump(by_alias=True)`:
 69
 70        * `None` is only added to the output dict for nullable fields that
 71          were set at model initialization. Other fields with value `None`
 72          are ignored.
 73        """
 74        excluded_fields: Set[str] = set([
 75        ])
 76
 77        _dict = self.model_dump(
 78            by_alias=True,
 79            exclude=excluded_fields,
 80            exclude_none=True,
 81        )
 82        # override the default output from pydantic by calling `to_dict()` of config
 83        if self.config:
 84            _dict['config'] = self.config.to_dict()
 85        return _dict
 86
 87    @classmethod
 88    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 89        """Create an instance of Sharepoint from a dict"""
 90        if obj is None:
 91            return None
 92
 93        if not isinstance(obj, dict):
 94            return cls.model_validate(obj)
 95
 96        _obj = cls.model_validate({
 97            "name": obj.get("name"),
 98            "type": obj.get("type"),
 99            "config": SHAREPOINTAuthConfig.from_dict(obj["config"]) if obj.get("config") is not None else None
100        })
101        return _obj

Sharepoint

name: typing.Annotated[str, Strict(strict=True)]
type: typing.Annotated[str, Strict(strict=True)]
@field_validator('type')
def type_validate_enum(cls, value): 
36    @field_validator('type')
37    def type_validate_enum(cls, value):
38        """Validates the enum"""
39        if value not in set(['SHAREPOINT']):
40            raise ValueError("must be one of enum values ('SHAREPOINT')")
41        return value

Validates the enum

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': (), 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

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

Returns the string representation of the model using alias

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

Returns the JSON representation of the model using alias

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

Create an instance of Sharepoint from a JSON string

def to_dict(self) -> Dict[str, Any]: 
64    def to_dict(self) -> Dict[str, Any]:
65        """Return the dictionary representation of the model using alias.
66
67        This has the following differences from calling pydantic's
68        `self.model_dump(by_alias=True)`:
69
70        * `None` is only added to the output dict for nullable fields that
71          were set at model initialization. Other fields with value `None`
72          are ignored.
73        """
74        excluded_fields: Set[str] = set([
75        ])
76
77        _dict = self.model_dump(
78            by_alias=True,
79            exclude=excluded_fields,
80            exclude_none=True,
81        )
82        # override the default output from pydantic by calling `to_dict()` of config
83        if self.config:
84            _dict['config'] = self.config.to_dict()
85        return _dict

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.
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: 
 87    @classmethod
 88    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 89        """Create an instance of Sharepoint from a dict"""
 90        if obj is None:
 91            return None
 92
 93        if not isinstance(obj, dict):
 94            return cls.model_validate(obj)
 95
 96        _obj = cls.model_validate({
 97            "name": obj.get("name"),
 98            "type": obj.get("type"),
 99            "config": SHAREPOINTAuthConfig.from_dict(obj["config"]) if obj.get("config") is not None else None
100        })
101        return _obj

Create an instance of Sharepoint from a dict