bundle

Documentation

Overview

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

Index

• Variables
• type Client
  • func NewClient(st base.APICallCloser, options ...Option) *Client
  • func (c *Client) ExportBundle(ctx context.Context, includeDefaults bool) (string, error)
  • func (c *Client) GetChangesMapArgs(ctx context.Context, bundleURL, bundleDataYAML string) (params.BundleChangesMapArgsResults, error)
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

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, options ...Option) *Client

NewClient creates a new client for accessing the bundle api.

func (*Client) ExportBundle

func (c *Client) ExportBundle(ctx context.Context, includeDefaults bool) (string, error)

ExportBundle exports the current model configuration.

func (*Client) GetChangesMapArgs

func (c *Client) GetChangesMapArgs(ctx context.Context, 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. NOTE(jack-w-shaw) This client method is currently unused. It's being kept in incase it's used in the future. We may want to re-evaluate in future

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.