bundle

Documentation

Overview

Package bundle provides access to the bundle api facade. This facade contains api calls that are specific to bundles.

Index

• type Client
  • func NewClient(st base.APICallCloser) *Client
  • func (c *Client) ExportBundle(includeDefaults bool) (string, error)
  • func (c *Client) GetChanges(bundleURL, bundleDataYAML string) (params.BundleChangesResults, error)
  • func (c *Client) GetChangesMapArgs(bundleURL, bundleDataYAML string) (params.BundleChangesMapArgsResults, error)

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client allows access to the bundle API end point.

func NewClient

func NewClient(st base.APICallCloser) *Client

NewClient creates a new client for accessing the bundle api.

func (*Client) ExportBundle

func (c *Client) ExportBundle(includeDefaults bool) (string, error)

ExportBundle exports the current model configuration.

func (*Client) GetChanges

func (c *Client) GetChanges(bundleURL, bundleDataYAML string) (params.BundleChangesResults, error)

GetChanges returns back the changes for a given bundle that need to be applied. GetChanges is superseded by GetChangesMapArgs, use that where possible, by detecting the BestAPIVersion to use.

func (*Client) GetChangesMapArgs

func (c *Client) GetChangesMapArgs(bundleURL, bundleDataYAML string) (params.BundleChangesMapArgsResults, error)

GetChangesMapArgs returns back the changes for a given bundle that need to be applied, with the args of a method as a map.