cloudapi

Documentation

Index

• Variables
• type Client
  • func NewClient(config ClientConfig) (*Client, error)
  • func NewClientFromEnv() (*Client, error)
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) Resources(ctx context.Context, orgID string, params ResourcesParameters) (resources []ResourceObject, e error)
• type ClientConfig
• type CollectionDocumentRes
• type Links
• type ResourceAttributes
• type ResourceObject
• type ResourcesParameters

Variables

var ErrEncodingResourcesQuery = errors.New("failed to encode resources query")

var ErrFetchingResources = errors.New("failed to fetch resources")

var ErrInitializingResourcesRequest = errors.New("failed to initialize resources request")

var ErrInvalidURL = errors.New("invalid URL")

var ErrMissingToken = errors.New("no API token provided")

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config ClientConfig) (*Client, error)

func NewClientFromEnv

func NewClientFromEnv() (*Client, error)

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) Resources

func (c *Client) Resources(ctx context.Context, orgID string, params ResourcesParameters) (resources []ResourceObject, e error)

type ClientConfig

type ClientConfig struct {
	HTTPClient *http.Client
	URL        string
	Token      string
	Version    string
}

type CollectionDocumentRes

type CollectionDocumentRes struct {
	Data  []ResourceObject `json:"data"`
	Links Links
}

type Links

type Links struct {
	Next string `json:"next"`
}

type ResourceAttributes

type ResourceAttributes struct {
	Namespace    string                 `json:"namespace"`
	ResourceType string                 `json:"resource_type"`
	ResourceID   string                 `json:"resource_id"`
	State        map[string]interface{} `json:"state"`
	Tags         map[string]interface{} `json:"tags"`
}

type ResourceObject

type ResourceObject struct {
	ID         string             `json:"id,omitempty"`
	Type       string             `json:"type"`
	Attributes ResourceAttributes `json:"attributes,omitempty"`
}

type ResourcesParameters

type ResourcesParameters struct {
	EnvironmentID []string `url:"environment_id,omitempty"`
	ResourceType  []string `url:"resource_type,omitempty"`
	ResourceID    []string `url:"resource_id,omitempty"`
	NativeID      []string `url:"native_id,omitempty"`
	ID            []string `url:"id,omitempty"`
	Platform      []string `url:"platform,omitempty"`
	Name          []string `url:"name,omitempty"`
	Location      []string `url:"location,omitempty"`
}