Module pyinventory.common.data_class
Classes
class Customer (name: str, id: str, externalId: Union[str, NoneType])
-
Attributes
name
:str
- name
id
:str
- ID
externalId
:Optional[str]
- external ID
Ancestors
- builtins.tuple
Instance variables
var externalId : Union[str, NoneType]
-
Alias for field number 2
var id : str
-
Alias for field number 1
var name : str
-
Alias for field number 0
class DataTypeName (data_type: Union[Type[datetime.date], Type[float], Type[int], Type[str], Type[bool], Type[Tuple[float, float]]], graphql_field_name: Tuple[str, ...])
-
Attributes
data_type
:PropertyValueType
- data type
graphql_field_name
:Tuple[str, …]
- graphql field name, in case of
gps_location
it is Tuple[latitudeValue
,longitudeValue
]
Ancestors
- builtins.tuple
Instance variables
var data_type : Union[Type[datetime.date], Type[float], Type[int], Type[str], Type[bool], Type[Tuple[float, float]]]
-
Alias for field number 0
var graphql_field_name : Tuple[str, ...]
-
Alias for field number 1
class Document (id: str, name: str, parentId: str, parentEntity: ImageEntity, category: Union[str, NoneType])
-
Attributes
id
:str
- ID
name
:str
- name
parentId
:str
- parent ID
parentEntity
:ImageEntity
- parent entity
category
:Optional[str]
- category
Ancestors
- builtins.tuple
Instance variables
var category : Union[str, NoneType]
-
Alias for field number 4
var id : str
-
Alias for field number 0
var name : str
-
Alias for field number 1
var parentEntity : ImageEntity
-
Alias for field number 3
var parentId : str
-
Alias for field number 2
class Equipment (id: str, external_id: Union[str, NoneType], name: str, equipment_type_name: str)
-
Attributes
id
:str
- ID
external_id
:Optional[str]
- external ID
name
:str
- name
equipment_type_name
:str
- equipment type name
Ancestors
- builtins.tuple
Instance variables
var equipment_type_name : str
-
Alias for field number 3
var external_id : Union[str, NoneType]
-
Alias for field number 1
var id : str
-
Alias for field number 0
var name : str
-
Alias for field number 2
class EquipmentPort (id: str, properties: Sequence[PropertyFragment], definition: EquipmentPortDefinition, link: Union[pyinventory.common.data_class.Link, NoneType])
-
Attributes
id
:str
- equipment port ID
properties
:Sequence[PropertyFragment]
- properties sequence
definition (
EquipmentPortDefinition
): port definition link (Optional[pyinventory.common.data_class.Link
]): linkAncestors
- builtins.tuple
Instance variables
var definition : EquipmentPortDefinition
-
Alias for field number 2
var id : str
-
Alias for field number 0
var link : Union[Link, NoneType]
-
Alias for field number 3
var properties : Sequence[PropertyFragment]
-
Alias for field number 1
class EquipmentPortDefinition (id: str, name: str, port_type_name: Union[str, NoneType] = None)
-
Attributes
id
:str
- ID
name
:str
- name
port_type_name
:Optional[str]
- port type name
Ancestors
- builtins.tuple
Instance variables
var id : str
-
Alias for field number 0
var name : str
-
Alias for field number 1
var port_type_name : Union[str, NoneType]
-
Alias for field number 2
class EquipmentPortType (id: str, name: str, property_types: Sequence[PropertyTypeFragment], link_property_types: Sequence[PropertyTypeFragment])
-
Attributes
id
:str
- ID
name
:str
- name
property_types
:Sequence[PropertyTypeFragment]
- property types sequence
link_property_types
:Sequence[PropertyTypeFragment]
- link property types sequence
Ancestors
- builtins.tuple
Instance variables
var id : str
-
Alias for field number 0
var link_property_types : Sequence[PropertyTypeFragment]
-
Alias for field number 3
var name : str
-
Alias for field number 1
var property_types : Sequence[PropertyTypeFragment]
-
Alias for field number 2
class EquipmentType (name: str, category: Union[str, NoneType], id: str, property_types: Sequence[PropertyTypeFragment], position_definitions: Sequence[EquipmentPositionDefinitionFragment], port_definitions: Sequence[EquipmentPortDefinitionFragment])
-
Attributes
name
:str
- name
category
:Optional[str]
- category
id
:str
- ID
property_types
:Sequence[PropertyTypeFragment]
- property types sequence
position_definitions
:Sequence[EquipmentPositionDefinitionFragment]
- position definitions sequence
port_definitions
:Sequence[EquipmentPortDefinitionFragment]
- port definition sequence
Ancestors
- builtins.tuple
Instance variables
var category : Union[str, NoneType]
-
Alias for field number 1
var id : str
-
Alias for field number 2
var name : str
-
Alias for field number 0
var port_definitions : Sequence[EquipmentPortDefinitionFragment]
-
Alias for field number 5
var position_definitions : Sequence[EquipmentPositionDefinitionFragment]
-
Alias for field number 4
var property_types : Sequence[PropertyTypeFragment]
-
Alias for field number 3
class Link (id: str, properties: Sequence[PropertyFragment], service_ids: List[str])
-
Attributes
id
:str
- link ID
properties
:Sequence[PropertyFragment]
- properties sequence
service_ids
:List[str]
- service IDs
Ancestors
- builtins.tuple
Instance variables
var id : str
-
Alias for field number 0
var properties : Sequence[PropertyFragment]
-
Alias for field number 1
var service_ids : List[str]
-
Alias for field number 2
class Location (name: str, id: str, latitude: numbers.Number, longitude: numbers.Number, externalId: Union[str, NoneType], locationTypeName: str)
-
Attributes
name
:str
- name
id
:str
- ID
latitude
:Number
- latitude
longitude
:Number
- longitude
externalId
:Optional[str]
- external ID
locationTypeName
:str
- location type name
Ancestors
- builtins.tuple
Instance variables
var externalId : Union[str, NoneType]
-
Alias for field number 4
var id : str
-
Alias for field number 1
var latitude : numbers.Number
-
Alias for field number 2
var locationTypeName : str
-
Alias for field number 5
var longitude : numbers.Number
-
Alias for field number 3
var name : str
-
Alias for field number 0
class LocationType (name: str, id: str, property_types: Sequence[PropertyTypeFragment])
-
Attributes
name
:str
- name
id
:str
- ID
property_types (Sequence[
pyinventory.graphql.property_type_fragment.PropertyTypeFragment
]): property types sequenceAncestors
- builtins.tuple
Instance variables
var id : str
-
Alias for field number 1
var name : str
-
Alias for field number 0
var property_types : Sequence[PropertyTypeFragment]
-
Alias for field number 2
class PropertyDefinition (property_name: str, property_kind: PropertyKind, default_value: Union[datetime.date, float, int, str, bool, Tuple[float, float], NoneType], is_fixed: Union[bool, NoneType] = False, external_id: Union[str, NoneType] = None, is_mandatory: Union[bool, NoneType] = False)
-
Attributes
property_name
:str
- type name
- property_kind (
PropertyKind
): property kind default_value
:Optional[PropertyValue]
- default property value
is_fixed
:bool
- fixed value flag
external_id
:str
- property type external ID
is_mandatory
:bool
- mandatory value flag
Ancestors
- builtins.tuple
Instance variables
var default_value : Union[datetime.date, float, int, str, bool, Tuple[float, float], NoneType]
-
Alias for field number 2
var external_id : Union[str, NoneType]
-
Alias for field number 4
var is_fixed : Union[bool, NoneType]
-
Alias for field number 3
var is_mandatory : Union[bool, NoneType]
-
Alias for field number 5
var property_kind : PropertyKind
-
Alias for field number 1
var property_name : str
-
Alias for field number 0
class Service (name: str, id: str, externalId: Union[str, NoneType], customer: Union[pyinventory.common.data_class.Customer, NoneType], endpoints: List[ServiceEndpoint], links: List[Link])
-
Attributes
name
:str
- name
id
:str
- ID
externalId
:Optional[str]
- external ID
customer
:Optional[Customer]
- customer
endpoints
:List[ServiceEndpoint]
- service endpoints list
links
:List[Link]
- links
Ancestors
- builtins.tuple
Instance variables
var customer : Union[Customer, NoneType]
-
Alias for field number 3
var endpoints : List[ServiceEndpoint]
-
Alias for field number 4
var externalId : Union[str, NoneType]
-
Alias for field number 2
var id : str
-
Alias for field number 1
var links : List[Link]
-
Alias for field number 5
var name : str
-
Alias for field number 0
class ServiceEndpoint (id: str, port: Union[pyinventory.common.data_class.EquipmentPort, NoneType], type: str)
-
Attributes
id
:str
- ID
port
:Optional[EquipmentPort]
- port
type
:str
- type
Ancestors
- builtins.tuple
Instance variables
var id : str
-
Alias for field number 0
var port : Union[EquipmentPort, NoneType]
-
Alias for field number 1
var type : str
-
Alias for field number 2
class ServiceType (name: str, id: str, hasCustomer: bool, property_types: Sequence[PropertyTypeFragment])
-
Attributes
name
:str
- name
id
:str
- ID
hasCustomer
:bool
- customer existence flag
property_types
:Sequence[PropertyTypeFragment]
- property types sequence
Ancestors
- builtins.tuple
Instance variables
var hasCustomer : bool
-
Alias for field number 2
var id : str
-
Alias for field number 1
var name : str
-
Alias for field number 0
var property_types : Sequence[PropertyTypeFragment]
-
Alias for field number 3
class SiteSurvey (name: str, id: str, completionTime: datetime.datetime, sourceFileId: Union[str, NoneType], sourceFileName: Union[str, NoneType], sourceFileKey: Union[str, NoneType], forms: Dict[str, Dict[str, Any]])
-
Attributes
name
:str
- name
id
:str
- ID
completionTime
:datetime
- complition time
sourceFileId
:Optional[str]
- source file ID
sourceFileName
:Optional[str]
- source file name
sourceFileKey
:Optional[str]
- source file key
forms
:Dict[str, Dict[str, Any]]
- forms
Ancestors
- builtins.tuple
Instance variables
var completionTime : datetime.datetime
-
Alias for field number 2
var forms : Dict[str, Dict[str, Any]]
-
Alias for field number 6
var id : str
-
Alias for field number 1
var name : str
-
Alias for field number 0
var sourceFileId : Union[str, NoneType]
-
Alias for field number 3
var sourceFileKey : Union[str, NoneType]
-
Alias for field number 5
var sourceFileName : Union[str, NoneType]
-
Alias for field number 4
class User (id: str, auth_id: str, email: str, status: UserStatus, role: UserRole)
-
Attributes
id
:str
- ID
auth_id
:str
- auth ID
email
:str
status
:UserStatus
- status
role
:UserRole
- role
Ancestors
- builtins.tuple
Instance variables
var auth_id : str
-
Alias for field number 1
var email : str
-
Alias for field number 2
var id : str
-
Alias for field number 0
var role : UserRole
-
Alias for field number 4
var status : UserStatus
-
Alias for field number 3