Class: PlatformAPI::Region

Inherits:

Object

• Object
• PlatformAPI::Region

Defined in:

lib/platform-api/client.rb

Overview

A region represents a geographic location in which your application may run.

Instance Method Summary

• #info(region_id_or_region_name) ⇒ Object

  Info for existing region.

• #initialize(client) ⇒ Region constructor

  A new instance of Region.

• #list ⇒ Object

  List existing regions.

Constructor Details

#initialize(client) ⇒ Region

Returns a new instance of Region.

# File 'lib/platform-api/client.rb', line 2677

def initialize(client)
  @client = client
end

Instance Method Details

#info(region_id_or_region_name) ⇒ Object

Info for existing region.

Parameters:

• region_id_or_region_name: —

  unique identifier of region or unique name of region

# File 'lib/platform-api/client.rb', line 2684

def info(region_id_or_region_name)
  @client.region.info(region_id_or_region_name)
end

#list ⇒ Object

List existing regions.

# File 'lib/platform-api/client.rb', line 2689

def list()
  @client.region.list()
end