Class default

Facade is the CAAS operator API facade.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

aPIAddresses aPIHostPorts charm currentModel life modelUUID remove setPodSpec setStatus setTools watch watchAPIHostPorts watchContainerStart watchUnits

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:209

Properties

NAME

NAME: string = "CAASOperator"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "CAASOperator"

`Static` VERSION

VERSION: number = 1

Methods

aPIAddresses

aPIAddresses(params: any): Promise<StringsResult>
APIAddresses returns the list of addresses used to connect to the API.
Parameters
- params: any
Returns Promise<StringsResult>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:219

aPIHostPorts

aPIHostPorts(params: any): Promise<APIHostPortsResult>
APIHostPorts returns the API server addresses.
Parameters
- params: any
Returns Promise<APIHostPortsResult>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:235

charm

charm(params: Entities): Promise<ApplicationCharmResults>
Charm returns the charm info for all given applications.
Parameters
- params: Entities
Returns Promise<ApplicationCharmResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:251

currentModel

currentModel(params: any): Promise<ModelResult>
CurrentModel returns the name and UUID for the current juju model.
Parameters
- params: any
Returns Promise<ModelResult>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:267

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/caasoperator/CAASOperatorV1.ts:283

modelUUID

modelUUID(params: any): Promise<StringResult>
ModelUUID returns the model UUID that this facade is used to operate. 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>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:302

remove

remove(params: Entities): Promise<ErrorResults>
Remove removes every given entity from state, calling EnsureDead first, then Remove. It will fail if the entity is not present.
Parameters
- params: Entities
Returns Promise<ErrorResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:319

setPodSpec

setPodSpec(params: SetPodSpecParams): Promise<ErrorResults>
SetPodSpec sets the container specs for a set of applications. TODO(juju3) - remove
Parameters
- params: SetPodSpecParams
Returns Promise<ErrorResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:336

setStatus

setStatus(params: SetStatus): Promise<ErrorResults>
SetStatus sets the status of each given entity.
Parameters
- params: SetStatus
Returns Promise<ErrorResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:352

setTools

setTools(params: EntitiesVersion): Promise<ErrorResults>
SetTools updates the recorded tools version for the agents.
Parameters
- params: EntitiesVersion
Returns Promise<ErrorResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:368

watch

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

watchAPIHostPorts

watchAPIHostPorts(params: any): Promise<NotifyWatchResult>
WatchAPIHostPorts watches the API server addresses.
Parameters
- params: any
Returns Promise<NotifyWatchResult>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:400

watchContainerStart

watchContainerStart(params: WatchContainerStartArgs): Promise<StringsWatchResults>
WatchContainerStart starts a StringWatcher to watch for container start events on the CAAS api for a specific application and container.
Parameters
- params: WatchContainerStartArgs
Returns Promise<StringsWatchResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:417

watchUnits

watchUnits(params: Entities): Promise<StringsWatchResults>
WatchUnits starts a StringsWatcher to watch changes to the lifecycle states of units for the specified applications in this model.
Parameters
- params: Entities
Returns Promise<StringsWatchResults>
- Defined in api/facades/caasoperator/CAASOperatorV1.ts:437

Generated using TypeDoc