"""
Academic Observatory API
The REST API for accessing data from academic-observatory-workflows. # noqa: E501
The version of the OpenAPI document: 1.0.0
Contact: agent@observatory.academy
Generated by: https://openapi-generator.tech
"""
import re # noqa: F401
import sys # noqa: F401
from academic_observatory_api.client.model_utils import ( # noqa: F401
ApiTypeError,
ModelComposed,
ModelNormal,
ModelSimple,
cached_property,
change_keys_js_to_python,
convert_js_args_to_python_args,
date,
datetime,
file_type,
none_type,
validate_get_composed_info,
OpenApiModel
)
from academic_observatory_api.client.exceptions import ApiAttributeError
[docs]class QueryResponse(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
Attributes:
allowed_values (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
with a capitalized key describing the allowed value and an allowed
value. These dicts store the allowed enum values.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
discriminator_value_class_map (dict): A dict to go from the discriminator
variable value to the discriminator class name.
validations (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
that stores validations for max_length, min_length, max_items,
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
inclusive_minimum, and regex.
additional_properties_type (tuple): A tuple of classes accepted
as additional properties values.
"""
}
}
[docs] additional_properties_type = None
@cached_property
[docs] def openapi_types():
"""
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
Returns
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
return {
'version': (str,), # noqa: E501, F821
'index': (str,), # noqa: E501, F821
'pit': (str,), # noqa: E501, F821
'search_after': (str,), # noqa: E501, F821
'returned_hits': (int,), # noqa: E501, F821
'total_hits': (int,), # noqa: E501, F821
'schema': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501, F821
'results': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501, F821
}
@cached_property
[docs] def discriminator():
return None
[docs] attribute_map = {
'version': 'version', # noqa: E501
'index': 'index', # noqa: E501
'pit': 'pit', # noqa: E501
'search_after': 'search_after', # noqa: E501
'returned_hits': 'returned_hits', # noqa: E501
'total_hits': 'total_hits', # noqa: E501
'schema': 'schema', # noqa: E501
'results': 'results', # noqa: E501
}
}
@classmethod
@convert_js_args_to_python_args
[docs] def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
"""QueryResponse - a model defined in OpenAPI
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
Defaults to True
_path_to_item (tuple/list): This is a list of keys or values to
drill down to the model in received_data
when deserializing a response
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_configuration (Configuration): the instance to use when
deserializing a file_type parameter.
If passed, type conversion is attempted
If omitted no type conversion is done.
_visited_composed_classes (tuple): This stores a tuple of
classes that we have traveled through so that
if we see that class again we will not use its
discriminator again.
When traveling through a discriminator, the
composed schema that is
is traveled through is added to this set.
For example if Animal has a discriminator
petType and we pass in "Dog", and the class Dog
allOf includes Animal, we move through Animal
once using the discriminator, and pick Dog.
Then in Dog, we will make an instance of the
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
version (str): The API version. [optional] # noqa: E501
index (str): The full name of the elasticsearch index that is searched. [optional] # noqa: E501
pit (str): The most recent Point In Time id of the index that is searched, each search request can return a different id; thus always use the most recently received id for the next search request. . [optional] # noqa: E501
search_after (str): The sort value of the last item from the previous search, used to paginate. The results are sorted by _shard_doc when a PIT is used and by document id (_id) without a PIT. . [optional] # noqa: E501
returned_hits (int): The number of returned hits (can be less than total_hits if a limit is set). [optional] # noqa: E501
total_hits (int): The number of total hits. [optional] # noqa: E501
schema (bool, date, datetime, dict, float, int, list, str, none_type): The schema for an individual hit. [optional] # noqa: E501
results ([bool, date, datetime, dict, float, int, list, str, none_type]): A list of the actual results (one dictionary per hit). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
_path_to_item = kwargs.pop('_path_to_item', ())
_configuration = kwargs.pop('_configuration', None)
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
self = super(OpenApiModel, cls).__new__(cls)
if args:
for arg in args:
if isinstance(arg, dict):
kwargs.update(arg)
else:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
args,
self.__class__.__name__,
),
path_to_item=_path_to_item,
valid_classes=(self.__class__,),
)
self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
self._configuration.discard_unknown_keys and \
self.additional_properties_type is None:
# discard variable.
continue
setattr(self, var_name, var_value)
return self
[docs] required_properties = set([
'_data_store',
'_check_type',
'_spec_property_naming',
'_path_to_item',
'_configuration',
'_visited_composed_classes',
])
@convert_js_args_to_python_args
def __init__(self, *args, **kwargs): # noqa: E501
"""QueryResponse - a model defined in OpenAPI
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
Defaults to True
_path_to_item (tuple/list): This is a list of keys or values to
drill down to the model in received_data
when deserializing a response
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_configuration (Configuration): the instance to use when
deserializing a file_type parameter.
If passed, type conversion is attempted
If omitted no type conversion is done.
_visited_composed_classes (tuple): This stores a tuple of
classes that we have traveled through so that
if we see that class again we will not use its
discriminator again.
When traveling through a discriminator, the
composed schema that is
is traveled through is added to this set.
For example if Animal has a discriminator
petType and we pass in "Dog", and the class Dog
allOf includes Animal, we move through Animal
once using the discriminator, and pick Dog.
Then in Dog, we will make an instance of the
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
version (str): The API version. [optional] # noqa: E501
index (str): The full name of the elasticsearch index that is searched. [optional] # noqa: E501
pit (str): The most recent Point In Time id of the index that is searched, each search request can return a different id; thus always use the most recently received id for the next search request. . [optional] # noqa: E501
search_after (str): The sort value of the last item from the previous search, used to paginate. The results are sorted by _shard_doc when a PIT is used and by document id (_id) without a PIT. . [optional] # noqa: E501
returned_hits (int): The number of returned hits (can be less than total_hits if a limit is set). [optional] # noqa: E501
total_hits (int): The number of total hits. [optional] # noqa: E501
schema (bool, date, datetime, dict, float, int, list, str, none_type): The schema for an individual hit. [optional] # noqa: E501
results ([bool, date, datetime, dict, float, int, list, str, none_type]): A list of the actual results (one dictionary per hit). [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
_path_to_item = kwargs.pop('_path_to_item', ())
_configuration = kwargs.pop('_configuration', None)
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
if args:
for arg in args:
if isinstance(arg, dict):
kwargs.update(arg)
else:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
args,
self.__class__.__name__,
),
path_to_item=_path_to_item,
valid_classes=(self.__class__,),
)
self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
self._configuration.discard_unknown_keys and \
self.additional_properties_type is None:
# discard variable.
continue
setattr(self, var_name, var_value)
if var_name in self.read_only_vars:
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
f"class with read only attributes.")