vectorize_client.models.get_pipelines_response

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.

View Source

 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, StrictStr
21from typing import Any, ClassVar, Dict, List
22from vectorize_client.models.pipeline_list_summary import PipelineListSummary
23from typing import Optional, Set
24from typing_extensions import Self
25
26class GetPipelinesResponse(BaseModel):
27    """
28    GetPipelinesResponse
29    """ # noqa: E501
30    message: StrictStr
31    data: List[PipelineListSummary]
32    __properties: ClassVar[List[str]] = ["message", "data"]
33
34    model_config = ConfigDict(
35        populate_by_name=True,
36        validate_assignment=True,
37        protected_namespaces=(),
38    )
39
40
41    def to_str(self) -> str:
42        """Returns the string representation of the model using alias"""
43        return pprint.pformat(self.model_dump(by_alias=True))
44
45    def to_json(self) -> str:
46        """Returns the JSON representation of the model using alias"""
47        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
48        return json.dumps(self.to_dict())
49
50    @classmethod
51    def from_json(cls, json_str: str) -> Optional[Self]:
52        """Create an instance of GetPipelinesResponse from a JSON string"""
53        return cls.from_dict(json.loads(json_str))
54
55    def to_dict(self) -> Dict[str, Any]:
56        """Return the dictionary representation of the model using alias.
57
58        This has the following differences from calling pydantic's
59        `self.model_dump(by_alias=True)`:
60
61        * `None` is only added to the output dict for nullable fields that
62          were set at model initialization. Other fields with value `None`
63          are ignored.
64        """
65        excluded_fields: Set[str] = set([
66        ])
67
68        _dict = self.model_dump(
69            by_alias=True,
70            exclude=excluded_fields,
71            exclude_none=True,
72        )
73        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
74        _items = []
75        if self.data:
76            for _item_data in self.data:
77                if _item_data:
78                    _items.append(_item_data.to_dict())
79            _dict['data'] = _items
80        return _dict
81
82    @classmethod
83    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
84        """Create an instance of GetPipelinesResponse from a dict"""
85        if obj is None:
86            return None
87
88        if not isinstance(obj, dict):
89            return cls.model_validate(obj)
90
91        _obj = cls.model_validate({
92            "message": obj.get("message"),
93            "data": [PipelineListSummary.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
94        })
95        return _obj

class GetPipelinesResponse(pydantic.main.BaseModel): View Source

27class GetPipelinesResponse(BaseModel):
28    """
29    GetPipelinesResponse
30    """ # noqa: E501
31    message: StrictStr
32    data: List[PipelineListSummary]
33    __properties: ClassVar[List[str]] = ["message", "data"]
34
35    model_config = ConfigDict(
36        populate_by_name=True,
37        validate_assignment=True,
38        protected_namespaces=(),
39    )
40
41
42    def to_str(self) -> str:
43        """Returns the string representation of the model using alias"""
44        return pprint.pformat(self.model_dump(by_alias=True))
45
46    def to_json(self) -> str:
47        """Returns the JSON representation of the model using alias"""
48        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
49        return json.dumps(self.to_dict())
50
51    @classmethod
52    def from_json(cls, json_str: str) -> Optional[Self]:
53        """Create an instance of GetPipelinesResponse from a JSON string"""
54        return cls.from_dict(json.loads(json_str))
55
56    def to_dict(self) -> Dict[str, Any]:
57        """Return the dictionary representation of the model using alias.
58
59        This has the following differences from calling pydantic's
60        `self.model_dump(by_alias=True)`:
61
62        * `None` is only added to the output dict for nullable fields that
63          were set at model initialization. Other fields with value `None`
64          are ignored.
65        """
66        excluded_fields: Set[str] = set([
67        ])
68
69        _dict = self.model_dump(
70            by_alias=True,
71            exclude=excluded_fields,
72            exclude_none=True,
73        )
74        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
75        _items = []
76        if self.data:
77            for _item_data in self.data:
78                if _item_data:
79                    _items.append(_item_data.to_dict())
80            _dict['data'] = _items
81        return _dict
82
83    @classmethod
84    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
85        """Create an instance of GetPipelinesResponse from a dict"""
86        if obj is None:
87            return None
88
89        if not isinstance(obj, dict):
90            return cls.model_validate(obj)
91
92        _obj = cls.model_validate({
93            "message": obj.get("message"),
94            "data": [PipelineListSummary.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
95        })
96        return _obj

GetPipelinesResponse

message: typing.Annotated[str, Strict(strict=True)]

data: List[vectorize_client.models.pipeline_list_summary.PipelineListSummary]

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: View Source

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

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

46    def to_json(self) -> str:
47        """Returns the JSON representation of the model using alias"""
48        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
49        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]: View Source

51    @classmethod
52    def from_json(cls, json_str: str) -> Optional[Self]:
53        """Create an instance of GetPipelinesResponse from a JSON string"""
54        return cls.from_dict(json.loads(json_str))

Create an instance of GetPipelinesResponse from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

56    def to_dict(self) -> Dict[str, Any]:
57        """Return the dictionary representation of the model using alias.
58
59        This has the following differences from calling pydantic's
60        `self.model_dump(by_alias=True)`:
61
62        * `None` is only added to the output dict for nullable fields that
63          were set at model initialization. Other fields with value `None`
64          are ignored.
65        """
66        excluded_fields: Set[str] = set([
67        ])
68
69        _dict = self.model_dump(
70            by_alias=True,
71            exclude=excluded_fields,
72            exclude_none=True,
73        )
74        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
75        _items = []
76        if self.data:
77            for _item_data in self.data:
78                if _item_data:
79                    _items.append(_item_data.to_dict())
80            _dict['data'] = _items
81        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]: View Source

83    @classmethod
84    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
85        """Create an instance of GetPipelinesResponse from a dict"""
86        if obj is None:
87            return None
88
89        if not isinstance(obj, dict):
90            return cls.model_validate(obj)
91
92        _obj = cls.model_validate({
93            "message": obj.get("message"),
94            "data": [PipelineListSummary.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
95        })
96        return _obj

Create an instance of GetPipelinesResponse from a dict