Class default

APIv7 provides the Charms API facade for version 7. v7 guarantees SupportedBases will be provided in ResolveCharms

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

addCharm charmInfo checkCharmPlacement getDownloadInfos isMetered list listCharmResources resolveCharms

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/charms/CharmsV7.ts:319

Properties

NAME

NAME: string = "Charms"

VERSION

VERSION: number = 7

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Charms"

`Static` VERSION

VERSION: number = 7

Methods

addCharm

addCharm(params: AddCharmWithOrigin): Promise<CharmOriginResult>
AddCharm adds the given charm URL (which must include revision) to the environment, if it does not exist yet. Local charms are not supported, only charm store and charm hub URLs. See also AddLocalCharm().
Parameters
- params: AddCharmWithOrigin
Returns Promise<CharmOriginResult>
- Defined in api/facades/charms/CharmsV7.ts:331

charmInfo

charmInfo(params: CharmURL): Promise<Charm>
CharmInfo returns information about the requested charm.
Parameters
- params: CharmURL
Returns Promise<Charm>
- Defined in api/facades/charms/CharmsV7.ts:347

checkCharmPlacement

checkCharmPlacement(params: ApplicationCharmPlacements): Promise<ErrorResults>
CheckCharmPlacement checks if a charm is allowed to be placed with in a given application.
Parameters
- params: ApplicationCharmPlacements
Returns Promise<ErrorResults>
- Defined in api/facades/charms/CharmsV7.ts:364

getDownloadInfos

getDownloadInfos(params: CharmURLAndOrigins): Promise<DownloadInfoResults>
GetDownloadInfos attempts to get the bundle corresponding to the charm url and origin.
Parameters
- params: CharmURLAndOrigins
Returns Promise<DownloadInfoResults>
- Defined in api/facades/charms/CharmsV7.ts:383

isMetered

isMetered(params: CharmURL): Promise<IsMeteredResult>
IsMetered returns whether or not the charm is metered. TODO (cderici) only used for metered charms in cmd MeteredDeployAPI, kept for client compatibility, remove in juju 4.0
Parameters
- params: CharmURL
Returns Promise<IsMeteredResult>
- Defined in api/facades/charms/CharmsV7.ts:401

list

list(params: CharmsList): Promise<CharmsListResult>
List returns a list of charm URLs currently in the state. If supplied parameter contains any names, the result will be filtered to return only the charms with supplied names.
Parameters
- params: CharmsList
Returns Promise<CharmsListResult>
- Defined in api/facades/charms/CharmsV7.ts:419

listCharmResources

listCharmResources(params: CharmURLAndOrigins): Promise<CharmResourcesResults>
ListCharmResources returns a series of resources for a given charm.
Parameters
- params: CharmURLAndOrigins
Returns Promise<CharmResourcesResults>
- Defined in api/facades/charms/CharmsV7.ts:435

resolveCharms

resolveCharms(params: ResolveCharmsWithChannel): Promise<ResolveCharmWithChannelResults>
ResolveCharms resolves the given charm URLs with an optionally specified preferred channel. Channel provided via CharmOrigin.
Parameters
- params: ResolveCharmsWithChannel
Returns Promise<ResolveCharmWithChannelResults>
- Defined in api/facades/charms/CharmsV7.ts:454

Generated using TypeDoc