resource

Documentation

Overview

Package resource implements API functions residing under /core/resource. This path contains methods for querying resources and attaching tags to them.

Index

• type API
  • func NewAPI(c client.Client) API
• type Info
• type Summary
• type Type

Types

type API

type API interface {
	List(ctx context.Context, page, limit int) ([]Summary, error)
	Get(ctx context.Context, id string) (Info, error)
	AttachTag(ctx context.Context, resourceID, tagName string) ([]Summary, error)
	DetachTag(ctx context.Context, resourceID, tagName string) error
}

API contains methods for tag control.

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new tags API instance with the given client.

type Info

type Info struct {
	Identifier string   `json:"identifier"`
	Name       string   `json:"name"`
	Type       Type     `json:"resource_type"`
	Tags       []string `json:"tags"`
}

Info contains all information about a resource.

type Summary

type Summary struct {
	Identifier string `json:"identifier"`
	Name       string `json:"name"`
}

Summary describes a resource in short.

type Type

type Type struct {
	Identifier string `json:"identifier"`
	Name       string `json:"name"`
}

Type is part of info.