InstancePollerAPI provides access to the InstancePoller API facade.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "InstancePoller"
VERSION: number = 4
_transport: Transport
NAME: string = "InstancePoller"
VERSION: number = 4

Methods

  • AreManuallyProvisioned returns whether each given entity is manually provisioned or not. Only machine tags are accepted.

    Parameters

    Returns Promise<BoolResults>

  • InstanceId returns the provider specific instance id for each given machine or an CodeNotProvisioned error, if not set.

    Parameters

    Returns Promise<StringResults>

  • InstanceStatus returns the instance status for each given entity. Only machine tags are accepted.

    Parameters

    Returns Promise<StatusResults>

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

    Parameters

    Returns Promise<LifeResults>

  • ModelConfig returns the current model's configuration.

    Parameters

    • params: any

    Returns Promise<ModelConfigResult>

  • ProviderAddresses returns the list of all known provider addresses for each given entity. Only machine tags are accepted.

    Parameters

    Returns Promise<MachineAddressesResults>

  • SetInstanceStatus updates the instance status for each given entity. Only machine tags are accepted.

    Parameters

    Returns Promise<ErrorResults>

  • SetProviderAddresses updates the list of known provider addresses for each given entity. Only machine tags are accepted.

    Parameters

    Returns Promise<ErrorResults>

  • SetProviderNetworkConfig updates the provider addresses for one or more machines.

    What's more, if the client request includes provider-specific IDs (e.g. network, subnet or address IDs), this method will also iterate any present link layer devices (and their addresses) and merge in any missing provider-specific information.

    Parameters

    Returns Promise<SetProviderNetworkConfigResults>

  • Status returns the status of each given entity.

    Parameters

    Returns Promise<StatusResults>

  • WatchForModelConfigChanges returns a NotifyWatcher that observes changes to the model configuration. Note that although the NotifyWatchResult contains an Error field, it's not used because we are only returning a single watcher, so we use the regular error return.

    Parameters

    • params: any

    Returns Promise<NotifyWatchResult>

  • WatchModelMachineStartTimes watches the non-container machines in the model for changes to the Life or AgentStartTime fields and reports them as a batch.

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

  • WatchModelMachines returns a StringsWatcher that notifies of changes to the life cycles of the top level machines in the current model.

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

Generated using TypeDoc