mypydantic.models.cloudsearchdomain

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from typing import Any, Dict, IO, List, Literal, Optional, Type, Union
  6
  7from botocore.response import StreamingBody
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class BucketModel(BaseModel):
 14    value: Optional[str] = Field(default=None, alias="value")
 15    count: Optional[int] = Field(default=None, alias="count")
 16
 17
 18class DocumentServiceWarningModel(BaseModel):
 19    message: Optional[str] = Field(default=None, alias="message")
 20
 21
 22class FieldStatsModel(BaseModel):
 23    min: Optional[str] = Field(default=None, alias="min")
 24    max: Optional[str] = Field(default=None, alias="max")
 25    count: Optional[int] = Field(default=None, alias="count")
 26    missing: Optional[int] = Field(default=None, alias="missing")
 27    sum: Optional[float] = Field(default=None, alias="sum")
 28    sum_of_squares: Optional[float] = Field(default=None, alias="sumOfSquares")
 29    mean: Optional[str] = Field(default=None, alias="mean")
 30    stddev: Optional[float] = Field(default=None, alias="stddev")
 31
 32
 33class HitModel(BaseModel):
 34    id: Optional[str] = Field(default=None, alias="id")
 35    fields: Optional[Dict[str, List[str]]] = Field(default=None, alias="fields")
 36    exprs: Optional[Dict[str, str]] = Field(default=None, alias="exprs")
 37    highlights: Optional[Dict[str, str]] = Field(default=None, alias="highlights")
 38
 39
 40class ResponseMetadataModel(BaseModel):
 41    request_id: str = Field(alias="RequestId")
 42    host_id: str = Field(alias="HostId")
 43    http_status_code: int = Field(alias="HTTPStatusCode")
 44    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 45    retry_attempts: int = Field(alias="RetryAttempts")
 46
 47
 48class SearchRequestModel(BaseModel):
 49    query: str = Field(alias="query")
 50    cursor: Optional[str] = Field(default=None, alias="cursor")
 51    expr: Optional[str] = Field(default=None, alias="expr")
 52    facet: Optional[str] = Field(default=None, alias="facet")
 53    filter_query: Optional[str] = Field(default=None, alias="filterQuery")
 54    highlight: Optional[str] = Field(default=None, alias="highlight")
 55    partial: Optional[bool] = Field(default=None, alias="partial")
 56    query_options: Optional[str] = Field(default=None, alias="queryOptions")
 57    query_parser: Optional[Literal["dismax", "lucene", "simple", "structured"]] = Field(
 58        default=None, alias="queryParser"
 59    )
 60    return_fields: Optional[str] = Field(default=None, alias="returnFields")
 61    size: Optional[int] = Field(default=None, alias="size")
 62    sort: Optional[str] = Field(default=None, alias="sort")
 63    start: Optional[int] = Field(default=None, alias="start")
 64    stats: Optional[str] = Field(default=None, alias="stats")
 65
 66
 67class SearchStatusModel(BaseModel):
 68    timems: Optional[int] = Field(default=None, alias="timems")
 69    rid: Optional[str] = Field(default=None, alias="rid")
 70
 71
 72class SuggestionMatchModel(BaseModel):
 73    suggestion: Optional[str] = Field(default=None, alias="suggestion")
 74    score: Optional[int] = Field(default=None, alias="score")
 75    id: Optional[str] = Field(default=None, alias="id")
 76
 77
 78class SuggestRequestModel(BaseModel):
 79    query: str = Field(alias="query")
 80    suggester: str = Field(alias="suggester")
 81    size: Optional[int] = Field(default=None, alias="size")
 82
 83
 84class SuggestStatusModel(BaseModel):
 85    timems: Optional[int] = Field(default=None, alias="timems")
 86    rid: Optional[str] = Field(default=None, alias="rid")
 87
 88
 89class UploadDocumentsRequestModel(BaseModel):
 90    documents: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
 91        alias="documents"
 92    )
 93    content_type: Literal["application/json", "application/xml"] = Field(
 94        alias="contentType"
 95    )
 96
 97
 98class BucketInfoModel(BaseModel):
 99    buckets: Optional[List[BucketModel]] = Field(default=None, alias="buckets")
100
101
102class HitsModel(BaseModel):
103    found: Optional[int] = Field(default=None, alias="found")
104    start: Optional[int] = Field(default=None, alias="start")
105    cursor: Optional[str] = Field(default=None, alias="cursor")
106    hit: Optional[List[HitModel]] = Field(default=None, alias="hit")
107
108
109class UploadDocumentsResponseModel(BaseModel):
110    status: str = Field(alias="status")
111    adds: int = Field(alias="adds")
112    deletes: int = Field(alias="deletes")
113    warnings: List[DocumentServiceWarningModel] = Field(alias="warnings")
114    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
115
116
117class SuggestModelModel(BaseModel):
118    query: Optional[str] = Field(default=None, alias="query")
119    found: Optional[int] = Field(default=None, alias="found")
120    suggestions: Optional[List[SuggestionMatchModel]] = Field(
121        default=None, alias="suggestions"
122    )
123
124
125class SearchResponseModel(BaseModel):
126    status: SearchStatusModel = Field(alias="status")
127    hits: HitsModel = Field(alias="hits")
128    facets: Dict[str, BucketInfoModel] = Field(alias="facets")
129    stats: Dict[str, FieldStatsModel] = Field(alias="stats")
130    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
131
132
133class SuggestResponseModel(BaseModel):
134    status: SuggestStatusModel = Field(alias="status")
135    suggest: SuggestModelModel = Field(alias="suggest")
136    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
class BucketModel(mypydantic.models.base_model.BaseModel):
14class BucketModel(BaseModel):
15    value: Optional[str] = Field(default=None, alias="value")
16    count: Optional[int] = Field(default=None, alias="count")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class DocumentServiceWarningModel(mypydantic.models.base_model.BaseModel):
19class DocumentServiceWarningModel(BaseModel):
20    message: Optional[str] = Field(default=None, alias="message")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class FieldStatsModel(mypydantic.models.base_model.BaseModel):
23class FieldStatsModel(BaseModel):
24    min: Optional[str] = Field(default=None, alias="min")
25    max: Optional[str] = Field(default=None, alias="max")
26    count: Optional[int] = Field(default=None, alias="count")
27    missing: Optional[int] = Field(default=None, alias="missing")
28    sum: Optional[float] = Field(default=None, alias="sum")
29    sum_of_squares: Optional[float] = Field(default=None, alias="sumOfSquares")
30    mean: Optional[str] = Field(default=None, alias="mean")
31    stddev: Optional[float] = Field(default=None, alias="stddev")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class HitModel(mypydantic.models.base_model.BaseModel):
34class HitModel(BaseModel):
35    id: Optional[str] = Field(default=None, alias="id")
36    fields: Optional[Dict[str, List[str]]] = Field(default=None, alias="fields")
37    exprs: Optional[Dict[str, str]] = Field(default=None, alias="exprs")
38    highlights: Optional[Dict[str, str]] = Field(default=None, alias="highlights")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class ResponseMetadataModel(mypydantic.models.base_model.BaseModel):
41class ResponseMetadataModel(BaseModel):
42    request_id: str = Field(alias="RequestId")
43    host_id: str = Field(alias="HostId")
44    http_status_code: int = Field(alias="HTTPStatusCode")
45    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
46    retry_attempts: int = Field(alias="RetryAttempts")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SearchRequestModel(mypydantic.models.base_model.BaseModel):
49class SearchRequestModel(BaseModel):
50    query: str = Field(alias="query")
51    cursor: Optional[str] = Field(default=None, alias="cursor")
52    expr: Optional[str] = Field(default=None, alias="expr")
53    facet: Optional[str] = Field(default=None, alias="facet")
54    filter_query: Optional[str] = Field(default=None, alias="filterQuery")
55    highlight: Optional[str] = Field(default=None, alias="highlight")
56    partial: Optional[bool] = Field(default=None, alias="partial")
57    query_options: Optional[str] = Field(default=None, alias="queryOptions")
58    query_parser: Optional[Literal["dismax", "lucene", "simple", "structured"]] = Field(
59        default=None, alias="queryParser"
60    )
61    return_fields: Optional[str] = Field(default=None, alias="returnFields")
62    size: Optional[int] = Field(default=None, alias="size")
63    sort: Optional[str] = Field(default=None, alias="sort")
64    start: Optional[int] = Field(default=None, alias="start")
65    stats: Optional[str] = Field(default=None, alias="stats")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SearchStatusModel(mypydantic.models.base_model.BaseModel):
68class SearchStatusModel(BaseModel):
69    timems: Optional[int] = Field(default=None, alias="timems")
70    rid: Optional[str] = Field(default=None, alias="rid")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SuggestionMatchModel(mypydantic.models.base_model.BaseModel):
73class SuggestionMatchModel(BaseModel):
74    suggestion: Optional[str] = Field(default=None, alias="suggestion")
75    score: Optional[int] = Field(default=None, alias="score")
76    id: Optional[str] = Field(default=None, alias="id")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SuggestRequestModel(mypydantic.models.base_model.BaseModel):
79class SuggestRequestModel(BaseModel):
80    query: str = Field(alias="query")
81    suggester: str = Field(alias="suggester")
82    size: Optional[int] = Field(default=None, alias="size")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SuggestStatusModel(mypydantic.models.base_model.BaseModel):
85class SuggestStatusModel(BaseModel):
86    timems: Optional[int] = Field(default=None, alias="timems")
87    rid: Optional[str] = Field(default=None, alias="rid")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class UploadDocumentsRequestModel(mypydantic.models.base_model.BaseModel):
90class UploadDocumentsRequestModel(BaseModel):
91    documents: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
92        alias="documents"
93    )
94    content_type: Literal["application/json", "application/xml"] = Field(
95        alias="contentType"
96    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class BucketInfoModel(mypydantic.models.base_model.BaseModel):
 99class BucketInfoModel(BaseModel):
100    buckets: Optional[List[BucketModel]] = Field(default=None, alias="buckets")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class HitsModel(mypydantic.models.base_model.BaseModel):
103class HitsModel(BaseModel):
104    found: Optional[int] = Field(default=None, alias="found")
105    start: Optional[int] = Field(default=None, alias="start")
106    cursor: Optional[str] = Field(default=None, alias="cursor")
107    hit: Optional[List[HitModel]] = Field(default=None, alias="hit")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class UploadDocumentsResponseModel(mypydantic.models.base_model.BaseModel):
110class UploadDocumentsResponseModel(BaseModel):
111    status: str = Field(alias="status")
112    adds: int = Field(alias="adds")
113    deletes: int = Field(alias="deletes")
114    warnings: List[DocumentServiceWarningModel] = Field(alias="warnings")
115    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SuggestModelModel(mypydantic.models.base_model.BaseModel):
118class SuggestModelModel(BaseModel):
119    query: Optional[str] = Field(default=None, alias="query")
120    found: Optional[int] = Field(default=None, alias="found")
121    suggestions: Optional[List[SuggestionMatchModel]] = Field(
122        default=None, alias="suggestions"
123    )
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SearchResponseModel(mypydantic.models.base_model.BaseModel):
126class SearchResponseModel(BaseModel):
127    status: SearchStatusModel = Field(alias="status")
128    hits: HitsModel = Field(alias="hits")
129    facets: Dict[str, BucketInfoModel] = Field(alias="facets")
130    stats: Dict[str, FieldStatsModel] = Field(alias="stats")
131    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs
class SuggestResponseModel(mypydantic.models.base_model.BaseModel):
134class SuggestResponseModel(BaseModel):
135    status: SuggestStatusModel = Field(alias="status")
136    suggest: SuggestModelModel = Field(alias="suggest")
137    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
mypydantic.models.base_model.BaseModel
BaseModel
Config
pydantic.main.BaseModel
dict
json
parse_obj
parse_raw
parse_file
from_orm
construct
copy
schema
schema_json
validate
update_forward_refs