cirro.sdk.reference_type

View Source

 1from cirro_api_client.v1.models import ReferenceType
 2
 3from cirro.sdk.asset import DataPortalAssets, DataPortalAsset
 4
 5
 6class DataPortalReferenceType(DataPortalAsset):
 7    """
 8    Reference data is organized by project, categorized by type.
 9    """
10
11    def __init__(self, ref_type: ReferenceType):
12        self._data = ref_type
13
14    @property
15    def name(self):
16        """Name of reference type"""
17        return self._data.name
18
19    @property
20    def description(self):
21        """Description of reference type"""
22        return self._data.description
23
24    @property
25    def directory(self):
26        return self._data.directory
27
28    @property
29    def validation(self):
30        return self._data.validation
31
32    def __str__(self):
33        return '\n'.join([
34            f"{i.title()}: {self.__getattribute__(i)}"
35            for i in ['name', 'description']
36        ])
37
38
39class DataPortalReferenceTypes(DataPortalAssets[DataPortalReferenceType]):
40    """Collection of DataPortalReferenceType objects."""
41    asset_name = "reference type"
42
43    def get_by_id(self, _id: str) -> DataPortalReferenceType:
44        raise NotImplementedError("Filtering by ID is not supported, use get_by_name")

class DataPortalReferenceType(cirro.sdk.asset.DataPortalAsset): View Source

 7class DataPortalReferenceType(DataPortalAsset):
 8    """
 9    Reference data is organized by project, categorized by type.
10    """
11
12    def __init__(self, ref_type: ReferenceType):
13        self._data = ref_type
14
15    @property
16    def name(self):
17        """Name of reference type"""
18        return self._data.name
19
20    @property
21    def description(self):
22        """Description of reference type"""
23        return self._data.description
24
25    @property
26    def directory(self):
27        return self._data.directory
28
29    @property
30    def validation(self):
31        return self._data.validation
32
33    def __str__(self):
34        return '\n'.join([
35            f"{i.title()}: {self.__getattribute__(i)}"
36            for i in ['name', 'description']
37        ])

Reference data is organized by project, categorized by type.

DataPortalReferenceType(ref_type: cirro_api_client.v1.models.ReferenceType) View Source

12    def __init__(self, ref_type: ReferenceType):
13        self._data = ref_type

name View Source

15    @property
16    def name(self):
17        """Name of reference type"""
18        return self._data.name

Name of reference type

description View Source

20    @property
21    def description(self):
22        """Description of reference type"""
23        return self._data.description

Description of reference type

directory View Source

25    @property
26    def directory(self):
27        return self._data.directory

validation View Source

29    @property
30    def validation(self):
31        return self._data.validation

class DataPortalReferenceTypes(cirro.sdk.asset.DataPortalAssets[cirro.sdk.reference_type.DataPortalReferenceType]): View Source

40class DataPortalReferenceTypes(DataPortalAssets[DataPortalReferenceType]):
41    """Collection of DataPortalReferenceType objects."""
42    asset_name = "reference type"
43
44    def get_by_id(self, _id: str) -> DataPortalReferenceType:
45        raise NotImplementedError("Filtering by ID is not supported, use get_by_name")

Collection of DataPortalReferenceType objects.

asset_name = 'reference type'

def get_by_id(self, _id: str) -> DataPortalReferenceType: View Source

44    def get_by_id(self, _id: str) -> DataPortalReferenceType:
45        raise NotImplementedError("Filtering by ID is not supported, use get_by_name")

Return the item which matches by id attribute.

Inherited Members

cirro.sdk.asset.DataPortalAssets: DataPortalAssets; description; get_by_name; filter_by_pattern
builtins.list: clear; copy; append; insert; extend; pop; remove; index; count; reverse; sort