vectorize_client.models.azureblob_auth_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, SecretStr, StrictStr
21from typing import Any, ClassVar, Dict, List, Optional
22from typing import Optional, Set
23from typing_extensions import Self
24
25class AZUREBLOBAuthConfig(BaseModel):
26    """
27    Authentication configuration for Azure Blob Storage
28    """ # noqa: E501
29    storage_account_name: StrictStr = Field(description="Storage Account Name. Example: Enter Storage Account Name", alias="storage-account-name")
30    storage_account_key: SecretStr = Field(description="Storage Account Key. Example: Enter Storage Account Key", alias="storage-account-key")
31    container: StrictStr = Field(description="Container. Example: Enter Container Name")
32    endpoint: Optional[StrictStr] = Field(default=None, description="Endpoint. Example: Enter Endpoint URL")
33    __properties: ClassVar[List[str]] = ["storage-account-name", "storage-account-key", "container", "endpoint"]
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 AZUREBLOBAuthConfig 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        return _dict
75
76    @classmethod
77    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
78        """Create an instance of AZUREBLOBAuthConfig from a dict"""
79        if obj is None:
80            return None
81
82        if not isinstance(obj, dict):
83            return cls.model_validate(obj)
84
85        _obj = cls.model_validate({
86            "storage-account-name": obj.get("storage-account-name"),
87            "storage-account-key": obj.get("storage-account-key"),
88            "container": obj.get("container"),
89            "endpoint": obj.get("endpoint")
90        })
91        return _obj

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

26class AZUREBLOBAuthConfig(BaseModel):
27    """
28    Authentication configuration for Azure Blob Storage
29    """ # noqa: E501
30    storage_account_name: StrictStr = Field(description="Storage Account Name. Example: Enter Storage Account Name", alias="storage-account-name")
31    storage_account_key: SecretStr = Field(description="Storage Account Key. Example: Enter Storage Account Key", alias="storage-account-key")
32    container: StrictStr = Field(description="Container. Example: Enter Container Name")
33    endpoint: Optional[StrictStr] = Field(default=None, description="Endpoint. Example: Enter Endpoint URL")
34    __properties: ClassVar[List[str]] = ["storage-account-name", "storage-account-key", "container", "endpoint"]
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 AZUREBLOBAuthConfig 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 AZUREBLOBAuthConfig 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            "storage-account-name": obj.get("storage-account-name"),
88            "storage-account-key": obj.get("storage-account-key"),
89            "container": obj.get("container"),
90            "endpoint": obj.get("endpoint")
91        })
92        return _obj

Authentication configuration for Azure Blob Storage

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

storage_account_key: pydantic.types.SecretStr

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

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

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

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 AZUREBLOBAuthConfig from a JSON string"""
55        return cls.from_dict(json.loads(json_str))

Create an instance of AZUREBLOBAuthConfig 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        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

77    @classmethod
78    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
79        """Create an instance of AZUREBLOBAuthConfig 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            "storage-account-name": obj.get("storage-account-name"),
88            "storage-account-key": obj.get("storage-account-key"),
89            "container": obj.get("container"),
90            "endpoint": obj.get("endpoint")
91        })
92        return _obj

Create an instance of AZUREBLOBAuthConfig from a dict