charms

Documentation

Index

• type API
  • func NewAPI(st *state.State, resources *common.Resources, authorizer common.Authorizer) (*API, error)
  • func (a *API) CharmInfo(args params.CharmInfo) (api.CharmInfo, error)
  • func (a *API) IsMetered(args params.CharmInfo) (params.IsMeteredResult, error)
  • func (a *API) List(args params.CharmsList) (params.CharmsListResult, error)
• type Charms

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API implements the charms interface and is the concrete implementation of the api end point.

func NewAPI

func NewAPI(
	st *state.State,
	resources *common.Resources,
	authorizer common.Authorizer,
) (*API, error)

NewAPI returns a new charms API facade.

func (*API) CharmInfo

func (a *API) CharmInfo(args params.CharmInfo) (api.CharmInfo, error)

CharmInfo returns information about the requested charm.

func (*API) IsMetered

func (a *API) IsMetered(args params.CharmInfo) (params.IsMeteredResult, error)

IsMetered returns whether or not the charm is metered.

func (*API) List

func (a *API) List(args params.CharmsList) (params.CharmsListResult, error)

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.

type Charms

type Charms interface {
	List(args params.CharmsList) (params.CharmsListResult, error)
	CharmInfo(args params.CharmInfo) (api.CharmInfo, error)
	IsMetered(args params.CharmInfo) (bool, error)
}

Charms defines the methods on the charms API end point.