API provides access to the remote relations API facade.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "RemoteRelations"
VERSION: number = 2
_transport: Transport
NAME: string = "RemoteRelations"
VERSION: number = 2

Methods

  • ControllerConfig returns the controller's configuration.

    Parameters

    • params: any

    Returns Promise<ControllerConfigResult>

  • ExportEntities allocates unique, remote entity IDs for the given entities in the local model.

    Parameters

    Returns Promise<TokenResults>

  • GetTokens returns the token associated with the entities with the given tags for the given models.

    Parameters

    Returns Promise<StringResults>

  • Relations returns information about the cross-model relations with the specified keys in the local model.

    Parameters

    Returns Promise<RemoteRelationResults>

  • RemoteApplications returns the current state of the remote applications with the specified names in the local model.

    Parameters

    Returns Promise<RemoteApplicationResults>

  • SetRemoteApplicationsStatus sets the status for the specified remote applications.

    Parameters

    Returns Promise<ErrorResults>

  • UpdateControllersForModels changes the external controller records for the associated model entities. This is used when the remote relations worker gets redirected following migration of an offering model.

    Returns Promise<ErrorResults>

  • WatchLocalRelationChanges starts a RemoteRelationWatcher for each specified relation, returning the watcher IDs and initial values, or an error if the remote relations couldn't be watched.

    Parameters

    Returns Promise<RemoteRelationWatchResults>

  • WatchRemoteApplicationRelations starts a StringsWatcher for watching the relations of each specified application in the local model, and returns the watcher IDs and initial values, or an error if the services' relations could not be watched.

    Parameters

    Returns Promise<StringsWatchResults>

  • WatchRemoteApplications starts a strings watcher that notifies of the addition, removal, and lifecycle changes of remote applications in the model; and returns the watcher ID and initial IDs of remote applications, or an error if watching failed.

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

  • WatchRemoteRelations starts a strings watcher that notifies of the addition, removal, and lifecycle changes of remote relations in the model; and returns the watcher ID and initial IDs of remote relations, or an error if watching failed.

    Parameters

    • params: any

    Returns Promise<StringsWatchResult>

Generated using TypeDoc