vectorize_client.models.pipeline_list_summary

Vectorize API (Beta)

API for Vectorize services

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

Do not edit the class manually.

  1# coding: utf-8
  2
  3"""
  4    Vectorize API (Beta)
  5
  6    API for Vectorize services
  7
  8    The version of the OpenAPI document: 0.0.1
  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, StrictFloat, StrictInt, StrictStr
 21from typing import Any, ClassVar, Dict, List, Optional, Union
 22from typing import Optional, Set
 23from typing_extensions import Self
 24
 25class PipelineListSummary(BaseModel):
 26    """
 27    PipelineListSummary
 28    """ # noqa: E501
 29    id: StrictStr
 30    name: StrictStr
 31    document_count: Union[StrictFloat, StrictInt] = Field(alias="documentCount")
 32    source_connector_auth_ids: List[StrictStr] = Field(alias="sourceConnectorAuthIds")
 33    destination_connector_auth_ids: List[StrictStr] = Field(alias="destinationConnectorAuthIds")
 34    ai_platform_auth_ids: List[StrictStr] = Field(alias="aiPlatformAuthIds")
 35    source_connector_types: List[StrictStr] = Field(alias="sourceConnectorTypes")
 36    destination_connector_types: List[StrictStr] = Field(alias="destinationConnectorTypes")
 37    ai_platform_types: List[StrictStr] = Field(alias="aiPlatformTypes")
 38    created_at: Optional[StrictStr] = Field(alias="createdAt")
 39    created_by: StrictStr = Field(alias="createdBy")
 40    status: Optional[StrictStr] = None
 41    config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc")
 42    __properties: ClassVar[List[str]] = ["id", "name", "documentCount", "sourceConnectorAuthIds", "destinationConnectorAuthIds", "aiPlatformAuthIds", "sourceConnectorTypes", "destinationConnectorTypes", "aiPlatformTypes", "createdAt", "createdBy", "status", "configDoc"]
 43
 44    model_config = ConfigDict(
 45        populate_by_name=True,
 46        validate_assignment=True,
 47        protected_namespaces=(),
 48    )
 49
 50
 51    def to_str(self) -> str:
 52        """Returns the string representation of the model using alias"""
 53        return pprint.pformat(self.model_dump(by_alias=True))
 54
 55    def to_json(self) -> str:
 56        """Returns the JSON representation of the model using alias"""
 57        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 58        return json.dumps(self.to_dict())
 59
 60    @classmethod
 61    def from_json(cls, json_str: str) -> Optional[Self]:
 62        """Create an instance of PipelineListSummary from a JSON string"""
 63        return cls.from_dict(json.loads(json_str))
 64
 65    def to_dict(self) -> Dict[str, Any]:
 66        """Return the dictionary representation of the model using alias.
 67
 68        This has the following differences from calling pydantic's
 69        `self.model_dump(by_alias=True)`:
 70
 71        * `None` is only added to the output dict for nullable fields that
 72          were set at model initialization. Other fields with value `None`
 73          are ignored.
 74        """
 75        excluded_fields: Set[str] = set([
 76        ])
 77
 78        _dict = self.model_dump(
 79            by_alias=True,
 80            exclude=excluded_fields,
 81            exclude_none=True,
 82        )
 83        # set to None if created_at (nullable) is None
 84        # and model_fields_set contains the field
 85        if self.created_at is None and "created_at" in self.model_fields_set:
 86            _dict['createdAt'] = None
 87
 88        return _dict
 89
 90    @classmethod
 91    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 92        """Create an instance of PipelineListSummary from a dict"""
 93        if obj is None:
 94            return None
 95
 96        if not isinstance(obj, dict):
 97            return cls.model_validate(obj)
 98
 99        _obj = cls.model_validate({
100            "id": obj.get("id"),
101            "name": obj.get("name"),
102            "documentCount": obj.get("documentCount"),
103            "sourceConnectorAuthIds": obj.get("sourceConnectorAuthIds"),
104            "destinationConnectorAuthIds": obj.get("destinationConnectorAuthIds"),
105            "aiPlatformAuthIds": obj.get("aiPlatformAuthIds"),
106            "sourceConnectorTypes": obj.get("sourceConnectorTypes"),
107            "destinationConnectorTypes": obj.get("destinationConnectorTypes"),
108            "aiPlatformTypes": obj.get("aiPlatformTypes"),
109            "createdAt": obj.get("createdAt"),
110            "createdBy": obj.get("createdBy"),
111            "status": obj.get("status"),
112            "configDoc": obj.get("configDoc")
113        })
114        return _obj
class PipelineListSummary(pydantic.main.BaseModel):
 26class PipelineListSummary(BaseModel):
 27    """
 28    PipelineListSummary
 29    """ # noqa: E501
 30    id: StrictStr
 31    name: StrictStr
 32    document_count: Union[StrictFloat, StrictInt] = Field(alias="documentCount")
 33    source_connector_auth_ids: List[StrictStr] = Field(alias="sourceConnectorAuthIds")
 34    destination_connector_auth_ids: List[StrictStr] = Field(alias="destinationConnectorAuthIds")
 35    ai_platform_auth_ids: List[StrictStr] = Field(alias="aiPlatformAuthIds")
 36    source_connector_types: List[StrictStr] = Field(alias="sourceConnectorTypes")
 37    destination_connector_types: List[StrictStr] = Field(alias="destinationConnectorTypes")
 38    ai_platform_types: List[StrictStr] = Field(alias="aiPlatformTypes")
 39    created_at: Optional[StrictStr] = Field(alias="createdAt")
 40    created_by: StrictStr = Field(alias="createdBy")
 41    status: Optional[StrictStr] = None
 42    config_doc: Optional[Dict[str, Any]] = Field(default=None, alias="configDoc")
 43    __properties: ClassVar[List[str]] = ["id", "name", "documentCount", "sourceConnectorAuthIds", "destinationConnectorAuthIds", "aiPlatformAuthIds", "sourceConnectorTypes", "destinationConnectorTypes", "aiPlatformTypes", "createdAt", "createdBy", "status", "configDoc"]
 44
 45    model_config = ConfigDict(
 46        populate_by_name=True,
 47        validate_assignment=True,
 48        protected_namespaces=(),
 49    )
 50
 51
 52    def to_str(self) -> str:
 53        """Returns the string representation of the model using alias"""
 54        return pprint.pformat(self.model_dump(by_alias=True))
 55
 56    def to_json(self) -> str:
 57        """Returns the JSON representation of the model using alias"""
 58        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
 59        return json.dumps(self.to_dict())
 60
 61    @classmethod
 62    def from_json(cls, json_str: str) -> Optional[Self]:
 63        """Create an instance of PipelineListSummary from a JSON string"""
 64        return cls.from_dict(json.loads(json_str))
 65
 66    def to_dict(self) -> Dict[str, Any]:
 67        """Return the dictionary representation of the model using alias.
 68
 69        This has the following differences from calling pydantic's
 70        `self.model_dump(by_alias=True)`:
 71
 72        * `None` is only added to the output dict for nullable fields that
 73          were set at model initialization. Other fields with value `None`
 74          are ignored.
 75        """
 76        excluded_fields: Set[str] = set([
 77        ])
 78
 79        _dict = self.model_dump(
 80            by_alias=True,
 81            exclude=excluded_fields,
 82            exclude_none=True,
 83        )
 84        # set to None if created_at (nullable) is None
 85        # and model_fields_set contains the field
 86        if self.created_at is None and "created_at" in self.model_fields_set:
 87            _dict['createdAt'] = None
 88
 89        return _dict
 90
 91    @classmethod
 92    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 93        """Create an instance of PipelineListSummary from a dict"""
 94        if obj is None:
 95            return None
 96
 97        if not isinstance(obj, dict):
 98            return cls.model_validate(obj)
 99
100        _obj = cls.model_validate({
101            "id": obj.get("id"),
102            "name": obj.get("name"),
103            "documentCount": obj.get("documentCount"),
104            "sourceConnectorAuthIds": obj.get("sourceConnectorAuthIds"),
105            "destinationConnectorAuthIds": obj.get("destinationConnectorAuthIds"),
106            "aiPlatformAuthIds": obj.get("aiPlatformAuthIds"),
107            "sourceConnectorTypes": obj.get("sourceConnectorTypes"),
108            "destinationConnectorTypes": obj.get("destinationConnectorTypes"),
109            "aiPlatformTypes": obj.get("aiPlatformTypes"),
110            "createdAt": obj.get("createdAt"),
111            "createdBy": obj.get("createdBy"),
112            "status": obj.get("status"),
113            "configDoc": obj.get("configDoc")
114        })
115        return _obj

PipelineListSummary

id: typing.Annotated[str, Strict(strict=True)]
name: typing.Annotated[str, Strict(strict=True)]
document_count: Union[Annotated[float, Strict(strict=True)], Annotated[int, Strict(strict=True)]]
source_connector_auth_ids: List[Annotated[str, Strict(strict=True)]]
destination_connector_auth_ids: List[Annotated[str, Strict(strict=True)]]
ai_platform_auth_ids: List[Annotated[str, Strict(strict=True)]]
source_connector_types: List[Annotated[str, Strict(strict=True)]]
destination_connector_types: List[Annotated[str, Strict(strict=True)]]
ai_platform_types: List[Annotated[str, Strict(strict=True)]]
created_at: Optional[Annotated[str, Strict(strict=True)]]
created_by: typing.Annotated[str, Strict(strict=True)]
status: Optional[Annotated[str, Strict(strict=True)]]
config_doc: Optional[Dict[str, Any]]
model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

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

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

Returns the string representation of the model using alias

def to_json(self) -> str:
56    def to_json(self) -> str:
57        """Returns the JSON representation of the model using alias"""
58        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
59        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]:
61    @classmethod
62    def from_json(cls, json_str: str) -> Optional[Self]:
63        """Create an instance of PipelineListSummary from a JSON string"""
64        return cls.from_dict(json.loads(json_str))

Create an instance of PipelineListSummary from a JSON string

def to_dict(self) -> Dict[str, Any]:
66    def to_dict(self) -> Dict[str, Any]:
67        """Return the dictionary representation of the model using alias.
68
69        This has the following differences from calling pydantic's
70        `self.model_dump(by_alias=True)`:
71
72        * `None` is only added to the output dict for nullable fields that
73          were set at model initialization. Other fields with value `None`
74          are ignored.
75        """
76        excluded_fields: Set[str] = set([
77        ])
78
79        _dict = self.model_dump(
80            by_alias=True,
81            exclude=excluded_fields,
82            exclude_none=True,
83        )
84        # set to None if created_at (nullable) is None
85        # and model_fields_set contains the field
86        if self.created_at is None and "created_at" in self.model_fields_set:
87            _dict['createdAt'] = None
88
89        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]:
 91    @classmethod
 92    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 93        """Create an instance of PipelineListSummary from a dict"""
 94        if obj is None:
 95            return None
 96
 97        if not isinstance(obj, dict):
 98            return cls.model_validate(obj)
 99
100        _obj = cls.model_validate({
101            "id": obj.get("id"),
102            "name": obj.get("name"),
103            "documentCount": obj.get("documentCount"),
104            "sourceConnectorAuthIds": obj.get("sourceConnectorAuthIds"),
105            "destinationConnectorAuthIds": obj.get("destinationConnectorAuthIds"),
106            "aiPlatformAuthIds": obj.get("aiPlatformAuthIds"),
107            "sourceConnectorTypes": obj.get("sourceConnectorTypes"),
108            "destinationConnectorTypes": obj.get("destinationConnectorTypes"),
109            "aiPlatformTypes": obj.get("aiPlatformTypes"),
110            "createdAt": obj.get("createdAt"),
111            "createdBy": obj.get("createdBy"),
112            "status": obj.get("status"),
113            "configDoc": obj.get("configDoc")
114        })
115        return _obj

Create an instance of PipelineListSummary from a dict