client

package module

v0.4.1 Latest Latest Go to latest Published: Apr 21, 2023 License: MIT Imports: 11 Imported by: 4

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/ONSdigital/dp-nomad

Links

Open Source Insights

README ¶

dp-nomad

Getting started

Dependencies

Configuration

Contributing

See CONTRIBUTING for details.

License

Released under MIT license, see LICENSE for details.

Documentation ¶

Index ¶

Constants
Variables
type Client
- func NewClient(nomadEndpoint, nomadCACert string, nomadTLSSkipVerify bool) (*Client, error)
- func (c *Client) Checker(ctx context.Context, state *health.CheckState) error
- func (c *Client) Get(ctx context.Context, path string) (int, error)
type ErrInvalidAppResponse
- func (e ErrInvalidAppResponse) Error() string

Constants ¶

View Source

const ServiceName = "Nomad"

ServiceName

Variables ¶

View Source

var (
	// StatusMessage contains a map of messages to service response statuses
	StatusMessage = map[string]string{
		health.StatusOK:       " is ok",
		health.StatusWarning:  " is degraded, but at least partially functioning",
		health.StatusCritical: " functionality is unavailable or non-functioning",
	}
)

Functions ¶

This section is empty.

Types ¶

type Client ¶ added in v0.2.0

type Client struct {
	Client dphttp.Clienter
	URL    string
}

Nomad represents the nomad client

func NewClient ¶

func NewClient(nomadEndpoint, nomadCACert string, nomadTLSSkipVerify bool) (*Client, error)

NewClient returns a Nomad HTTP client for this endpoint with optional TLS config

func (*Client) Checker ¶ added in v0.2.0

func (c *Client) Checker(ctx context.Context, state *health.CheckState) error

func (*Client) Get ¶ added in v0.2.0

func (c *Client) Get(ctx context.Context, path string) (int, error)

type ErrInvalidAppResponse ¶ added in v0.2.0

type ErrInvalidAppResponse struct {
	ExpectedCode int
	ActualCode   int
	URI          string
}

ErrInvalidAppResponse is returned when an app does not respond with a valid status

func (ErrInvalidAppResponse) Error ¶ added in v0.2.0

func (e ErrInvalidAppResponse) Error() string

Error should be called by the user to print out the stringified version of the error

Source Files ¶

View all Source files

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