acme.etc.Types

module documentation

Various CSE and oneM2M types.

Class Announced Anouncement attribute enum values.
Class AnnounceSyncType Announce Sync Types
Class AttributePolicy Attribute policy for a single resource attribute.
Class AuthorizationResult Type of internal Authorization evaluation.
Class BasicType Basic resource types.
Class BatteryStatus Battery Status. This represents the "m2m:batteryStatus" data type.
Class BeaconCriteria TimeSyncBeacon criteria.
Class BindingType Type of Binding connection.
Class Cardinality Resource attribute cardinalities.
Class ConsistencyStrategy Consistency Strategy
Class ContentSerializationType Content Serialization Types
Class CSERegistrar Structure to hold the CSE registrar information.
Class CSERegistrarSecurity Structure to hold the security information for a CSE registrar.
Class CSERequest Structure that holds all the attributes for a Request (or a Response) to a CSE.
Class CSEStatus CSE Status
Class CSEType CSE Types
Class DesiredIdentifierResultType Desired Identifier Result Type
Class EvalCriteriaOperator Eval Criteria Operator enum values.
Class EvalMode Eval Mode enum values.
Class EventCategory Event Categories from m2m:stdEventCats
Class EventEvaluationMode Time Window Interpretation. This determines how events received in a time window are to be interpreted.
Class FilterCriteria Sub-structure for CSERequest.
Class FilterOperation Filter Operation
Class FilterUsage Filter Usage
Class GeofenceEventCriteria Geofence Event Criteria.
Class GeometryType Geometry Type.
Class GeoSpatialFunctionType Geo Spatial Function Type.
Class IdentifierScope Scope of an identifier.
Class LastTSInstance Data class for a single TS's latest and next expected TSI.dgt (data generation time) attribute, and other information
Class LocationInformationType Location Information Type.
Class LocationSource Location Source.
Class LocationUpdateEventCriteria Location Update Event Criteria.
Class LogicalOperator Logical Operator enum values for notification target policies.
Class LogLevel Log levels.
Class MissingData Data class for collecting the missing data states.
Class NotificationContentType Notification Content Types
Class NotificationEventType eventNotificationCriteria/NotificationEventTypes
Class NotificationTargetPolicyAction Notification Target Policy Action enum values.
Class Operation Request operations.
Class OriginatorType Originator Types.
Class Permission Permissions.
Class ProcessControl ProcessManager Process Control
Class ProcessState ProcessManager Process States.
Class RequestCallback Structure to hold the callback functions for handling outgoing requests.
Class RequestCredentials Structure that holds the credentials for a request.
Class RequestOptionality Request optionality enum values.
Class RequestStatus Reponse Types
Class RequestType Internal type to indicate the purpose of the the CSERequest struct.
Class ResourceDescription Describes a resource type.
Class ResourceTypes oneM2M Resource types.
Class ResponseType Reponse Types enum values.
Class Result This class represents the generic return state for many functions. It main contain the general result, a status code, values, resources etc.
Class ResultContentType Result Content Types
Class SemanticFormat Semantic Format.
Class Status Status of Firmware Update and Software Update. This represents the "m2m:status" data type.
Class TimeWindowType Time window type.
Class TreeMode Available modes do display the resource tree in the console.
Class TriggerStatus Trigger Status.
Class WifiConnectionStatus Wifi Connection Status.
Type Alias AttributePolicyDict Represent a dictionary of attribute policies used in validation.
Type Alias AttributePolicyDictList Represent a dictionary of attribute policies lists used in validation.
Type Alias Coordinate Coordinate type.
Type Alias FactoryCallableT Type definition for a factory callback to create and initializy a Resource instance.
Type Alias FlexContainerAttributes Type definition for a dictionary of attribute policies for a flexContainer.
Type Alias FlexContainerSpecializations Type definition for a dictionary of specializations for a flexContainer.
Type Alias JSON Type definition for a JSON type, which is just a dictionary.
Type Alias JSONLIST Type definition for a list of JSON types.
Type Alias ListOfCoordinates List of coordinates type.
Type Alias OperationMonitor Operation Monitor.
Type Alias Parameters Type definition for a dictionary of parameters.
Type Alias ReqResp Type definition for a dictionary of request/response parameters.
Type Alias RequestHandler Type definition for a map between operations and handler for outgoing request operations.
Type Alias RequestResponseList Type definition for a list of request/response pairs.
Type Alias ResourceAttributePolicyDict Represent a dictionary of attribute policies used in validation.
Variable RequestResponse Type definition for a request/response pair.
Variable resourceTypeDetails Mapping between resource types and their descriptions.
Variable _defaultNCT Mappings between NotificationEventType and default NotificationContentType
Variable _evalCriteriaComparisonEqualityOperators List of EvalCriteriaOperators that test for equality or inequality.
Variable _evalCriteriaOrderedTypes List of BasicTypes that are have an order.
Variable _OperationPermissionsMapping Mappings between request operations and permissions
Variable _resourceNamesTypes Mapping between oneM2M resource names to type names.
Variable _resourceTypesAnnouncedMappings Mapping between announceable and announced resources.
Variable _resourceTypesAnnouncedResourceTypes Sorted list of announced resources without MgmtObj specializations.
Variable _resourceTypesAnnouncedReverseMappings Mapping between announced and announceable resources.
Variable _resourceTypesAnnouncedSetFull Mapping of resources to their announced counterparts.
Variable _resourceTypesContainerResourcesSet List of container resources.
Variable _resourceTypesInstanceResourcesSet List of instance resources.
Variable _resourceTypesIsNotificationEntity List of resource types that represent an entity that can be a notification target.
Variable _resourceTypesIsRequestCreatable List of resource types that can be created by a request.
Variable _resourceTypesIsRequestDeletable List of resource types that can be deleted by a request.
Variable _resourceTypesIsRequestUpdatable List of resource types that can be updated by a request.
Variable _resourceTypesLatestOldest List of resource typs that represent latest or oldest virtual resources.
Variable _resourceTypesNames Mapping between oneM2M resource types to type names.
Variable _resourceTypesSpecializationBase List of resource types that are specialization base resources.
Variable _resourceTypesSupportedResourceTypes Sorted list of supported resource types (without MgmtObj spezializations and virtual resources).
Variable _resourceTypesVirtualResourcesNames List of unique virtual resource names.
Variable _resourceTypesVirtualResourcesSet List of virtual resources.
Variable _ResultContentTypeDefaults Mappings between request operations and default Result Content
Variable _ResultContentTypeForOperations Mappings between request operations and allowed Result Content
Variable _SemanticFormatAsString Mappings between semantic formats and strings representations.
AttributePolicyDict: TypeAlias =

Represent a dictionary of attribute policies used in validation.

Value
dict[str, AttributePolicy]
AttributePolicyDictList: TypeAlias =

Represent a dictionary of attribute policies lists used in validation.

Value
dict[str, list[AttributePolicy]]
Coordinate =

Coordinate type.

Value
tuple[float, float, float | None]
FactoryCallableT: TypeAlias =

Type definition for a factory callback to create and initializy a Resource instance.

Value
Callable[[dict[str, object], str, bool], object]
FlexContainerAttributes: TypeAlias =

Type definition for a dictionary of attribute policies for a flexContainer.

Value
dict[str, dict[str, AttributePolicy]]
FlexContainerSpecializations: TypeAlias =

Type definition for a dictionary of specializations for a flexContainer.

Value
dict[str, tuple[str, str]]
JSON: TypeAlias =

Type definition for a JSON type, which is just a dictionary.

Value
dict[str, Any]
JSONLIST: TypeAlias =

Type definition for a list of JSON types.

Value
list[JSON]
ListOfCoordinates =

List of coordinates type.

Value
list[Coordinate]
OperationMonitor: TypeAlias =

Operation Monitor.

Value
dict[str, tuple[AccessControlOperations, str]]
Parameters: TypeAlias =

Type definition for a dictionary of parameters.

Value
dict[str, str]
ReqResp: TypeAlias =

Type definition for a dictionary of request/response parameters.

Value
dict[str, int | str | list[str] | JSON]
RequestHandler: TypeAlias =

Type definition for a map between operations and handler for outgoing request operations.

Value
dict[Operation, RequestCallback]
RequestResponseList: TypeAlias =

Type definition for a list of request/response pairs.

Value
list[RequestResponse]
ResourceAttributePolicyDict: TypeAlias =

Represent a dictionary of attribute policies used in validation.

Value
dict[tuple[ResourceTypes | str, str], AttributePolicy]
RequestResponse =

Type definition for a request/response pair.

resourceTypeDetails: dict[ResourceTypes, ResourceDescription] =

Mapping between resource types and their descriptions.

_defaultNCT =

Mappings between NotificationEventType and default NotificationContentType

_evalCriteriaComparisonEqualityOperators =

List of EvalCriteriaOperators that test for equality or inequality.

_evalCriteriaOrderedTypes =

List of BasicTypes that are have an order.

_OperationPermissionsMapping =

Mappings between request operations and permissions

_resourceNamesTypes: dict[str, ResourceTypes] =

Mapping between oneM2M resource names to type names.

_resourceTypesAnnouncedMappings: dict[ResourceTypes, ResourceTypes] =

Mapping between announceable and announced resources.

_resourceTypesAnnouncedResourceTypes: list[ResourceTypes] =

Sorted list of announced resources without MgmtObj specializations.

_resourceTypesAnnouncedReverseMappings: dict[ResourceTypes, ResourceTypes] =

Mapping between announced and announceable resources.

_resourceTypesAnnouncedSetFull: list[ResourceTypes] =

Mapping of resources to their announced counterparts.

_resourceTypesContainerResourcesSet: list[ResourceTypes] =

List of container resources.

_resourceTypesInstanceResourcesSet: list[ResourceTypes] =

List of instance resources.

_resourceTypesIsNotificationEntity: list[ResourceTypes] =

List of resource types that represent an entity that can be a notification target.

_resourceTypesIsRequestCreatable: list[ResourceTypes] =

List of resource types that can be created by a request.

_resourceTypesIsRequestDeletable: list[ResourceTypes] =

List of resource types that can be deleted by a request.

_resourceTypesIsRequestUpdatable: list[ResourceTypes] =

List of resource types that can be updated by a request.

_resourceTypesLatestOldest: list[ResourceTypes] =

List of resource typs that represent latest or oldest virtual resources.

_resourceTypesNames: dict[ResourceTypes, str] =

Mapping between oneM2M resource types to type names.

_resourceTypesSpecializationBase: list[ResourceTypes] =

List of resource types that are specialization base resources.

_resourceTypesSupportedResourceTypes: list[ResourceTypes] =

Sorted list of supported resource types (without MgmtObj spezializations and virtual resources).

_resourceTypesVirtualResourcesNames: list[str] =

List of unique virtual resource names.

_resourceTypesVirtualResourcesSet: list[ResourceTypes] =

List of virtual resources.

_ResultContentTypeDefaults =

Mappings between request operations and default Result Content

_ResultContentTypeForOperations =

Mappings between request operations and allowed Result Content

_SemanticFormatAsString =

Mappings between semantic formats and strings representations.