Skip to content

Commit 6b9d55b

Browse files
Add LA notices
1 parent 3e1c325 commit 6b9d55b

File tree

3 files changed

+72
-2
lines changed

3 files changed

+72
-2
lines changed

linode_api4/objects/linode.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -1903,8 +1903,9 @@ def interface_create(
19031903
) -> LinodeInterface:
19041904
"""
19051905
Creates a new interface under this Linode.
1906+
Linode interfaces are not interchangeable with Config interfaces.
19061907
1907-
NOTE: Linode Interfaces are not interchangeable with Interfaces/Network Interfaces.
1908+
NOTE: Linode interfaces may not currently be available to all users.
19081909
19091910
API Documentation: https://techdocs.akamai.com/linode-api/reference/post-linode-interface
19101911
@@ -1980,6 +1981,8 @@ def interfaces_settings(self) -> LinodeInterfacesSettings:
19801981
"""
19811982
The settings for all interfaces under this Linode.
19821983
1984+
NOTE: Linode interfaces may not currently be available to all users.
1985+
19831986
:returns: The settings for instance-level interface settings for this Linode.
19841987
"""
19851988

@@ -2043,6 +2046,8 @@ def upgrade_interfaces(
20432046
NOTE: If dry_run is True, interfaces in the result will be
20442047
of type MappedObject rather than LinodeInterface.
20452048
2049+
NOTE: Linode interfaces may not currently be available to all users.
2050+
20462051
API Documentation: Not yet available.
20472052
20482053
:param config: The configuration profile the legacy interfaces to

linode_api4/objects/linode_interfaces.py

+63
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
class LinodeInterfacesSettingsDefaultRouteOptions(JSONObject):
1212
"""
1313
The options used to configure the default route settings for a Linode's network interfaces.
14+
15+
NOTE: Linode interfaces may not currently be available to all users.
1416
"""
1517

1618
ipv4_interface_id: Optional[int] = None
@@ -21,6 +23,8 @@ class LinodeInterfacesSettingsDefaultRouteOptions(JSONObject):
2123
class LinodeInterfacesSettingsDefaultRoute(JSONObject):
2224
"""
2325
The default route settings for a Linode's network interfaces.
26+
27+
NOTE: Linode interfaces may not currently be available to all users.
2428
"""
2529

2630
put_class = LinodeInterfacesSettingsDefaultRouteOptions
@@ -36,6 +40,8 @@ class LinodeInterfacesSettings(Base):
3640
The settings related to a Linode's network interfaces.
3741
3842
API Documentation: Not yet available.
43+
44+
NOTE: Linode interfaces may not currently be available to all users.
3945
"""
4046

4147
api_endpoint = "/linode/instances/{id}/interfaces/settings"
@@ -54,6 +60,8 @@ class LinodeInterfacesSettings(Base):
5460
class LinodeInterfaceDefaultRouteOptions(JSONObject):
5561
"""
5662
Options accepted when creating or updating a Linode Interface's default route settings.
63+
64+
NOTE: Linode interfaces may not currently be available to all users.
5765
"""
5866

5967
ipv4: Optional[bool] = None
@@ -64,6 +72,8 @@ class LinodeInterfaceDefaultRouteOptions(JSONObject):
6472
class LinodeInterfaceVPCIPv4AddressOptions(JSONObject):
6573
"""
6674
Options accepted for a single address when creating or updating the IPv4 configuration of a VPC Linode Interface.
75+
76+
NOTE: Linode interfaces may not currently be available to all users.
6777
"""
6878

6979
address: Optional[str] = None
@@ -75,6 +85,8 @@ class LinodeInterfaceVPCIPv4AddressOptions(JSONObject):
7585
class LinodeInterfaceVPCIPv4RangeOptions(JSONObject):
7686
"""
7787
Options accepted for a single range when creating or updating the IPv4 configuration of a VPC Linode Interface.
88+
89+
NOTE: Linode interfaces may not currently be available to all users.
7890
"""
7991

8092
range: str = ""
@@ -84,6 +96,8 @@ class LinodeInterfaceVPCIPv4RangeOptions(JSONObject):
8496
class LinodeInterfaceVPCIPv4Options(JSONObject):
8597
"""
8698
Options accepted when creating or updating the IPv4 configuration of a VPC Linode Interface.
99+
100+
NOTE: Linode interfaces may not currently be available to all users.
87101
"""
88102

89103
addresses: Optional[List[LinodeInterfaceVPCIPv4AddressOptions]] = None
@@ -94,6 +108,8 @@ class LinodeInterfaceVPCIPv4Options(JSONObject):
94108
class LinodeInterfaceVPCOptions(JSONObject):
95109
"""
96110
VPC-exclusive options accepted when creating or updating a Linode Interface.
111+
112+
NOTE: Linode interfaces may not currently be available to all users.
97113
"""
98114

99115
subnet_id: int = 0
@@ -104,6 +120,8 @@ class LinodeInterfaceVPCOptions(JSONObject):
104120
class LinodeInterfacePublicIPv4AddressOptions(JSONObject):
105121
"""
106122
Options accepted for a single address when creating or updating the IPv4 configuration of a public Linode Interface.
123+
124+
NOTE: Linode interfaces may not currently be available to all users.
107125
"""
108126

109127
address: str = ""
@@ -114,6 +132,8 @@ class LinodeInterfacePublicIPv4AddressOptions(JSONObject):
114132
class LinodeInterfacePublicIPv4Options(JSONObject):
115133
"""
116134
Options accepted when creating or updating the IPv4 configuration of a public Linode Interface.
135+
136+
NOTE: Linode interfaces may not currently be available to all users.
117137
"""
118138

119139
addresses: Optional[List[LinodeInterfacePublicIPv4AddressOptions]] = None
@@ -123,6 +143,8 @@ class LinodeInterfacePublicIPv4Options(JSONObject):
123143
class LinodeInterfacePublicIPv6RangeOptions(JSONObject):
124144
"""
125145
Options accepted for a single range when creating or updating the IPv6 configuration of a public Linode Interface.
146+
147+
NOTE: Linode interfaces may not currently be available to all users.
126148
"""
127149

128150
range: str = ""
@@ -132,6 +154,8 @@ class LinodeInterfacePublicIPv6RangeOptions(JSONObject):
132154
class LinodeInterfacePublicIPv6Options(JSONObject):
133155
"""
134156
Options accepted when creating or updating the IPv6 configuration of a public Linode Interface.
157+
158+
NOTE: Linode interfaces may not currently be available to all users.
135159
"""
136160

137161
ranges: Optional[List[LinodeInterfacePublicIPv6RangeOptions]] = None
@@ -141,6 +165,8 @@ class LinodeInterfacePublicIPv6Options(JSONObject):
141165
class LinodeInterfacePublicOptions(JSONObject):
142166
"""
143167
Public-exclusive options accepted when creating or updating a Linode Interface.
168+
169+
NOTE: Linode interfaces may not currently be available to all users.
144170
"""
145171

146172
ipv4: Optional[LinodeInterfacePublicIPv4Options] = None
@@ -151,6 +177,8 @@ class LinodeInterfacePublicOptions(JSONObject):
151177
class LinodeInterfaceVLANOptions(JSONObject):
152178
"""
153179
VLAN-exclusive options accepted when creating or updating a Linode Interface.
180+
181+
NOTE: Linode interfaces may not currently be available to all users.
154182
"""
155183

156184
vlan_label: str = ""
@@ -161,6 +189,8 @@ class LinodeInterfaceVLANOptions(JSONObject):
161189
class LinodeInterfaceOptions(JSONObject):
162190
"""
163191
Options accepted when creating or updating a Linode Interface.
192+
193+
NOTE: Linode interfaces may not currently be available to all users.
164194
"""
165195

166196
always_include = {
@@ -183,6 +213,8 @@ class LinodeInterfaceOptions(JSONObject):
183213
class LinodeInterfaceDefaultRoute(JSONObject):
184214
"""
185215
The default route configuration of a Linode Interface.
216+
217+
NOTE: Linode interfaces may not currently be available to all users.
186218
"""
187219

188220
put_class = LinodeInterfaceDefaultRouteOptions
@@ -195,6 +227,8 @@ class LinodeInterfaceDefaultRoute(JSONObject):
195227
class LinodeInterfaceVPCIPv4Address(JSONObject):
196228
"""
197229
A single address under the IPv4 configuration of a VPC Linode Interface.
230+
231+
NOTE: Linode interfaces may not currently be available to all users.
198232
"""
199233

200234
put_class = LinodeInterfaceVPCIPv4AddressOptions
@@ -208,6 +242,8 @@ class LinodeInterfaceVPCIPv4Address(JSONObject):
208242
class LinodeInterfaceVPCIPv4Range(JSONObject):
209243
"""
210244
A single range under the IPv4 configuration of a VPC Linode Interface.
245+
246+
NOTE: Linode interfaces may not currently be available to all users.
211247
"""
212248

213249
put_class = LinodeInterfaceVPCIPv4RangeOptions
@@ -219,6 +255,8 @@ class LinodeInterfaceVPCIPv4Range(JSONObject):
219255
class LinodeInterfaceVPCIPv4(JSONObject):
220256
"""
221257
A single address under the IPv4 configuration of a VPC Linode Interface.
258+
259+
NOTE: Linode interfaces may not currently be available to all users.
222260
"""
223261

224262
put_class = LinodeInterfaceVPCIPv4Options
@@ -231,6 +269,8 @@ class LinodeInterfaceVPCIPv4(JSONObject):
231269
class LinodeInterfaceVPC(JSONObject):
232270
"""
233271
VPC-specific configuration field for a Linode Interface.
272+
273+
NOTE: Linode interfaces may not currently be available to all users.
234274
"""
235275

236276
put_class = LinodeInterfaceVPCOptions
@@ -245,6 +285,8 @@ class LinodeInterfaceVPC(JSONObject):
245285
class LinodeInterfacePublicIPv4Address(JSONObject):
246286
"""
247287
A single address under the IPv4 configuration of a public Linode Interface.
288+
289+
NOTE: Linode interfaces may not currently be available to all users.
248290
"""
249291

250292
put_class = LinodeInterfacePublicIPv4AddressOptions
@@ -257,6 +299,8 @@ class LinodeInterfacePublicIPv4Address(JSONObject):
257299
class LinodeInterfacePublicIPv4Shared(JSONObject):
258300
"""
259301
A single shared address under the IPv4 configuration of a public Linode Interface.
302+
303+
NOTE: Linode interfaces may not currently be available to all users.
260304
"""
261305

262306
address: str = ""
@@ -267,6 +311,8 @@ class LinodeInterfacePublicIPv4Shared(JSONObject):
267311
class LinodeInterfacePublicIPv4(JSONObject):
268312
"""
269313
The IPv4 configuration of a public Linode Interface.
314+
315+
NOTE: Linode interfaces may not currently be available to all users.
270316
"""
271317

272318
put_class = LinodeInterfacePublicIPv4Options
@@ -281,6 +327,8 @@ class LinodeInterfacePublicIPv4(JSONObject):
281327
class LinodeInterfacePublicIPv6SLAAC(JSONObject):
282328
"""
283329
A single SLAAC entry under the IPv6 configuration of a public Linode Interface.
330+
331+
NOTE: Linode interfaces may not currently be available to all users.
284332
"""
285333

286334
address: str = ""
@@ -291,6 +339,8 @@ class LinodeInterfacePublicIPv6SLAAC(JSONObject):
291339
class LinodeInterfacePublicIPv6Shared(JSONObject):
292340
"""
293341
A single shared range under the IPv6 configuration of a public Linode Interface.
342+
343+
NOTE: Linode interfaces may not currently be available to all users.
294344
"""
295345

296346
range: str = ""
@@ -301,6 +351,8 @@ class LinodeInterfacePublicIPv6Shared(JSONObject):
301351
class LinodeInterfacePublicIPv6Range(JSONObject):
302352
"""
303353
A single range under the IPv6 configuration of a public Linode Interface.
354+
355+
NOTE: Linode interfaces may not currently be available to all users.
304356
"""
305357

306358
put_class = LinodeInterfacePublicIPv6RangeOptions
@@ -313,6 +365,8 @@ class LinodeInterfacePublicIPv6Range(JSONObject):
313365
class LinodeInterfacePublicIPv6(JSONObject):
314366
"""
315367
The IPv6 configuration of a Linode Interface.
368+
369+
NOTE: Linode interfaces may not currently be available to all users.
316370
"""
317371

318372
put_class = LinodeInterfacePublicIPv6Options
@@ -326,6 +380,8 @@ class LinodeInterfacePublicIPv6(JSONObject):
326380
class LinodeInterfacePublic(JSONObject):
327381
"""
328382
Public-specific configuration fields for a Linode Interface.
383+
384+
NOTE: Linode interfaces may not currently be available to all users.
329385
"""
330386

331387
put_class = LinodeInterfacePublicOptions
@@ -338,6 +394,8 @@ class LinodeInterfacePublic(JSONObject):
338394
class LinodeInterfaceVLAN(JSONObject):
339395
"""
340396
VLAN-specific configuration fields for a Linode Interface.
397+
398+
NOTE: Linode interfaces may not currently be available to all users.
341399
"""
342400

343401
put_class = LinodeInterfaceVLANOptions
@@ -350,6 +408,8 @@ class LinodeInterface(DerivedBase):
350408
"""
351409
A Linode's network interface.
352410
411+
NOTE: Linode interfaces may not currently be available to all users.
412+
353413
NOTE: When using the ``save()`` method, certain local fields with computed values will
354414
not be refreshed on the local object until after ``invalidate()`` has been called::
355415
@@ -391,6 +451,9 @@ class LinodeInterface(DerivedBase):
391451
def firewalls(self, *filters) -> List[Firewall]:
392452
"""
393453
Retrieves a list of Firewalls for this Linode Interface.
454+
Linode interfaces are not interchangeable with Config interfaces.
455+
456+
NOTE: Linode interfaces may not currently be available to all users.
394457
395458
:param filters: Any number of filters to apply to this query.
396459
See :doc:`Filtering Collections</linode_api4/objects/filtering>`

linode_api4/objects/networking.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,9 @@ def interface(self) -> Optional["LinodeInterface"]:
106106
"""
107107
Returns the Linode Interface associated with this IP address.
108108
109-
NOTE: This function will only work with Linode-level interfaces.
109+
NOTE: This function will only return Linode interfaces, not Config interfaces.
110+
111+
NOTE: Linode interfaces may not currently be available to all users.
110112
111113
:returns: The Linode Interface associated with this IP address.
112114
:rtype: LinodeInterface

0 commit comments

Comments
 (0)