/
asset_tanks.py
120 lines (90 loc) · 6.7 KB
/
asset_tanks.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
"""
Try me out in your browser:
[](https://mybinder.org/v2/gh/VorTECHsa/python-sdk/master?filepath=docs%2Fexamples%2Ftry_me_out%2Fasset_tanks.ipynb)
"""
from typing import List, Union
from vortexasdk.endpoints.endpoints import ASSET_TANKS_REFERENCE
from vortexasdk.endpoints.asset_tanks_result import AssetTankResult
from vortexasdk.operations import Reference, Search
from vortexasdk.utils import convert_to_list
class AssetTanks(Reference, Search):
"""
Asset Tanks endpoint.
An Asset Tank is a reference value that corresponds to an ID associated with other entities.
For example, an Asset Tank object may have the following keys:
```json
{
"name": "AAM001",
"storage_type": "tdb"
"crude_confidence": "confirmed"
...
}
```
IDs represent asset tanks which can be found via the Asset Tank reference endpoint.
When the asset tanks endpoint is searched with those ids as parameters:
```python
>>> from vortexasdk import AssetTanks
>>> df = AssetTanks().search(ids=["6114b93026e61993797db33a46a5d2acbeacdbd63238a4271efaeafcee94b1d2"]).to_df()
```
Returns
| | id | capacity_bbl | crude_confidence | location_id | name | storage_type | lat | lon |
|---:|:------------------------|:-------------|:-----------------|:--------------------------------|:-------|:-------------|-----|-----|
| 0 | 6114b93026e61993797d... | 645201 | confirmed | b839dc5fee39ff7efd5e1cf2494... | AAM001 | tbd | 90 | 180 |
"""
def __init__(self):
Reference.__init__(self, ASSET_TANKS_REFERENCE)
Search.__init__(self, ASSET_TANKS_REFERENCE)
def load_all(self) -> AssetTankResult:
"""
Load all asset tanks.
"""
return self.search()
# noinspection PyShadowingBuiltins
def search(
self,
ids: Union[str, List[str]] = None,
corporate_entity_ids: Union[str, List[str]] = None,
crude_confidence: List[str] = None,
location_ids: Union[str, List[str]] = None,
storage_type: List[str] = None,
term: Union[str, List[str]] = None,
) -> AssetTankResult:
"""
Find all asset tanks matching given type.
# Arguments
ids: An array of unique Asset Tanks ID(s) to filter on.
corporate_entity_ids: An array of owner ID(s) to filter on.
crude_confidence: An array of confidence metrics to filter on. Possible values are: `'confirmed’`, `‘probable’`, `‘unlikely’`
location_ids: An array of geography ID(s) to filter on.
storage_types: An array of storage types to filter on. Possible values are: `'refinery'`, `'commercial'`, `'spr'`
# Returns
List of asset tanks matching `type`
# Examples
Find all asset tanks with a storage_type of `refinery`.
```python
>>> from vortexasdk import AssetTanks
>>> df = AssetTanks().search(storage_type=["refinery"]).to_df()
```
Returns
| | id | capacity_bbl | crude_confidence | location_id | name | storage_type | lat | lon |
|---:|:------------------------|:-------------|:-----------------|:--------------------------------|:-------|:-------------|-----|-----|
| 0 | 0a736a1816c0fea49a88... | 104815 | probable | f726416f49adcac6d5d296c49a00... | HOM009 | refinery | -60 | 24 |
| 1 | b96adfb025a719b66927... | 139279 | unlikely | f726416f49adcac6d5d296c49a00... | HOM022 | refinery | 100 | -90 |
"""
search_params = {
"ids": convert_to_list(ids),
"corporate_entity_ids": convert_to_list(corporate_entity_ids),
"crude_confidence": convert_to_list(crude_confidence),
"location_ids": convert_to_list(location_ids),
"storage_type": convert_to_list(storage_type),
"term": [str(e) for e in convert_to_list(term)],
}
response = super().search_with_client(
exact_term_match=False,
response_type=None,
headers=None,
**search_params
)
return AssetTankResult(
records=response["data"], reference=response["reference"]
)