github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/python-legacy/lakefs_client/model/prepare_gc_uncommitted_response.py (about)

     1  """
     2      lakeFS API
     3  
     4      lakeFS HTTP API  # noqa: E501
     5  
     6      The version of the OpenAPI document: 1.0.0
     7      Contact: services@treeverse.io
     8      Generated by: https://openapi-generator.tech
     9  """
    10  
    11  
    12  import re  # noqa: F401
    13  import sys  # noqa: F401
    14  
    15  from lakefs_client.model_utils import (  # noqa: F401
    16      ApiTypeError,
    17      ModelComposed,
    18      ModelNormal,
    19      ModelSimple,
    20      cached_property,
    21      change_keys_js_to_python,
    22      convert_js_args_to_python_args,
    23      date,
    24      datetime,
    25      file_type,
    26      none_type,
    27      validate_get_composed_info,
    28  )
    29  from ..model_utils import OpenApiModel
    30  from lakefs_client.exceptions import ApiAttributeError
    31  
    32  
    33  
    34  class PrepareGCUncommittedResponse(ModelNormal):
    35      """NOTE: This class is auto generated by OpenAPI Generator.
    36      Ref: https://openapi-generator.tech
    37  
    38      Do not edit the class manually.
    39  
    40      Attributes:
    41        allowed_values (dict): The key is the tuple path to the attribute
    42            and the for var_name this is (var_name,). The value is a dict
    43            with a capitalized key describing the allowed value and an allowed
    44            value. These dicts store the allowed enum values.
    45        attribute_map (dict): The key is attribute name
    46            and the value is json key in definition.
    47        discriminator_value_class_map (dict): A dict to go from the discriminator
    48            variable value to the discriminator class name.
    49        validations (dict): The key is the tuple path to the attribute
    50            and the for var_name this is (var_name,). The value is a dict
    51            that stores validations for max_length, min_length, max_items,
    52            min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
    53            inclusive_minimum, and regex.
    54        additional_properties_type (tuple): A tuple of classes accepted
    55            as additional properties values.
    56      """
    57  
    58      allowed_values = {
    59      }
    60  
    61      validations = {
    62      }
    63  
    64      @cached_property
    65      def additional_properties_type():
    66          """
    67          This must be a method because a model may have properties that are
    68          of type self, this must run after the class is loaded
    69          """
    70          return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
    71  
    72      _nullable = False
    73  
    74      @cached_property
    75      def openapi_types():
    76          """
    77          This must be a method because a model may have properties that are
    78          of type self, this must run after the class is loaded
    79  
    80          Returns
    81              openapi_types (dict): The key is attribute name
    82                  and the value is attribute type.
    83          """
    84          return {
    85              'run_id': (str,),  # noqa: E501
    86              'gc_uncommitted_location': (str,),  # noqa: E501
    87              'continuation_token': (str,),  # noqa: E501
    88          }
    89  
    90      @cached_property
    91      def discriminator():
    92          return None
    93  
    94  
    95      attribute_map = {
    96          'run_id': 'run_id',  # noqa: E501
    97          'gc_uncommitted_location': 'gc_uncommitted_location',  # noqa: E501
    98          'continuation_token': 'continuation_token',  # noqa: E501
    99      }
   100  
   101      read_only_vars = {
   102      }
   103  
   104      _composed_schemas = {}
   105  
   106      @classmethod
   107      @convert_js_args_to_python_args
   108      def _from_openapi_data(cls, run_id, gc_uncommitted_location, *args, **kwargs):  # noqa: E501
   109          """PrepareGCUncommittedResponse - a model defined in OpenAPI
   110  
   111          Args:
   112              run_id (str):
   113              gc_uncommitted_location (str): location of uncommitted information data
   114  
   115          Keyword Args:
   116              _check_type (bool): if True, values for parameters in openapi_types
   117                                  will be type checked and a TypeError will be
   118                                  raised if the wrong type is input.
   119                                  Defaults to True
   120              _path_to_item (tuple/list): This is a list of keys or values to
   121                                  drill down to the model in received_data
   122                                  when deserializing a response
   123              _spec_property_naming (bool): True if the variable names in the input data
   124                                  are serialized names, as specified in the OpenAPI document.
   125                                  False if the variable names in the input data
   126                                  are pythonic names, e.g. snake case (default)
   127              _configuration (Configuration): the instance to use when
   128                                  deserializing a file_type parameter.
   129                                  If passed, type conversion is attempted
   130                                  If omitted no type conversion is done.
   131              _visited_composed_classes (tuple): This stores a tuple of
   132                                  classes that we have traveled through so that
   133                                  if we see that class again we will not use its
   134                                  discriminator again.
   135                                  When traveling through a discriminator, the
   136                                  composed schema that is
   137                                  is traveled through is added to this set.
   138                                  For example if Animal has a discriminator
   139                                  petType and we pass in "Dog", and the class Dog
   140                                  allOf includes Animal, we move through Animal
   141                                  once using the discriminator, and pick Dog.
   142                                  Then in Dog, we will make an instance of the
   143                                  Animal class but this time we won't travel
   144                                  through its discriminator because we passed in
   145                                  _visited_composed_classes = (Animal,)
   146              continuation_token (str): [optional]  # noqa: E501
   147          """
   148  
   149          _check_type = kwargs.pop('_check_type', True)
   150          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   151          _path_to_item = kwargs.pop('_path_to_item', ())
   152          _configuration = kwargs.pop('_configuration', None)
   153          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   154  
   155          self = super(OpenApiModel, cls).__new__(cls)
   156  
   157          if args:
   158              raise ApiTypeError(
   159                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   160                      args,
   161                      self.__class__.__name__,
   162                  ),
   163                  path_to_item=_path_to_item,
   164                  valid_classes=(self.__class__,),
   165              )
   166  
   167          self._data_store = {}
   168          self._check_type = _check_type
   169          self._spec_property_naming = _spec_property_naming
   170          self._path_to_item = _path_to_item
   171          self._configuration = _configuration
   172          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   173  
   174          self.run_id = run_id
   175          self.gc_uncommitted_location = gc_uncommitted_location
   176          for var_name, var_value in kwargs.items():
   177              if var_name not in self.attribute_map and \
   178                          self._configuration is not None and \
   179                          self._configuration.discard_unknown_keys and \
   180                          self.additional_properties_type is None:
   181                  # discard variable.
   182                  continue
   183              setattr(self, var_name, var_value)
   184          return self
   185  
   186      required_properties = set([
   187          '_data_store',
   188          '_check_type',
   189          '_spec_property_naming',
   190          '_path_to_item',
   191          '_configuration',
   192          '_visited_composed_classes',
   193      ])
   194  
   195      @convert_js_args_to_python_args
   196      def __init__(self, run_id, gc_uncommitted_location, *args, **kwargs):  # noqa: E501
   197          """PrepareGCUncommittedResponse - a model defined in OpenAPI
   198  
   199          Args:
   200              run_id (str):
   201              gc_uncommitted_location (str): location of uncommitted information data
   202  
   203          Keyword Args:
   204              _check_type (bool): if True, values for parameters in openapi_types
   205                                  will be type checked and a TypeError will be
   206                                  raised if the wrong type is input.
   207                                  Defaults to True
   208              _path_to_item (tuple/list): This is a list of keys or values to
   209                                  drill down to the model in received_data
   210                                  when deserializing a response
   211              _spec_property_naming (bool): True if the variable names in the input data
   212                                  are serialized names, as specified in the OpenAPI document.
   213                                  False if the variable names in the input data
   214                                  are pythonic names, e.g. snake case (default)
   215              _configuration (Configuration): the instance to use when
   216                                  deserializing a file_type parameter.
   217                                  If passed, type conversion is attempted
   218                                  If omitted no type conversion is done.
   219              _visited_composed_classes (tuple): This stores a tuple of
   220                                  classes that we have traveled through so that
   221                                  if we see that class again we will not use its
   222                                  discriminator again.
   223                                  When traveling through a discriminator, the
   224                                  composed schema that is
   225                                  is traveled through is added to this set.
   226                                  For example if Animal has a discriminator
   227                                  petType and we pass in "Dog", and the class Dog
   228                                  allOf includes Animal, we move through Animal
   229                                  once using the discriminator, and pick Dog.
   230                                  Then in Dog, we will make an instance of the
   231                                  Animal class but this time we won't travel
   232                                  through its discriminator because we passed in
   233                                  _visited_composed_classes = (Animal,)
   234              continuation_token (str): [optional]  # noqa: E501
   235          """
   236  
   237          _check_type = kwargs.pop('_check_type', True)
   238          _spec_property_naming = kwargs.pop('_spec_property_naming', False)
   239          _path_to_item = kwargs.pop('_path_to_item', ())
   240          _configuration = kwargs.pop('_configuration', None)
   241          _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
   242  
   243          if args:
   244              raise ApiTypeError(
   245                  "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
   246                      args,
   247                      self.__class__.__name__,
   248                  ),
   249                  path_to_item=_path_to_item,
   250                  valid_classes=(self.__class__,),
   251              )
   252  
   253          self._data_store = {}
   254          self._check_type = _check_type
   255          self._spec_property_naming = _spec_property_naming
   256          self._path_to_item = _path_to_item
   257          self._configuration = _configuration
   258          self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
   259  
   260          self.run_id = run_id
   261          self.gc_uncommitted_location = gc_uncommitted_location
   262          for var_name, var_value in kwargs.items():
   263              if var_name not in self.attribute_map and \
   264                          self._configuration is not None and \
   265                          self._configuration.discard_unknown_keys and \
   266                          self.additional_properties_type is None:
   267                  # discard variable.
   268                  continue
   269              setattr(self, var_name, var_value)
   270              if var_name in self.read_only_vars:
   271                  raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
   272                                       f"class with read only attributes.")