Class default

FacadeSidecar provides access to the CAASFirewaller API facade for sidecar applications.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

applicationCharmInfo applicationsConfig charmInfo getOpenedPorts isExposed life watch watchApplications watchOpenedPorts

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:259

Properties

NAME

NAME: string = "CAASFirewallerSidecar"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "CAASFirewallerSidecar"

`Static` VERSION

VERSION: number = 1

Methods

applicationCharmInfo

applicationCharmInfo(params: Entity): Promise<Charm>
ApplicationCharmInfo returns information about an application's charm.
Parameters
- params: Entity
Returns Promise<Charm>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:269

applicationsConfig

applicationsConfig(params: Entities): Promise<ApplicationGetConfigResults>
ApplicationsConfig returns the config for the specified applications.
Parameters
- params: Entities
Returns Promise<ApplicationGetConfigResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:285

charmInfo

charmInfo(params: CharmURL): Promise<Charm>
CharmInfo returns information about the requested charm.
Parameters
- params: CharmURL
Returns Promise<Charm>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:301

getOpenedPorts

getOpenedPorts(params: Entity): Promise<ApplicationOpenedPortsResults>
GetOpenedPorts returns all the opened ports for each given application tag.
Parameters
- params: Entity
Returns Promise<ApplicationOpenedPortsResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:317

isExposed

isExposed(params: Entities): Promise<BoolResults>
IsExposed returns whether the specified applications are exposed.
Parameters
- params: Entities
Returns Promise<BoolResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:333

life

life(params: Entities): Promise<LifeResults>
Life returns the life status of every supplied entity, where available.
Parameters
- params: Entities
Returns Promise<LifeResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:349

watch

watch(params: Entities): Promise<NotifyWatchResults>
Watch starts an NotifyWatcher for each given entity.
Parameters
- params: Entities
Returns Promise<NotifyWatchResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:365

watchApplications

watchApplications(params: any): Promise<StringsWatchResult>
WatchApplications starts a StringsWatcher to watch applications deployed to this model.
Parameters
- params: any
Returns Promise<StringsWatchResult>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:382

watchOpenedPorts

watchOpenedPorts(params: Entities): Promise<StringsWatchResults>
WatchOpenedPorts returns a new StringsWatcher for each given model tag.
Parameters
- params: Entities
Returns Promise<StringsWatchResults>
- Defined in api/facades/caasfirewaller-sidecar/CAASFirewallerSidecarV1.ts:399

Generated using TypeDoc