client

Documentation

Index

• type Client
  • func NewClient(platformOrigin string, graphqlOrigin string, apiToken string) Client
  • func (c *Client) ArchiveChannel(appID string, appType string, channelID string) error
  • func (c *Client) CreateApp(appOptions interface{}) (interface{}, error)
  • func (c *Client) CreateChannel(appID string, appType string, name string, description string) ([]types.Channel, error)
  • func (c *Client) CreateCollector(appID string, appType string, name string, yaml string) (*collectors.AppCollectorInfo, error)
  • func (c *Client) CreateCustomer(appType string, name string, channelID string, expiresIn time.Duration) (*types.Customer, error)
  • func (c *Client) CreateEntitlementSpec(appID string, appType string, name string, spec string) (*types.EntitlementSpec, error)
  • func (c *Client) CreateLicense(license interface{}) (interface{}, error)
  • func (c *Client) CreateRelease(appID string, appType string, yaml string) (*types.ReleaseInfo, error)
  • func (c *Client) DeleteApp(appID string) error
  • func (c *Client) GetApp(appID string) (interface{}, error)
  • func (c *Client) GetAppType(appID string) (string, error)
  • func (c *Client) GetChannel(appID string, appType string, channelID string) (*channels.AppChannel, []channels.ChannelRelease, error)
  • func (c *Client) GetChannelByName(appID string, appType string, name string, description string, ...) (*types.Channel, error)
  • func (c *Client) GetCollector(appID string, specID string) (*collectors.AppCollectorInfo, error)
  • func (c *Client) GetRelease(appID string, appType string, sequence int64) (*releases.AppRelease, error)
  • func (c *Client) LintRelease(appID string, appType string, yamlOrJSON string) ([]types.LintMessage, error)
  • func (c *Client) ListApps() ([]types.AppAndChannels, error)
  • func (c *Client) ListChannels(appID string, appType string) ([]types.Channel, error)
  • func (c *Client) ListCollectors(appID string, appType string) ([]types.CollectorInfo, error)
  • func (c *Client) ListCustomers(appID string, appType string) ([]types.Customer, error)
  • func (c *Client) ListReleases(appID string, appType string) ([]types.ReleaseInfo, error)
  • func (c *Client) PromoteCollector(appID string, appType string, specID string, channelIDs ...string) error
  • func (c *Client) PromoteRelease(appID string, appType string, sequence int64, label string, notes string, ...) error
  • func (c *Client) SetDefaultEntitlementSpec(specID string) error
  • func (c *Client) SetEntitlementValue(customerID string, specID string, key string, value string, datatype string, ...) (*types.EntitlementValue, error)
  • func (c *Client) UpdateCollector(appID string, specID string, yaml string) (interface{}, error)
  • func (c *Client) UpdateCollectorName(appID string, specID string, name string) (interface{}, error)
  • func (c *Client) UpdateRelease(appID string, appType string, sequence int64, yaml string) error

Types

type Client

type Client struct {
	PlatformClient *platformclient.HTTPClient
	ShipClient     *shipclient.GraphQLClient
	KotsClient     *kotsclient.GraphQLClient
}

func NewClient

func NewClient(platformOrigin string, graphqlOrigin string, apiToken string) Client

func (*Client) ArchiveChannel

func (c *Client) ArchiveChannel(appID string, appType string, channelID string) error

func (*Client) CreateApp

func (c *Client) CreateApp(appOptions interface{}) (interface{}, error)

func (*Client) CreateChannel

func (c *Client) CreateChannel(appID string, appType string, name string, description string) ([]types.Channel, error)

func (*Client) CreateCollector

func (c *Client) CreateCollector(appID string, appType string, name string, yaml string) (*collectors.AppCollectorInfo, error)

func (c *Client) CreateCollector(appID string, name string, yaml string) (*collectors.AppCollectorInfo, error) {

func (*Client) CreateCustomer

func (c *Client) CreateCustomer(appType string, name string, channelID string, expiresIn time.Duration) (*types.Customer, error)

func (*Client) CreateEntitlementSpec

func (c *Client) CreateEntitlementSpec(appID string, appType string, name string, spec string) (*types.EntitlementSpec, error)

func (*Client) CreateLicense

func (c *Client) CreateLicense(license interface{}) (interface{}, error)

func (*Client) CreateRelease

func (c *Client) CreateRelease(appID string, appType string, yaml string) (*types.ReleaseInfo, error)

func (*Client) DeleteApp

func (c *Client) DeleteApp(appID string) error

func (*Client) GetApp

func (c *Client) GetApp(appID string) (interface{}, error)

func (*Client) GetAppType

func (c *Client) GetAppType(appID string) (string, error)

func (*Client) GetChannel

func (c *Client) GetChannel(appID string, appType string, channelID string) (*channels.AppChannel, []channels.ChannelRelease, error)

func (*Client) GetChannelByName

func (c *Client) GetChannelByName(appID string, appType string, name string, description string, createIfAbsent bool) (*types.Channel, error)

func (*Client) GetCollector

func (c *Client) GetCollector(appID string, specID string) (*collectors.AppCollectorInfo, error)

func (*Client) GetRelease

func (c *Client) GetRelease(appID string, appType string, sequence int64) (*releases.AppRelease, error)

func (*Client) LintRelease

func (c *Client) LintRelease(appID string, appType string, yamlOrJSON string) ([]types.LintMessage, error)

yamlOrJSON is either a single ship yaml file, or a serialized JSON object describing a yaml-dir, created by readYAMLDir() this Client abstraction continue to spring more leaks :)

func (*Client) ListApps

func (c *Client) ListApps() ([]types.AppAndChannels, error)

func (*Client) ListChannels

func (c *Client) ListChannels(appID string, appType string) ([]types.Channel, error)

func (*Client) ListCollectors

func (c *Client) ListCollectors(appID string, appType string) ([]types.CollectorInfo, error)

func (*Client) ListCustomers

func (c *Client) ListCustomers(appID string, appType string) ([]types.Customer, error)

func (*Client) ListReleases

func (c *Client) ListReleases(appID string, appType string) ([]types.ReleaseInfo, error)

func (*Client) PromoteCollector

func (c *Client) PromoteCollector(appID string, appType string, specID string, channelIDs ...string) error

func (*Client) PromoteRelease

func (c *Client) PromoteRelease(appID string, appType string, sequence int64, label string, notes string, required bool, channelIDs ...string) error

func (*Client) SetDefaultEntitlementSpec

func (c *Client) SetDefaultEntitlementSpec(specID string) error

func (*Client) SetEntitlementValue

func (c *Client) SetEntitlementValue(customerID string, specID string, key string, value string, datatype string, appID string) (*types.EntitlementValue, error)

func (*Client) UpdateCollector

func (c *Client) UpdateCollector(appID string, specID string, yaml string) (interface{}, error)

func (*Client) UpdateCollectorName

func (c *Client) UpdateCollectorName(appID string, specID string, name string) (interface{}, error)

func (*Client) UpdateRelease

func (c *Client) UpdateRelease(appID string, appType string, sequence int64, yaml string) error