api

Documentation

Index

• func API2Payload(apiInfo Payload) (payload.FullPayloadInfo, error)
• type EnvListArgs
• type EnvListResults
• type Payload
  • func Payload2api(p payload.FullPayloadInfo) Payload

Functions

func API2Payload

func API2Payload(apiInfo Payload) (payload.FullPayloadInfo, error)

API2Payload converts an API Payload info struct into a payload.FullPayloadInfo struct.

Types

type EnvListArgs

type EnvListArgs struct {
	// Patterns is the list of patterns against which to filter.
	Patterns []string `json:"patterns"`
}

EnvListArgs are the arguments for the env-based List endpoint.

type EnvListResults

type EnvListResults struct {
	// Results is the list of payload results.
	Results []Payload `json:"results"`
}

type Payload

type Payload struct {
	// Class is the name of the payload class.
	Class string `json:"class"`
	// Type is the name of the payload type.
	Type string `json:"type"`

	// ID is a unique string identifying the payload to
	// the underlying technology.
	ID string `json:"id"`
	// Status is the Juju-level status for the payload.
	Status string `json:"status"`
	// Labels are labels associated with the payload.
	Labels []string `json:"labels"`

	// Unit identifies the unit tag associated with the payload.
	Unit string `json:"unit"`
	// Machine identifies the machine tag associated with the payload.
	Machine string `json:"machine"`
}

Payload contains full information about a payload.

func Payload2api

func Payload2api(p payload.FullPayloadInfo) Payload

Payload2api converts a payload.FullPayloadInfo struct into a Payload struct.