vectorize_client.models.get_pipeline_events_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, Field, StrictStr
21from typing import Any, ClassVar, Dict, List, Optional
22from vectorize_client.models.pipeline_events import PipelineEvents
23from typing import Optional, Set
24from typing_extensions import Self
25
26class GetPipelineEventsResponse(BaseModel):
27    """
28    GetPipelineEventsResponse
29    """ # noqa: E501
30    message: StrictStr
31    next_token: Optional[StrictStr] = Field(default=None, alias="nextToken")
32    data: List[PipelineEvents]
33    __properties: ClassVar[List[str]] = ["message", "nextToken", "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 GetPipelineEventsResponse 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 GetPipelineEventsResponse 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            "nextToken": obj.get("nextToken"),
95            "data": [PipelineEvents.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
96        })
97        return _obj

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

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

GetPipelineEventsResponse

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

next_token: Optional[Annotated[str, Strict(strict=True)]]

data: List[vectorize_client.models.pipeline_events.PipelineEvents]

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

43    def to_str(self) -> str:
44        """Returns the string representation of the model using alias"""
45        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

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

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

Create an instance of GetPipelineEventsResponse from a JSON string

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

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

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

Create an instance of GetPipelineEventsResponse from a dict