bloombox / bloombox.client / Bloombox / APIRegion

APIRegion

enum class APIRegion (source)

Describes available API regions. In some cases, library users may want to force-direct (or at least prefer) a particular API hosting region. Available options are "USW1" (hosted in Oregon, USA) or "USC1" (hosted in South Carolina, USA).

Enum Values

USW1

'USW1' region code, which stands for "US West 1." Hosted from The Dalles, Oregon, on Google Cloud Platform. Use this for mostly west-coast-bound or originating traffic.

USC1

'USC1' region code, which stands for "US Central 1." Hosted from South Carolina on Google Cloud Platform. Use this for east-coast-bound or central-US originating traffic.

Properties

code

val code: String

Fetch the region code for a given region. This is basically the name of the region, i.e. 'USW1' or 'USC1', but in lowercase.