Class: ApiService

ApiService()

new ApiService()

Represents a service running in an api under your space
Do not call constructor directly
Bluenimble container creates it internally and makes it available for your services to use
Source:

Members

custom :JsonObject

The custom block in the service json spec - if any -
Type:
  • JsonObject
Source:

(readonly) description :string

The description of this service
Type:
  • string
Source:

(readonly) endpoint :string

The endpoint of this service
Type:
  • string
Source:

(readonly) failure :string

The error message in case of a failure during deployment of this service
Type:
  • string
Source:

features :JsonObject

The features block in the service json spec - if any -
Type:
  • JsonObject
Source:

media :JsonObject

The media block in the service json spec - if any -
Type:
  • JsonObject
Source:

(readonly) name :string

The name of this service
Type:
  • string
Source:

runtime :JsonObject

The runtime block in the service json spec - if any -
Type:
  • JsonObject
Source:

security :JsonObject

The security block in the service json spec - if any -
Type:
  • JsonObject
Source:

Methods

pause()

Pause this service.
All upcoming requests for this service will be rejected if the service is paused
Source:

resume()

Resume this service
Source:

status()

The runtime status of this service. Running, Stopped, Paused or Failed
Source:

toJson() → {JsonObject}

Get a json representation of this service
Source:
Returns:
service as a json object
Type
JsonObject