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.



2905
2906
2907
# File 'lib/platform-api/client.rb', line 2905

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



2939
2940
2941
# File 'lib/platform-api/client.rb', line 2939

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



2932
2933
2934
# File 'lib/platform-api/client.rb', line 2932

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



2917
2918
2919
# File 'lib/platform-api/client.rb', line 2917

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

#listObject

List existing spaces.



2910
2911
2912
# File 'lib/platform-api/client.rb', line 2910

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



2925
2926
2927
# File 'lib/platform-api/client.rb', line 2925

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