Class: PlatformAPI::Space

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Space

Returns a new instance of Space.



3002
3003
3004
# File 'lib/platform-api/client.rb', line 3002

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new space.

Parameters:

  • body:

    the object to pass as the request payload



3036
3037
3038
# File 'lib/platform-api/client.rb', line 3036

def create(body = {})
  @client.space.create(body)
end

#delete(space_id_or_space_name) ⇒ Object

Delete an existing space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space



3029
3030
3031
# File 'lib/platform-api/client.rb', line 3029

def delete(space_id_or_space_name)
  @client.space.delete(space_id_or_space_name)
end

#info(space_id_or_space_name) ⇒ Object

Info for existing space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space



3014
3015
3016
# File 'lib/platform-api/client.rb', line 3014

def info(space_id_or_space_name)
  @client.space.info(space_id_or_space_name)
end

#listObject

List existing spaces.



3007
3008
3009
# File 'lib/platform-api/client.rb', line 3007

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

#update(space_id_or_space_name, body = {}) ⇒ Object

Update an existing space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • body:

    the object to pass as the request payload



3022
3023
3024
# File 'lib/platform-api/client.rb', line 3022

def update(space_id_or_space_name, body = {})
  @client.space.update(space_id_or_space_name, body)
end