vectorize_client.models.capella_config

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.

View Source

 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
21from typing import Any, ClassVar, Dict, List
22from typing_extensions import Annotated
23from typing import Optional, Set
24from typing_extensions import Self
25
26class CAPELLAConfig(BaseModel):
27    """
28    Configuration for Couchbase Capella connector
29    """ # noqa: E501
30    bucket: StrictStr = Field(description="Bucket Name. Example: Enter bucket name")
31    scope: StrictStr = Field(description="Scope Name. Example: Enter scope name")
32    collection: StrictStr = Field(description="Collection Name. Example: Enter collection name")
33    index: Annotated[str, Field(strict=True, max_length=255)] = Field(description="Search Index Name. Example: Enter search index name")
34    __properties: ClassVar[List[str]] = ["bucket", "scope", "collection", "index"]
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 CAPELLAConfig 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        return _dict
76
77    @classmethod
78    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
79        """Create an instance of CAPELLAConfig from a dict"""
80        if obj is None:
81            return None
82
83        if not isinstance(obj, dict):
84            return cls.model_validate(obj)
85
86        _obj = cls.model_validate({
87            "bucket": obj.get("bucket"),
88            "scope": obj.get("scope"),
89            "collection": obj.get("collection"),
90            "index": obj.get("index")
91        })
92        return _obj

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

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

Configuration for Couchbase Capella connector

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

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

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

index: typing.Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MaxLen(max_length=255)])]

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

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

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

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

Create an instance of CAPELLAConfig from a JSON string

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

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

78    @classmethod
79    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
80        """Create an instance of CAPELLAConfig from a dict"""
81        if obj is None:
82            return None
83
84        if not isinstance(obj, dict):
85            return cls.model_validate(obj)
86
87        _obj = cls.model_validate({
88            "bucket": obj.get("bucket"),
89            "scope": obj.get("scope"),
90            "collection": obj.get("collection"),
91            "index": obj.get("index")
92        })
93        return _obj

Create an instance of CAPELLAConfig from a dict