linode_api4-python/linode_api4/groups/region.py at bf632a6aace8d5986d9e318cb3bce7dde40632bc · mgwoj/linode_api4-python · GitHub

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
121
from linode_api4.groups import Group
from linode_api4.objects import Region
from linode_api4.objects.region import (
    RegionAvailabilityEntry,
    RegionVPCAvailability,
)


class RegionGroup(Group):
    def __call__(self, *filters):
        """
        Returns the available Regions for Linode products.

        This is intended to be called off of the :any:`LinodeClient`
        class, like this::

           region = client.regions()

        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-regions

        :param filters: Any number of filters to apply to this query.
                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                        for more details on filtering.

        :returns: A list of available Regions.
        :rtype: PaginatedList of Region
        """

        return self.client._get_and_filter(Region, *filters)

    def availability(self, *filters):
        """
        Returns the availability of Linode plans within a Region.


        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-regions-availability

        :param filters: Any number of filters to apply to this query.
                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                        for more details on filtering.

        :returns: A list of entries describing the availability of a plan in a region.
        :rtype: PaginatedList of RegionAvailabilityEntry
        """

        return self.client._get_and_filter(
            RegionAvailabilityEntry, *filters, endpoint="/regions/availability"
        )

    def availability_get(self, region_id):
        """
        Returns availability data for a specific region.

        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-region-availability

        :param region_id: The ID of the region to retrieve availability for.
        :type region_id: str

        :returns: A list of availability entries for the specified region.
        :rtype: list of RegionAvailabilityEntry
        """

        result = self.client.get(f"/regions/{region_id}/availability")

        if result is None:
            return []

        return [RegionAvailabilityEntry.from_json(v) for v in result]

    def vpc_availability(self, *filters):
        """
        Returns VPC availability data for all regions.

        NOTE: IPv6 VPCs may not currently be available to all users.

        This endpoint supports pagination with the following parameters:
        - page: Page number (>= 1)
        - page_size: Number of items per page (25-500)

        Pagination is handled automatically by PaginatedList. To configure page_size,
        set it when creating the LinodeClient:

            client = LinodeClient(token, page_size=100)

        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-regions-vpc-availability

        :param filters: Any number of filters to apply to this query.
                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
                        for more details on filtering.

        :returns: A list of VPC availability data for regions.
        :rtype: PaginatedList of RegionVPCAvailability
        """

        return self.client._get_and_filter(
            RegionVPCAvailability,
            *filters,
            endpoint="/regions/vpc-availability",
        )

    def vpc_availability_get(self, region_id):
        """
        Returns VPC availability data for a specific region.

        NOTE: IPv6 VPCs may not currently be available to all users.

        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-region-vpc-availability

        :param region_id: The ID of the region to retrieve VPC availability for.
        :type region_id: str

        :returns: VPC availability data for the specified region.
        :rtype: RegionVPCAvailability
        """

        result = self.client.get(f"/regions/{region_id}/vpc-availability")

        if result is None:
            return None

        return RegionVPCAvailability.from_json(result)