Module pyinventory.consts
Classes
class Customer (*args, **kwargs)
-
Customer(name, id, externalId)
Ancestors
- builtins.tuple
Instance variables
var externalId
-
Alias for field number 2
var id
-
Alias for field number 1
var name
-
Alias for field number 0
class DataTypeName (*args, **kwargs)
-
DataTypeName(data_type, graphql_field_name)
Ancestors
- builtins.tuple
Instance variables
var data_type
-
Alias for field number 0
var graphql_field_name
-
Alias for field number 1
class Document (*args, **kwargs)
-
Document(id, name, parentId, parentEntity, category)
Ancestors
- builtins.tuple
Instance variables
var category
-
Alias for field number 4
var id
-
Alias for field number 0
var name
-
Alias for field number 1
var parentEntity
-
Alias for field number 3
var parentId
-
Alias for field number 2
class Entity (*args, **kwargs)
-
An enumeration.
Ancestors
- enum.Enum
Class variables
var Customer
-
An enumeration.
var Document
-
An enumeration.
var Equipment
-
An enumeration.
var EquipmentPort
-
An enumeration.
var EquipmentPortType
-
An enumeration.
var EquipmentType
-
An enumeration.
var Link
-
An enumeration.
var Location
-
An enumeration.
var LocationType
-
An enumeration.
var Property
-
An enumeration.
var PropertyType
-
An enumeration.
var Service
-
An enumeration.
var ServiceEndpoint
-
An enumeration.
var ServiceType
-
An enumeration.
var SiteSurvey
-
An enumeration.
var User
-
An enumeration.
class Equipment (*args, **kwargs)
-
Attributes
id
:str
- equipment ID
external_id
:Optional
[str
]- equipment external ID
name
:str
- equipment name
equipment_type_name
:str
- equipment type name
Ancestors
- builtins.tuple
Instance variables
var equipment_type_name
-
Alias for field number 3
var external_id
-
Alias for field number 1
var id
-
Alias for field number 0
var name
-
Alias for field number 2
class EquipmentPort (*args, **kwargs)
-
Attributes
id
:str
- equipment port ID
properties
:List
[Dict
[str
,PropertyValue
]]- list of equipment port properties
definition
:EquipmentPortDefinition
- port definition
link
:Optional
[pyinventory.consts.Link
]- link
Ancestors
- builtins.tuple
Instance variables
var definition
-
Alias for field number 2
var id
-
Alias for field number 0
var link
-
Alias for field number 3
var properties
-
Alias for field number 1
class EquipmentPortDefinition (*args, **kwargs)
-
Attributes
id
:str
- equipment port definition ID
name
:str
- equipment port definition name
port_type_name
:Optional
[str
]- equipment port definition port type name
Ancestors
- builtins.tuple
Instance variables
var id
-
Alias for field number 0
var name
-
Alias for field number 1
var port_type_name
-
Alias for field number 2
class EquipmentPortType (*args, **kwargs)
-
Attributes
id
:str
- equipment port type ID
name
:str
- equipment port type name
property_types
:List
[Dict
[str
,PropertyValue
]]- list of equipment port type propertyTypes to their default values
link_property_types
:List
[Dict
[str
,PropertyValue
]]- list of equipment port type linkPropertyTypes to their default values
Ancestors
- builtins.tuple
Instance variables
var id
-
Alias for field number 0
var link_property_types
-
Alias for field number 3
var name
-
Alias for field number 1
var property_types
-
Alias for field number 2
class EquipmentType (*args, **kwargs)
-
EquipmentType(name, category, id, property_types, position_definitions, port_definitions)
Ancestors
- builtins.tuple
Instance variables
var category
-
Alias for field number 1
var id
-
Alias for field number 2
var name
-
Alias for field number 0
var port_definitions
-
Alias for field number 5
var position_definitions
-
Alias for field number 4
var property_types
-
Alias for field number 3
class Link (*args, **kwargs)
-
Attributes
id
:str
- link ID
service_ids
:List
[str
]- service IDs
Ancestors
- builtins.tuple
Instance variables
var id
-
Alias for field number 0
var properties
-
Alias for field number 1
var service_ids
-
Alias for field number 2
class Location (*args, **kwargs)
-
Location(name, id, latitude, longitude, externalId, locationTypeName)
Ancestors
- builtins.tuple
Instance variables
var externalId
-
Alias for field number 4
var id
-
Alias for field number 1
var latitude
-
Alias for field number 2
var locationTypeName
-
Alias for field number 5
var longitude
-
Alias for field number 3
var name
-
Alias for field number 0
class LocationType (*args, **kwargs)
-
LocationType(name, id, property_types)
Ancestors
- builtins.tuple
Instance variables
var id
-
Alias for field number 1
var name
-
Alias for field number 0
var property_types
-
Alias for field number 2
class PropertyDefinition (*args, **kwargs)
-
Attributes
property_name
:str
- type name
property_type
:str
- enum["string", "int", "bool", "float", "date", "enum", "range", "email", "gps_location", "equipment", "location", "service", "datetime_local"]
default_value
: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
-
Alias for field number 2
var external_id
-
Alias for field number 4
var is_fixed
-
Alias for field number 3
var is_mandatory
-
Alias for field number 5
var property_kind
-
Alias for field number 1
var property_name
-
Alias for field number 0
class Service (*args, **kwargs)
-
Service(name, id, externalId, customer, endpoints, links)
Ancestors
- builtins.tuple
Instance variables
var customer
-
Alias for field number 3
var endpoints
-
Alias for field number 4
var externalId
-
Alias for field number 2
var id
-
Alias for field number 1
var links
-
Alias for field number 5
var name
-
Alias for field number 0
class ServiceEndpoint (*args, **kwargs)
-
ServiceEndpoint(id, port, type)
Ancestors
- builtins.tuple
Instance variables
var id
-
Alias for field number 0
var port
-
Alias for field number 1
var type
-
Alias for field number 2
class ServiceType (*args, **kwargs)
-
ServiceType(name, id, hasCustomer, property_types)
Ancestors
- builtins.tuple
Instance variables
var hasCustomer
-
Alias for field number 2
var id
-
Alias for field number 1
var name
-
Alias for field number 0
var property_types
-
Alias for field number 3
class SiteSurvey (*args, **kwargs)
-
SiteSurvey(name, id, completionTime, sourceFileId, sourceFileName, sourceFileKey, forms)
Ancestors
- builtins.tuple
Instance variables
var completionTime
-
Alias for field number 2
var forms
-
Alias for field number 6
var id
-
Alias for field number 1
var name
-
Alias for field number 0
var sourceFileId
-
Alias for field number 3
var sourceFileKey
-
Alias for field number 5
var sourceFileName
-
Alias for field number 4
class User (*args, **kwargs)
-
User(id, auth_id, email, status, role)
Ancestors
- builtins.tuple
Instance variables
var auth_id
-
Alias for field number 1
var email
-
Alias for field number 2
var id
-
Alias for field number 0
var role
-
Alias for field number 4
var status
-
Alias for field number 3