DeployerAPI provides access to the Deployer API facade.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "Deployer"
VERSION: number = 1
_transport: Transport
NAME: string = "Deployer"
VERSION: number = 1

Methods

  • APIAddresses returns the list of addresses used to connect to the API.

    Parameters

    • params: any

    Returns Promise<StringsResult>

  • APIHostPorts returns the API server addresses.

    Parameters

    • params: any

    Returns Promise<APIHostPortsResult>

  • ConnectionInfo returns all the address information that the deployer task needs in one call.

    Parameters

    • params: any

    Returns Promise<DeployerConnectionValues>

  • Life returns the life status of every supplied entity, where available.

    Parameters

    Returns Promise<LifeResults>

  • ModelUUID returns the model UUID that this facade is deploying into. It is implemented here directly as a result of removing it from embedded APIAddresser without bumping the facade version. It should be blanked when this facade version is next incremented.

    Parameters

    • params: any

    Returns Promise<StringResult>

  • Remove removes every given entity from state, calling EnsureDead first, then Remove. It will fail if the entity is not present.

    Parameters

    Returns Promise<ErrorResults>

  • SetStatus sets the status of the specified entities.

    Parameters

    Returns Promise<ErrorResults>

  • WatchAPIHostPorts watches the API server addresses.

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

  • WatchUnits starts a StringsWatcher to watch all units belonging to to any entity (machine or service) passed in args.

    Parameters

    Returns Promise<StringsWatchResults>

Generated using TypeDoc