root

package

v0.2.1 Latest Latest Go to latest Published: Apr 9, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/giantswarm/clusterclient

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func IsInvalidConfig(err error) bool
type Config
- func DefaultConfig() Config
type Request
- func DefaultRequest() Request
type Response
- func DefaultResponse() *Response
type Service
- func New(config Config) (*Service, error)
- func (s *Service) Get(ctx context.Context, request Request) (*Response, error)

Constants ¶

View Source

const (
	// Endpoint is the API endpoint of the service this client action interacts
	// with.
	Endpoint = "/"
)

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 Request ¶

type Request struct {
}

Request is the configuration for the service action.

func DefaultRequest ¶

func DefaultRequest() Request

DefaultRequest provides a default request object by best effort.

type Response ¶

type Response struct {
	Description    string `json:"description"`
	GitCommit      string `json:"git-commit"`
	GoVersion      string `json:"go-version"`
	Name           string `json:"name"`
	OSArch         string `json:"os-arch"`
	ProjectVersion string `json:"project-version"`
	Source         string `json:"source"`
}

Response is the return value of the service action.

func DefaultResponse ¶

func DefaultResponse() *Response

DefaultResponse provides a default response object by best effort.

type Service ¶

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

Service implements the root service action.

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, request Request) (*Response, error)

Source Files ¶

View all Source files

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