ai_api_client_sdk.models.base_models
index
/home/jenkins/agent/workspace/ndation_ai-api-client-sdk_master/ai_api_client_sdk/models/base_models.py

 
Classes
       
aenum.Enum(builtins.object)
Operation
builtins.object
BasicErrorResponse
BasicModifyRequest
BasicResponse
BulkModifyErrorResponse
KeyValue
Name
NameValue
QueryResponse
enum.Enum(builtins.object)
Order

 
class BasicErrorResponse(builtins.object)
    BasicErrorResponse(code: str, message: str, request_id: str, target: str, details: Dict = None, **kwargs)
 
The BasicErrorResponse object defines the response from the server
 
:param error_code: Error code from the server
:type error_code: str
:param message: Error message from the server
:type message: str
:param request_id: Request ID
:type request_id: str  
:param target: target
:type target: str, optional
:param details: Error details
:type details: Dict, optional   
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
  Methods defined here:
__init__(self, code: str, message: str, request_id: str, target: str, details: Dict = None, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).

Static methods defined here:
from_dict(ber_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicErrorResponseobject, created from the values 
provided as parameter
 
:param ber_dict: Dict which includes the necessary values to create the object
:type ber_dict: Dict[str, str]
:return: An object, created from the values provided
:rtype: class:`ai_api_client_sdk.models.base_models.BasicErrorResponse`

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class BasicModifyRequest(builtins.object)
    BasicModifyRequest(id: str, target_status: ai_api_client_sdk.models.target_status.TargetStatus, **kwargs)
 
The BasicModifyRequest object defines the request from client
:param id: ID of the relevant resource
:type id: str
:param target_status: Target Status of the resource
:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
  Methods defined here:
__init__(self, id: str, target_status: ai_api_client_sdk.models.target_status.TargetStatus, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).
to_dict(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class BasicResponse(builtins.object)
    BasicResponse(id: str, message: str, **kwargs)
 
The BasicResponse object defines the response from the server
 
:param id: ID of the relevant resource
:type id: str
:param message: Response message from the server
:type message: str
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
  Methods defined here:
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).

Static methods defined here:
from_dict(br_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicResponseobject, created from the values in the
dict provided as parameter
 
:param br_dict: Dict which includes the necessary values to create the object
:type br_dict: Dict[str, str]
:return: An object, created from the values provided
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class BulkModifyErrorResponse(builtins.object)
    BulkModifyErrorResponse(id: str, error: ai_api_client_sdk.models.base_models.BasicErrorResponse, **kwargs)
 
The BulkModifyErrorResponse object defines the error response from the server
 
  Methods defined here:
__init__(self, id: str, error: ai_api_client_sdk.models.base_models.BasicErrorResponse, **kwargs)
Creates an error object for a bulk modification call
 
:param id: ID of the relevant resource
:type id: str
:param error: Error object response from the server
:type error: BasicErrorResponse
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
__str__(self)
Return str(self).

Static methods defined here:
from_dict(error_dict: Dict[str, Union[str, Dict]])
:param error_dict: Dict which includes the necessary values to create the object
:type error_dict: Dict[str, Union[str, Dict]]
 
Returns:
    Returns a class:`ai_api_client_sdk.models.base_models.BulkModifyErrorResponseobject

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class KeyValue(builtins.object)
    KeyValue(key: str, value: str, **kwargs)
 
KeyValue object defines a key-value pair
 
:param key: key of the pair
:type key: str
:param value: value of the pair
:type value: str
 
  Methods defined here:
__eq__(self, other)
Return self==value.
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).
to_dict(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__hash__ = None

 
class Name(builtins.object)
    Name(name: str, **kwargs)
 
KeyValue object defines a name
 
:param name: name
:type name: str
 
  Methods defined here:
__eq__(self, other)
Return self==value.
__init__(self, name: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__hash__ = None

 
class NameValue(builtins.object)
    NameValue(name: str, value: str, **kwargs)
 
KeyValue object defines a name-value pair
 
:param name: name of the pair
:type name: str
:param value: value of the pair
:type value: str
 
  Methods defined here:
__eq__(self, other)
Return self==value.
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
__hash__ = None

 
class Operation(aenum.Enum)
    Operation(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)
 
An enumeration.
 
 
Method resolution order:
Operation
aenum.Enum
builtins.object

Data and other attributes defined here:
CASCADE_UPDATE = <Operation.CASCADE_UPDATE: 'CASCADE-UPDATE'>
CREATE = <Operation.CREATE: 'CREATE'>
DELETE = <Operation.DELETE: 'DELETE'>
UPDATE = <Operation.UPDATE: 'UPDATE'>

Class methods inherited from aenum.Enum:
__init_subclass__(**kwds) from aenum.EnumType
This method is called when a class is subclassed.
 
The default implementation does nothing. It may be
overridden to extend subclasses.

Data descriptors inherited from aenum.Enum:
name
value
values

Methods inherited from aenum.EnumType:
__contains__(member) from aenum.EnumType
__getitem__(name) from aenum.EnumType
__iter__() from aenum.EnumType
__len__() from aenum.EnumType

Readonly properties inherited from aenum.EnumType:
__members__
Returns a mapping of member name->value.
 
This mapping lists all enum members, including aliases. Note that this
is a copy of the internal mapping.

 
class Order(enum.Enum)
    Order(value, names=None, *, module=None, qualname=None, type=None, start=1)
 
An enumeration.
 
 
Method resolution order:
Order
enum.Enum
builtins.object

Data and other attributes defined here:
ASC = <Order.ASC: 'asc'>
DESC = <Order.DESC: 'desc'>

Data descriptors inherited from enum.Enum:
name
The name of the Enum member.
value
The value of the Enum member.

Readonly properties inherited from enum.EnumMeta:
__members__
Returns a mapping of member name->value.
 
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.

 
class QueryResponse(builtins.object)
    QueryResponse(resources: list, count: int, **kwargs)
 
The QueryResponse object defines the response from the server to a query request
 
:param resources: List of the resources returned from the server
:type resources: list
:param count: Total number of the queried resources
:type count: int
:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
  Methods defined here:
__init__(self, resources: list, count: int, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__str__(self)
Return str(self).

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        Dict = typing.Dict
Union = typing.Union