private

Documentation

Index

• Constants
• type ListResourcesArgs
• type ResourceResult
• type ResourcesResult

Constants

const (
	// HTTPEndpointPattern is the URL path pattern registered with
	// the API server. This includes wildcards (starting with ":") that
	// are converted into URL query values by the pattern mux. Also see
	// apiserver/apiserver.go.
	HTTPEndpointPattern = "/units/:unit/resources/:resource"
)

Types

type ListResourcesArgs

type ListResourcesArgs struct {
	// ResourceNames holds the names of the service's resources for
	// which information should be provided.
	ResourceNames []string
}

ListResourcesArgs holds the arguments for an API request to list resources for a service. The service is implicit to the uniter- specific HTTP connection.

type ResourceResult

type ResourceResult struct {
	params.ErrorResult

	// Resource is the info for the requested resource.
	Resource api.Resource
}

ResourceResult is the result for a single requested resource.

type ResourcesResult

type ResourcesResult struct {
	params.ErrorResult

	// Resources is the list of results for the requested resources,
	// in the same order as requested.
	Resources []ResourceResult
}

ResourcesResult holds the resource info for a list of requested resources.