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.


2429
2430
2431
# File 'lib/platform-api/client.rb', line 2429

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


2463
2464
2465
# File 'lib/platform-api/client.rb', line 2463

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


2456
2457
2458
# File 'lib/platform-api/client.rb', line 2456

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


2441
2442
2443
# File 'lib/platform-api/client.rb', line 2441

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

#listObject

List existing spaces.


2434
2435
2436
# File 'lib/platform-api/client.rb', line 2434

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


2449
2450
2451
# File 'lib/platform-api/client.rb', line 2449

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