acme.etc.Types.ResourceTypes

class documentation

class ResourceTypes(ACMEIntEnum):

Constructor: ResourceTypes.fromTypeShortname(typeShortname)

View In Hierarchy

oneM2M Resource types.

This includes Announced resouces, ManagementObject specifalizations, and CSE-internal resource types.

Class Method fromTypeShortname Get a resource type by its resource name.
Class Method fullname Get the full name of a resource type.
Class Method isContainerResource Test whether a resource type is a container resource type.
Class Method isInstanceResource Test whether a resource type is an instance data resource type.
Class Method isLatestOldestResource Test whether a resource type is a latest or oldest virtual resource type.
Class Method isNotificationEntity Test whether a resource type represents an entity that can be a notification target. This is different from any other resource type, that can be a notification target as well.
Class Method isRequestCreatable Test whether a resource type is creatable through a request.
Class Method isRequestDeletable Test whether a resource type is deletable through a request.
Class Method isRequestUpdatable Test whether a resource type is updatable through a request.
Class Method isVirtualResource Check whether ty is a virtual resource.
Class Method isVirtualResourceName Check whether name is the name of a virtual resource.
Class Method supportedResourceTypes Return the supported resource types, including the announced resource types.
Method __str__ Stringify an enum.
Method announced Get the announced resource type for a resource type.
Method fromAnnounced Get the orginal announceable resource type for an announced type.
Method isAnnounced Test whether this type is an announced resource type.
Method isVirtual Test whether this type is virtual resource type.
Method resourceClass Return a Resource class for this resource type.
Method resourceFactory Return a Resource factory for this resource type.
Method typeShortname Get the resource type name.
Constant ACP Access Control Policy resource type.
Constant ACTR Action resource type.
Constant AE Application Entity resource type.
Constant ALL Indicate all supported resource types (internal).
Constant ALPC AEContactListPerCSE resource type.
Constant ALST AEContactList resource type.
Constant ANDI AreaNwkDeviceInfo ManagementObject specialization.
Constant ANI AreaNetworkInfo ManagementObject specialization.
Constant BAT Battery ManagementObject specialization.
Constant CIN ContentInstance resource type.
Constant CNT Container resource type.
Constant CNT_LA Oldest virtual resource type for Container.
Constant CNT_OL Latest virtual resource type for Container.
Constant COMPLEX Indicate a comples data structure (internal).
Constant CRDS Credentials ManagementObject specialization.
Constant CRS CrossResourceSubscription resource type.
Constant CSR Remote CSE resource type.
Constant DAC DynamicAuthorizationConsultation resource type.
Constant DATC DataCollection ManagementObject specialization.
Constant DEPR Dependency resource type.
Constant DVC DeviceCapability ManagementObject specialization.
Constant DVI DeviceInfo ManagementObject specialization.
Constant EVL EventLog ManagementObject specialization.
Constant FCI FlexContainerInstance resource type.
Constant FCNT FlexContainer resource type.
Constant FCNT_LA Oldest virtual resource type for FlexContainer.
Constant FCNT_OL Latest virtual resource type for FlexContainer.
Constant FWR Firmware ManagementObject specialization.
Constant GRP Group resouce type.
Constant GRP_FOPT Group FanOutPoint virtual resource type.
Constant LCP LocationPolicy resource type.
Constant MEM Memory ManagementObject specialization.
Constant MGMTOBJ ManagementObject resource type.
Constant MIXED oneM2M mixed resource type (e.g. for groups).
Constant MNWK MobileNetwork ManagementObject specialization.
Constant NOD Node resource type.
Constant NOTIFICATION Notification primitive (internal).
Constant NTP NotificationTargetPolicy resource type.
Constant NTPR notificationTargetMgmtPolicyRef resource type.
Constant NTSR NotificationTargetSelfReference of a Subscription.
Constant NYCFC MyCertFileCred ManagementObject specialization.
Constant PCH PollingChannel resource type.
Constant PCH_PCU PollingChannelURI virtual resource type.
Constant PDR PolicyDeletionRules resource type.
Constant PRMR ProcessManagement resource type.
Constant PRP Primitive Profile type.
Constant RBO Reboot ManagementObject specialization.
Constant REQ Request resource type.
Constant REQRESP Type for request / response structures (internal).
Constant REQUEST Request primitive (internal).
Constant RESPONSE Response primitive (internal).
Constant SCH Schedule resource type.
Constant SIM SIM ManagementObject specialization.
Constant SMD SemanticDescriptor resouce type.
Constant STTE State resource type.
Constant SUB Subscription resource type.
Constant SWR Software ManagementObject specialization.
Constant TGR TriggerRequest resource type.
Constant TS TimeSeries resource type.
Constant TS_LA Oldest virtual resource type for TimeSeries.
Constant TS_OL Latest virtual resource type for TimeSeries.
Constant TSB TimeSyncBeacon resource type.
Constant TSI TimeSeriesInstance resource type.
Constant UNKNOWN Indicate an unknown type (internal).
Constant WIFIC WifiClient ManagementObject specialization.
Class Variable ACPAnnc Announced Access Control Policy resource type.
Class Variable ACTRAnnc Announced Action resource type.
Class Variable AEAnnc Announced Application Entity resource type.
Class Variable ANDIAnnc Announced AreaNwkDeviceInfo ManagementObject specialization.
Class Variable ANIAnnc Announced AreaNetworkInfo ManagementObject specialization.
Class Variable BATAnnc Announced Battery ManagementObject specialization.
Class Variable CINAnnc Announced ContentInstance resource type.
Class Variable CNTAnnc Announced Container resource type.
Class Variable CRDSAnnc Announced Credentials ManagementObject specialization.
Class Variable CSEBase CSEBase resource type.
Class Variable CSEBaseAnnc Announced CSEBase resource type.
Class Variable CSRAnnc Announced Remote CSE resource type.
Class Variable DATCAnnc Announced DataCollection ManagementObject specialization.
Class Variable DEPRAnnc Announced Dependency resource type.
Class Variable DVCAnnc Announced DeviceCapability ManagementObject specialization.
Class Variable DVIAnnc Announced DeviceInfo ManagementObject specialization.
Class Variable EVLAnnc Announced EventLog ManagementObject specialization.
Class Variable FCIAnnc Announced FlexContainerInstance resource type.
Class Variable FCNTAnnc Announced FlexContainer resource type.
Class Variable FWRAnnc Announced Firmware ManagementObject specialization.
Class Variable GRPAnnc Announced Group resouce type.
Class Variable LCPAnnc Announced LocationPolicy resource type.
Class Variable MEMAnnc Announced Memory ManagementObject specialization.
Class Variable MGMTOBJAnnc Announced ManagementObject resource type.
Class Variable MNWKAnnc Announced MobileNetwork ManagementObject specialization.
Class Variable NODAnnc Announced Node resource type.
Class Variable NYCFCAnnc Announced MyCertFileCred ManagementObject specialization.
Class Variable PRMRAnnc Announced ProcessManagement resource type.
Class Variable PRPAnnc Announced Primitive Profile type.
Class Variable RBOAnnc Announced Reboot ManagementObject specialization.
Class Variable SCHAnnc Announced Schedule resource type.
Class Variable SIMAnnc Announced SIM ManagementObject specialization.
Class Variable SMDAnnc Announced SemanticDescriptor resouce type.
Class Variable STTEAnnc Announced State resource type.
Class Variable SWRAnnc Announced Softwware ManagementObject specialization.
Class Variable TSAnnc Announced TimeSeries resource type.
Class Variable TSBAnnc Announced TimeSyncBeacon resource type.
Class Variable TSIAnnc Announced TimeSeriesInstance resource type.
Class Variable WIFICAnnc Announced WifiClient ManagementObject specialization.

Inherited from ACMEIntEnum:

Class Method has Check whether the enum type has an entry with either the given int value or string name.
Class Method to Return an enum value by its name.
Method __int__ Get the integer value of an enum.
Method __repr__ Stringify an enum.
@classmethod
def fromTypeShortname(cls, typeShortname: str) -> ResourceTypes:

Get a resource type by its resource name.

Parameters
typeShortname:strType name.
Returns
ResourceTypesThe resource type.
@classmethod
def fullname(cls, ty: int) -> str:

Get the full name of a resource type.

Parameters
ty:intType to get the full name for.
Returns
strThe full name of the resource type.
@classmethod
def isContainerResource(cls, ty: int) -> bool:

Test whether a resource type is a container resource type.

Parameters
ty:intType to test.
Returns
boolTrue if the resource type is a container resource.
@classmethod
def isInstanceResource(cls, ty: int) -> bool:

Test whether a resource type is an instance data resource type.

Parameters
ty:intType to test.
Returns
boolTrue if the resource type is an instance resource.
@classmethod
def isLatestOldestResource(cls, ty: int) -> bool:

Test whether a resource type is a latest or oldest virtual resource type.

Parameters
ty:intType to test.
Returns
boolTrue if the resource type is a latest or oldest virtual resource.
@classmethod
def isNotificationEntity(cls, ty: ResourceTypes) -> bool:

Test whether a resource type represents an entity that can be a notification target. This is different from any other resource type, that can be a notification target as well.

Parameters
ty:ResourceTypesResourceTypes value to test.
Returns
boolTrue if the resource type represents a notification target.
@classmethod
def isRequestCreatable(cls, ty: ResourceTypes) -> bool:

Test whether a resource type is creatable through a request.

Parameters
ty:ResourceTypesResourceTypes value to test.
Returns
boolTrue if the resource type can be created through a request.
@classmethod
def isRequestDeletable(cls, ty: ResourceTypes) -> bool:

Test whether a resource type is deletable through a request.

Parameters
ty:ResourceTypesResourceTypes value to test.
Returns
boolTrue if the resource type can be deleted through a request.
@classmethod
def isRequestUpdatable(cls, ty: ResourceTypes) -> bool:

Test whether a resource type is updatable through a request.

Parameters
ty:ResourceTypesResourceTypes value to test.
Returns
boolTrue if the resource type can be updated through a request.
@classmethod
def isVirtualResource(cls, ty: int) -> bool:

Check whether ty is a virtual resource.

Parameters
ty:intThe resource type to check.
Returns
boolTrue if the resource type is a virtual resource.
@classmethod
def isVirtualResourceName(cls, name: str) -> bool:

Check whether name is the name of a virtual resource.

Parameters
name:strThe resource name to check.
Returns
boolTrue if the resource type inidcated by the name is a virtual resource.
@classmethod
def supportedResourceTypes(self) -> list[ResourceTypes]:

Return the supported resource types, including the announced resource types.

Returns
list[ResourceTypes]List of supported ResourceTypes.
def __str__(self) -> str:
overrides acme.helpers.ACMEIntEnum.ACMEIntEnum.__str__

Stringify an enum.

Returns
strThe name of an enum value.
def announced(self, mgd: ResourceTypes | None = None) -> ResourceTypes:

Get the announced resource type for a resource type.

Parameters
mgd:ResourceTypes | NoneThe mgmtObj specialization type. Only used for mgmtObjs.
Returns
ResourceTypesThe announced resource type, or UNKNOWN.
def fromAnnounced(self) -> ResourceTypes:

Get the orginal announceable resource type for an announced type.

Returns
ResourceTypesAnnounceable resource type, or UNKNOWN
def isAnnounced(self) -> bool:

Test whether this type is an announced resource type.

Returns
boolTrue if the type is an announced resource type.
def isVirtual(self) -> bool:

Test whether this type is virtual resource type.

Returns
boolTrue if the type is a virtual resource type.
def resourceClass(self) -> type[Resource]:

Return a Resource class for this resource type.

Returns
type[Resource]The Resource class for the ResourceType.
def resourceFactory(self) -> FactoryCallableT:

Return a Resource factory for this resource type.

Returns
FactoryCallableTThe FactoryCallableT for the ResourceType.
def typeShortname(self) -> str:

Get the resource type name.

Returns
strThe resource type name.
ACP: int =

Access Control Policy resource type.

Value
1
ACTR: int =

Action resource type.

Value
65
AE: int =

Application Entity resource type.

Value
2
ALL: int =

Indicate all supported resource types (internal).

Value
-2
ALPC: int =

AEContactListPerCSE resource type.

Value
44
ALST: int =

AEContactList resource type.

Value
43
ANDI: int =

AreaNwkDeviceInfo ManagementObject specialization.

Value
1005
ANI: int =

AreaNetworkInfo ManagementObject specialization.

Value
1004
BAT: int =

Battery ManagementObject specialization.

Value
1006
CIN: int =

ContentInstance resource type.

Value
4
CNT: int =

Container resource type.

Value
3
CNT_LA: int =

Oldest virtual resource type for Container.

Value
20002
CNT_OL: int =

Latest virtual resource type for Container.

Value
20001
COMPLEX: int =

Indicate a comples data structure (internal).

Value
-4
CRDS: int =

Credentials ManagementObject specialization.

Value
1029
CRS: int =

CrossResourceSubscription resource type.

Value
48
CSR: int =

Remote CSE resource type.

Value
16
DAC: int =

DynamicAuthorizationConsultation resource type.

Value
34
DATC: int =

DataCollection ManagementObject specialization.

Value
1021
DEPR: int =

Dependency resource type.

Value
66
DVC: int =

DeviceCapability ManagementObject specialization.

Value
1008
DVI: int =

DeviceInfo ManagementObject specialization.

Value
1007
EVL: int =

EventLog ManagementObject specialization.

Value
1010
FCI: int =

FlexContainerInstance resource type.

Value
58
FCNT: int =

FlexContainer resource type.

Value
28
FCNT_LA: int =

Oldest virtual resource type for FlexContainer.

Value
-20005
FCNT_OL: int =

Latest virtual resource type for FlexContainer.

Value
-20004
FWR: int =

Firmware ManagementObject specialization.

Value
1001
GRP: int =

Group resouce type.

Value
9
GRP_FOPT: int =

Group FanOutPoint virtual resource type.

Value
-20003
LCP: int =

LocationPolicy resource type.

Value
10
MEM: int =

Memory ManagementObject specialization.

Value
1003
MGMTOBJ: int =

ManagementObject resource type.

Value
13
MIXED: int =

oneM2M mixed resource type (e.g. for groups).

Value
0
MNWK: int =

MobileNetwork ManagementObject specialization.

Value
1031
NOD: int =

Node resource type.

Value
14
NOTIFICATION: int =

Notification primitive (internal).

Value
-7
NTP: int =

NotificationTargetPolicy resource type.

Value
26
NTPR: int =

notificationTargetMgmtPolicyRef resource type.

Value
25
NTSR: int =

NotificationTargetSelfReference of a Subscription.

Value
-20009
NYCFC: int =

MyCertFileCred ManagementObject specialization.

Value
1023
PCH: int =

PollingChannel resource type.

Value
15
PCH_PCU: int =

PollingChannelURI virtual resource type.

Value
-20006
PDR: int =

PolicyDeletionRules resource type.

Value
27
PRMR: int =

ProcessManagement resource type.

Value
63
PRP: int =

Primitive Profile type.

Value
62
RBO: int =

Reboot ManagementObject specialization.

Value
1009
REQ: int =

Request resource type.

Value
17
REQRESP: int =

Type for request / response structures (internal).

Value
-3
REQUEST: int =

Request primitive (internal).

Value
-5
RESPONSE: int =

Response primitive (internal).

Value
-6
SCH: int =

Schedule resource type.

Value
18
SIM: int =

SIM ManagementObject specialization.

Value
1030
SMD: int =

SemanticDescriptor resouce type.

Value
24
STTE: int =

State resource type.

Value
64
SUB: int =

Subscription resource type.

Value
23
SWR: int =

Software ManagementObject specialization.

Value
1002
TGR: int =

TriggerRequest resource type.

Value
47
TS: int =

TimeSeries resource type.

Value
29
TS_LA: int =

Oldest virtual resource type for TimeSeries.

Value
-20008
TS_OL: int =

Latest virtual resource type for TimeSeries.

Value
-20007
TSB: int =

TimeSyncBeacon resource type.

Value
60
TSI: int =

TimeSeriesInstance resource type.

Value
30
UNKNOWN: int =

Indicate an unknown type (internal).

Value
-1
WIFIC: int =

WifiClient ManagementObject specialization.

Value
1028
ACPAnnc: int =

Announced Access Control Policy resource type.

ACTRAnnc: int =

Announced Action resource type.

AEAnnc: int =

Announced Application Entity resource type.

ANDIAnnc: int =

Announced AreaNwkDeviceInfo ManagementObject specialization.

ANIAnnc: int =

Announced AreaNetworkInfo ManagementObject specialization.

BATAnnc: int =

Announced Battery ManagementObject specialization.

CINAnnc: int =

Announced ContentInstance resource type.

CNTAnnc: int =

Announced Container resource type.

CRDSAnnc: int =

Announced Credentials ManagementObject specialization.

CSEBase: int =

CSEBase resource type.

CSEBaseAnnc: int =

Announced CSEBase resource type.

CSRAnnc: int =

Announced Remote CSE resource type.

DATCAnnc: int =

Announced DataCollection ManagementObject specialization.

DEPRAnnc: int =

Announced Dependency resource type.

DVCAnnc: int =

Announced DeviceCapability ManagementObject specialization.

DVIAnnc: int =

Announced DeviceInfo ManagementObject specialization.

EVLAnnc: int =

Announced EventLog ManagementObject specialization.

FCIAnnc: int =

Announced FlexContainerInstance resource type.

FCNTAnnc: int =

Announced FlexContainer resource type.

FWRAnnc: int =

Announced Firmware ManagementObject specialization.

GRPAnnc: int =

Announced Group resouce type.

LCPAnnc: int =

Announced LocationPolicy resource type.

MEMAnnc: int =

Announced Memory ManagementObject specialization.

MGMTOBJAnnc: int =

Announced ManagementObject resource type.

MNWKAnnc: int =

Announced MobileNetwork ManagementObject specialization.

NODAnnc: int =

Announced Node resource type.

NYCFCAnnc: int =

Announced MyCertFileCred ManagementObject specialization.

PRMRAnnc: int =

Announced ProcessManagement resource type.

PRPAnnc: int =

Announced Primitive Profile type.

RBOAnnc: int =

Announced Reboot ManagementObject specialization.

SCHAnnc: int =

Announced Schedule resource type.

SIMAnnc: int =

Announced SIM ManagementObject specialization.

SMDAnnc: int =

Announced SemanticDescriptor resouce type.

STTEAnnc: int =

Announced State resource type.

SWRAnnc: int =

Announced Softwware ManagementObject specialization.

TSAnnc: int =

Announced TimeSeries resource type.

TSBAnnc: int =

Announced TimeSyncBeacon resource type.

TSIAnnc: int =

Announced TimeSeriesInstance resource type.

WIFICAnnc: int =

Announced WifiClient ManagementObject specialization.