subscriptions

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 7, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	QueryAddSubscription       = "addSubscription"
	AddSubscriptionVarTemplate = `` /* 219-byte string literal not displayed */
)
View Source
const (
	QueryRemoveSubscription       = "removeSubscription"
	RemoveSubscriptionVarTemplate = `{{define "vars"}}"orgId":{{json .OrgID}},"uuid":{{json .UUID}}{{end}}`
)
View Source
const (
	QuerySetSubscription       = "setSubscription"
	SetSubscriptionVarTemplate = `{{define "vars"}}"orgId":{{json .OrgID}},"uuid":{{json .UUID}},"versionUuid":{{json .VersionUUID}}{{end}}`
)
View Source
const (
	//QuerySubscriptionIdsForCluster specifies the query
	QuerySubscriptionIdsForCluster = "subscriptionsForCluster"
	//SubscriptionIdsForClusterVarTemplate is the template used to create the graphql query
	SubscriptionIdsForClusterVarTemplate = `{{define "vars"}}"orgId":{{json .OrgID}},"clusterId":{{json .ClusterID}}{{end}}`
)
View Source
const (
	//QuerySubscriptions specifies the query
	QuerySubscriptions = "subscriptions"
	//SubscriptionsVarTemplate is the template used to create the graphql query
	SubscriptionsVarTemplate = `{{define "vars"}}"orgId":{{json .OrgID}}{{end}}`
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddSubscriptionResponse

type AddSubscriptionResponse struct {
	Data *AddSubscriptionResponseData `json:"data,omitempty"`
}

AddSubscriptionResponse for unmarshalling the response data

type AddSubscriptionResponseData

type AddSubscriptionResponseData struct {
	Details *AddSubscriptionResponseDataDetails `json:"addSubscription,omitempty"`
}

AddSubscriptionResponseData for unmarshalling response details

type AddSubscriptionResponseDataDetails

type AddSubscriptionResponseDataDetails struct {
	UUID string `json:"uuid,omitempty"`
}

AddSubscriptionResponseDataDetails for unmarshalling response uuid

type AddSubscriptionVariables

type AddSubscriptionVariables struct {
	actions.GraphQLQuery
	OrgID       string
	Name        string
	Groups      []string
	ChannelUUID string
	VersionUUID string
}

func NewAddSubscriptionVariables

func NewAddSubscriptionVariables(orgID, name, channelUuid, versionUuid string, groups []string) AddSubscriptionVariables

type Client

type Client struct {
	web.SatConClient
}

Client is an implementation of a satcon client.

func (*Client) AddSubscription

func (c *Client) AddSubscription(orgID, name, channelUuid, versionUuid string, groups []string) (*AddSubscriptionResponseDataDetails, error)

AddSubscription creates a new subscription for valid channel, version, and group(s)

func (*Client) RemoveSubscription

func (c *Client) RemoveSubscription(orgID, uuid string) (*RemoveSubscriptionResponseDataDetails, error)

RemoveSubscription deletes specified subscription

func (*Client) SetSubscription

func (c *Client) SetSubscription(orgID string, subscriptionUUID string, versionUUID string) (*SetSubscriptionResponseDataDetails, error)

SetSubscription changes a subscription to a new version

func (*Client) SubscriptionIdsForCluster added in v0.3.0

func (c *Client) SubscriptionIdsForCluster(orgID string, clusterID string) ([]string, error)

func (*Client) Subscriptions

func (c *Client) Subscriptions(orgID string) (types.SubscriptionList, error)

type RemoveSubscriptionResponse

type RemoveSubscriptionResponse struct {
	Data *RemoveSubscriptionResponseData `json:"data,omitempty"`
}

RemoveSubscriptionResponse is the response body we get upon a successful cluster registration.

type RemoveSubscriptionResponseData

type RemoveSubscriptionResponseData struct {
	Details *RemoveSubscriptionResponseDataDetails `json:"removeSubscription,omitempty"`
}

type RemoveSubscriptionResponseDataDetails

type RemoveSubscriptionResponseDataDetails struct {
	UUID    string `json:"uuid,omitempty"`
	Success bool   `json:"success,omitempty"`
}

type RemoveSubscriptionVariables

type RemoveSubscriptionVariables struct {
	actions.GraphQLQuery
	OrgID string
	UUID  string
}

RemoveSubscriptionVariables are the variables specific to adding a group. These include the organization ID and the group name. Rather than instantiating this directly, use NewRemoveSubscriptionVariables().

func NewRemoveSubscriptionVariables

func NewRemoveSubscriptionVariables(orgID, uuid string) RemoveSubscriptionVariables

NewRemoveSubscriptionVariables creates a correctly formed instance of RemoveSubscriptionVariables.

type SetSubscriptionResponse

type SetSubscriptionResponse struct {
	Data *SetSubscriptionResponseData `json:"data,omitempty"`
}

SetSubscriptionResponse for unmarshalling the response data

type SetSubscriptionResponseData

type SetSubscriptionResponseData struct {
	Details *SetSubscriptionResponseDataDetails `json:"setSubscription,omitempty"`
}

SetSubscriptionResponseData for unmarshalling response details

type SetSubscriptionResponseDataDetails

type SetSubscriptionResponseDataDetails struct {
	UUID string `json:"uuid,omitempty"`
}

SetSubscriptionResponseDataDetails for unmarshalling response uuid

type SetSubscriptionVariables

type SetSubscriptionVariables struct {
	actions.GraphQLQuery
	OrgID       string
	UUID        string
	VersionUUID string
}

func NewSetSubscriptionVariables

func NewSetSubscriptionVariables(orgID string, subscriptionUuid string, versionUuid string) SetSubscriptionVariables

type SubscriptionIdsForClusterResponse added in v0.3.0

type SubscriptionIdsForClusterResponse struct {
	Data *SubscriptionIdsForClusterResponseData `json:"data,omitempty"`
}

SubscriptionIdsForClusterResponse response from query

type SubscriptionIdsForClusterResponseData added in v0.3.0

type SubscriptionIdsForClusterResponseData struct {
	SubscriptionIdsForCluster []types.UuidOnly `json:"subscriptionsForCluster,omitempty"`
}

SubscriptionIdsForClusterResponseData data response from query

type SubscriptionIdsForClusterVariables added in v0.3.0

type SubscriptionIdsForClusterVariables struct {
	actions.GraphQLQuery
	OrgID     string
	ClusterID string
}

SubscriptionIdsForClusterVariables are the variables used for the subscription query

func NewSubscriptionIdsForClusterVariables added in v0.3.0

func NewSubscriptionIdsForClusterVariables(orgID string, clusterID string) SubscriptionIdsForClusterVariables

NewSubscriptionIdsForClusterVariables generates variables used for query

type SubscriptionService

type SubscriptionService interface {
	AddSubscription(orgID, name, channelUuid, versionUuid string, groups []string) (*AddSubscriptionResponseDataDetails, error)
	SetSubscription(orgID string, subscriptionUuid string, versionUuid string) (*SetSubscriptionResponseDataDetails, error)
	RemoveSubscription(orgID, uuid string) (*RemoveSubscriptionResponseDataDetails, error)
	Subscriptions(orgID string) (types.SubscriptionList, error)
	SubscriptionIdsForCluster(orgID string, clusterID string) ([]string, error)
}

SubscriptionService is the interface used to perform all cluster-centric actions in Satellite Config.

func NewClient

func NewClient(endpointURL string, httpClient web.HTTPClient, authClient auth.AuthClient) (SubscriptionService, error)

NewClient returns a configured instance of ClusterService which can then be used to perform cluster queries against Satellite Config.

type SubscriptionsResponse

type SubscriptionsResponse struct {
	Data *SubscriptionsResponseData `json:"data,omitempty"`
}

SubscriptionsResponse response from query

type SubscriptionsResponseData

type SubscriptionsResponseData struct {
	Subscriptions types.SubscriptionList `json:"subscriptions,omitempty"`
}

SubscriptionsResponseData data response from query

type SubscriptionsVariables

type SubscriptionsVariables struct {
	actions.GraphQLQuery
	OrgID string
}

SubscriptionsVariables are the variables used for the subscription query

func NewSubscriptionsVariables

func NewSubscriptionsVariables(orgID string) SubscriptionsVariables

NewSubscriptionsVariables generates variables used for query

Directories

Path Synopsis
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL