shipclient

Documentation

Index

• type AppOptions
• type ChannelOptions
• type CreateSupportBundleSpec
• type GetSupportBundleSpec
• type GraphQLClient
  • func NewGraphQLClient(origin string, apiKey string) *GraphQLClient
  • func (c *GraphQLClient) CreateCollector(appID string, name string, yaml string) (*v1.AppCollectorInfo, error)
  • func (c *GraphQLClient) ExecuteRequest(requestObj graphql.Request, deserializeTarget interface{}) error
  • func (c *GraphQLClient) GetCollector(appID string, id string) (*v1.AppCollectorInfo, error)
  • func (c *GraphQLClient) ListCollectors(appID string, appType string) ([]types.CollectorInfo, error)
  • func (c *GraphQLClient) PromoteCollector(appID string, specID string, channelIDs ...string) error
  • func (c *GraphQLClient) UpdateCollector(appID string, specID, yaml string) (interface{}, error)
  • func (c *GraphQLClient) UpdateCollectorName(appID string, specID, name string) (interface{}, error)
• type GraphQLResponseCreateCollector
• type GraphQLResponseGetCollector
• type GraphQLResponseListCollectors
• type GraphQLResponseUpdateCollector
• type GraphQLResponseUpdateNameCollector
• type PlatformChannel
• type PlatformGQLResponseListCollectors
• type PlatformSupportBundleSpec
• type PlatformSupportBundleSpecsData
• type SupportBundleCreateSpecData
• type SupportBundleGetSpecData
• type SupportBundleSpec
• type SupportBundleSpecsData
• type SupportBundleUpdateSpecData
• type SupportBundleUpdateSpecNameData
• type UpdateSupportBundleSpec
• type UpdateSupportBundleSpecName

Types

type AppOptions

type AppOptions struct {
	Name string
}

type ChannelOptions

type ChannelOptions struct {
	Name        string
	Description string
}

type CreateSupportBundleSpec

type CreateSupportBundleSpec struct {
	ID     string `json:"id"`
	Name   string `json:"name,omitempty"`
	Config string `json:"spec,omitempty"`
}

type GetSupportBundleSpec

type GetSupportBundleSpec struct {
	ID        string `json:"id"`
	Name      string `json:"name,omitempty"`
	Config    string `json:"spec,omitempty"`
	CreatedAt string `json:"createdAt"`
}

type GraphQLClient

type GraphQLClient struct {
	GraphQLClient *graphql.Client
}

Client communicates with the Replicated Vendor GraphQL API.

func NewGraphQLClient

func NewGraphQLClient(origin string, apiKey string) *GraphQLClient

func (*GraphQLClient) CreateCollector

func (c *GraphQLClient) CreateCollector(appID string, name string, yaml string) (*v1.AppCollectorInfo, error)

CreateCollector creates a new collector based on given yaml and name

func (*GraphQLClient) ExecuteRequest

func (c *GraphQLClient) ExecuteRequest(requestObj graphql.Request, deserializeTarget interface{}) error

func (*GraphQLClient) GetCollector

func (c *GraphQLClient) GetCollector(appID string, id string) (*v1.AppCollectorInfo, error)

GetCollector returns a collector's properties.

func (*GraphQLClient) ListCollectors

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

func (*GraphQLClient) PromoteCollector

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

PromoteCollector assigns collector to a specified channel.

func (*GraphQLClient) UpdateCollector

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

func (*GraphQLClient) UpdateCollectorName

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

type GraphQLResponseCreateCollector

type GraphQLResponseCreateCollector struct {
	Data *SupportBundleCreateSpecData `json:"data,omitempty"`
}

type GraphQLResponseGetCollector

type GraphQLResponseGetCollector struct {
	Data *SupportBundleGetSpecData `json:"data,omitempty"`
}

type GraphQLResponseListCollectors

type GraphQLResponseListCollectors struct {
	Data *SupportBundleSpecsData `json:"data,omitempty"`
}

type GraphQLResponseUpdateCollector

type GraphQLResponseUpdateCollector struct {
	Data *SupportBundleUpdateSpecData `json:"data,omitempty"`
}

type GraphQLResponseUpdateNameCollector

type GraphQLResponseUpdateNameCollector struct {
	Data *SupportBundleUpdateSpecNameData `json:"data,omitempty"`
}

type PlatformChannel

type PlatformChannel struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type PlatformGQLResponseListCollectors

type PlatformGQLResponseListCollectors struct {
	Data *PlatformSupportBundleSpecsData `json:"data,omitempty"`
}

PLATFORM

type PlatformSupportBundleSpec

type PlatformSupportBundleSpec struct {
	ID        string          `json:"id"`
	Name      string          `json:"name"`
	CreatedAt string          `json:"createdAt"`
	Channels  []types.Channel `json:"platformChannels"`
	Config    string          `json:"spec,omitempty"`
}

type PlatformSupportBundleSpecsData

type PlatformSupportBundleSpecsData struct {
	PlatformSupportBundleSpecs []*PlatformSupportBundleSpec `json:"supportBundleSpecs"`
}

type SupportBundleCreateSpecData

type SupportBundleCreateSpecData struct {
	CreateSupportBundleSpec *CreateSupportBundleSpec `json:"createSupportBundleSpec"`
}

type SupportBundleGetSpecData

type SupportBundleGetSpecData struct {
	GetSupportBundleSpec *GetSupportBundleSpec `json:"supportBundleSpec"`
}

type SupportBundleSpec

type SupportBundleSpec struct {
	ID        string          `json:"id"`
	Name      string          `json:"name"`
	CreatedAt string          `json:"createdAt"`
	Channels  []types.Channel `json:"channels"`
	Config    string          `json:"spec,omitempty"`
}

type SupportBundleSpecsData

type SupportBundleSpecsData struct {
	SupportBundleSpecs []*SupportBundleSpec `json:"supportBundleSpecs"`
}

type SupportBundleUpdateSpecData

type SupportBundleUpdateSpecData struct {
	UpdateSupportBundleSpec *UpdateSupportBundleSpec `json:"updateSupportBundleSpec"`
}

type SupportBundleUpdateSpecNameData

type SupportBundleUpdateSpecNameData struct {
	UpdateSupportBundleSpecName *UpdateSupportBundleSpecName `json:"updateSupportBundleSpecName"`
}

type UpdateSupportBundleSpec

type UpdateSupportBundleSpec struct {
	ID     string `json:"id"`
	Config string `json:"spec,omitempty"`
}

type UpdateSupportBundleSpecName

type UpdateSupportBundleSpecName struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}