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 environment.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Space

Returns a new instance of Space.



3004
3005
3006
 
# File 'lib/platform-api/client.rb', line 3004

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



3038
3039
3040
 
# File 'lib/platform-api/client.rb', line 3038

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



3031
3032
3033
 
# File 'lib/platform-api/client.rb', line 3031

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



3016
3017
3018
 
# File 'lib/platform-api/client.rb', line 3016

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

#list ⇒ Object

List existing spaces.



3009
3010
3011
 
# File 'lib/platform-api/client.rb', line 3009

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



3024
3025
3026
 
# File 'lib/platform-api/client.rb', line 3024

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