Regions

class cherryservers_sdk_python.regions.Region(client: C, model: T)[source]

Cherry Servers region resource.

This class represents an existing Cherry Servers resource and should only be initialized by RegionClient.

get_id() → int[source]: Get resource ID.

Cherry Servers region model.

This model is frozen by default, since it represents an actual Cherry Servers region resource state.

id

ID of the region.

Type:: int

name

Name of the region.

Type:: str | None

slug

Slug of the regions name.

Type:: str | None

region_iso_2

Region ISO 2 country code.

Type:: str | None

bgp

Region BGP.

Type:: cherryservers_sdk_python.regions.RegionBGPModel | None

location

Region server location.

Type:: str | None

href

Region href.

Type:: str | None

class cherryservers_sdk_python.regions.RegionBGPModel(*, hosts: list[str] | None = None, asn: int | None = None)[source]

Cherry Servers region BPG model.

This model is frozen by default, since it represents an actual Cherry Servers region BGP resource state.

hosts

Host IP addresses.

Type:: list[str] | None

asn

Region ASN.

Type:: int | None

class cherryservers_sdk_python.regions.RegionClient(api_client: _client.CherryApiClient, request_timeout: int = 120)[source]

Cherry Servers region client.

Manage Cherry Servers region resources. This class should typically be initialized by cherryservers_sdk_python.facade.CherryApiFacade.

Example

facade = cherryservers_sdk_python.facade.CherryApiFacade(token="my-token")

# Retrieve by ID.
region = facade.regions.get_by_id(1)

# Retrieve all regions.
regions = facade.regions.get_all()

get_all() → list[Region][source]: Retrieve all regions.

get_by_id(region_id: int) → Region[source]: Retrieve a region by ID.