client

Documentation

Index

• type Client
  • func NewClient(platformOrigin string, apiToken string, kurlOrigin string) Client
  • func (c *Client) ArchiveChannel(appID string, appType string, channelID string) error
  • func (c *Client) ArchiveCustomer(customerID 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) (*types.CollectorSpec, error)
  • func (c *Client) CreateCustomer(appType string, opts kotsclient.CreateCustomerOpts) (*types.Customer, error)
  • func (c *Client) CreateInstaller(appId string, appType string, yaml string) (*types.InstallerSpec, 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) DownloadLicense(appType string, appID string, customerID string) ([]byte, error)
  • func (c *Client) GetApp(appID string) (interface{}, error)
  • func (c *Client) GetAppType(ctx context.Context, appID string, excludeChannels bool) (*types.App, string, error)
  • func (c *Client) GetChannel(appID string, appType string, channelID string) (*types.Channel, error)
  • func (c *Client) GetChannelByName(appID string, appType string, name string) (*types.Channel, error)
  • func (c *Client) GetCollector(appID string, specID string) (*types.CollectorSpec, error)
  • func (c *Client) GetCustomerByID(customerID string) (*types.Customer, error)
  • func (c *Client) GetCustomerByName(app string, name string) (*types.Customer, error)
  • func (c *Client) GetCustomerByNameOrId(appType string, appID, nameOrId string) (*types.Customer, error)
  • func (c *Client) GetOrCreateChannelByName(opts GetOrCreateChannelOptions) (*types.Channel, error)
  • func (c *Client) GetRelease(appID string, appType string, sequence int64) (*types.AppRelease, error)
  • func (c *Client) LintRelease(appType string, data []byte, isBuildersRelease bool, contentType string) ([]types.LintMessage, error)
  • func (c *Client) ListApps(excludeChannels bool) ([]types.AppAndChannels, error)
  • func (c *Client) ListChannels(appID string, appType string, channelName string) ([]*types.Channel, error)
  • func (c *Client) ListCollectors(appID string, appType string) ([]types.CollectorSpec, error)
  • func (c *Client) ListCustomers(appID string, appType string, includeTest bool) ([]types.Customer, error)
  • func (c *Client) ListCustomersByAppAndVersion(appID string, appVersion string, appType string) ([]types.Customer, error)
  • func (c *Client) ListInstallers(appId string, appType string) ([]types.InstallerSpec, 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) PromoteInstaller(appId string, appType string, sequence int64, channelID string, ...) error
  • func (c *Client) PromoteRelease(appID string, appType string, sequence int64, label string, notes string, ...) error
  • func (c *Client) SetInstanceTags(appID string, appType string, customerID string, instanceID string, ...) (*types.Instance, error)
  • func (c *Client) TestRelease(appID string, appType string, sequence int64) (string, error)
  • func (c *Client) UpdateCollector(appID string, specID string, yaml string, name string, isArchived bool) error
  • func (c *Client) UpdateCustomer(appType string, customerID string, opts kotsclient.UpdateCustomerOpts) (*types.Customer, error)
  • func (c *Client) UpdateRelease(appID string, appType string, sequence int64, yaml string) error
  • func (c *Client) UpdateSemanticVersioningForChannel(appType string, appID string, chanID string, enableSemver bool) error
• type GetOrCreateChannelOptions

Types

type Client

type Client struct {
	PlatformClient *platformclient.HTTPClient
	KotsClient     *kotsclient.VendorV3Client
}

func NewClient

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

func (*Client) ArchiveChannel

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

func (*Client) ArchiveCustomer

func (c *Client) ArchiveCustomer(customerID 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) (*types.CollectorSpec, error)

func (*Client) CreateCustomer

func (c *Client) CreateCustomer(appType string, opts kotsclient.CreateCustomerOpts) (*types.Customer, error)

func (*Client) CreateInstaller

func (c *Client) CreateInstaller(appId string, appType string, yaml string) (*types.InstallerSpec, 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) DownloadLicense

func (c *Client) DownloadLicense(appType string, appID string, customerID string) ([]byte, error)

func (*Client) GetApp

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

func (*Client) GetAppType

func (c *Client) GetAppType(ctx context.Context, appID string, excludeChannels bool) (*types.App, string, error)

func (*Client) GetChannel

func (c *Client) GetChannel(appID string, appType string, channelID string) (*types.Channel, error)

func (*Client) GetChannelByName

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

func (*Client) GetCollector

func (c *Client) GetCollector(appID string, specID string) (*types.CollectorSpec, error)

func (*Client) GetCustomerByID

func (c *Client) GetCustomerByID(customerID string) (*types.Customer, error)

func (*Client) GetCustomerByName

func (c *Client) GetCustomerByName(app string, name string) (*types.Customer, error)

func (*Client) GetCustomerByNameOrId

func (c *Client) GetCustomerByNameOrId(appType string, appID, nameOrId string) (*types.Customer, error)

func (*Client) GetOrCreateChannelByName

func (c *Client) GetOrCreateChannelByName(opts GetOrCreateChannelOptions) (*types.Channel, error)

func (*Client) GetRelease

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

func (*Client) LintRelease

func (c *Client) LintRelease(appType string, data []byte, isBuildersRelease bool, contentType string) ([]types.LintMessage, error)

data is a []byte describing a tarred yaml-dir, created by tarYAMLDir() this Client abstraction continue to spring more leaks :)

func (*Client) ListApps

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

func (*Client) ListChannels

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

func (*Client) ListCollectors

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

func (*Client) ListCustomers

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

func (*Client) ListCustomersByAppAndVersion

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

list customers by app and app version

func (*Client) ListInstallers

func (c *Client) ListInstallers(appId string, appType string) ([]types.InstallerSpec, 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) PromoteInstaller

func (c *Client) PromoteInstaller(appId string, appType string, sequence int64, channelID string, versionLabel 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) SetInstanceTags

func (c *Client) SetInstanceTags(appID string, appType string, customerID string, instanceID string, tags []types.Tag) (*types.Instance, error)

func (*Client) TestRelease

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

func (*Client) UpdateCollector

func (c *Client) UpdateCollector(appID string, specID string, yaml string, name string, isArchived bool) error

func (*Client) UpdateCustomer

func (c *Client) UpdateCustomer(appType string, customerID string, opts kotsclient.UpdateCustomerOpts) (*types.Customer, error)

func (*Client) UpdateRelease

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

func (*Client) UpdateSemanticVersioningForChannel

func (c *Client) UpdateSemanticVersioningForChannel(appType string, appID string, chanID string, enableSemver bool) error

type GetOrCreateChannelOptions

type GetOrCreateChannelOptions struct {
	AppID          string
	AppType        string
	NameOrID       string
	Description    string
	CreateIfAbsent bool
}