root

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Endpoint is the API endpoint of the service this client action interacts
	// with.
	Endpoint = "/"
	// Name is the service name being implemented. This can be used for e.g.
	// logging.
	Name = "cluster/root"
)

Variables

This section is empty.

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	Logger     micrologger.Logger
	RestClient *resty.Client

	URL *url.URL
}

Config represents the configuration used to create a root service.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new root service by best effort.

type Response

type Response struct {
	Description string          `json:"description"`
	Name        string          `json:"name"`
	Source      string          `json:"source"`
	Version     VersionResponse `json:"version"`
}

type Service

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

func New

func New(config Config) (*Service, error)

New creates a new configured root service.

func (*Service) Get

func (s *Service) Get(ctx context.Context) (*Response, error)

type VersionResponse

type VersionResponse struct {
	GitCommit string `json:"git_commit"`
	GoVersion string `json:"go_version"`
	OsArch    string `json:"os_arch"`
	Version   string `json:"version"`
}

Jump to

Keyboard shortcuts

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