argus

Documentation

Overview

Package argus provides primitives to interact with the openapi HTTP API.

Code generated by dev.azure.com/schwarzit/schwarzit.odj.core/_git/stackit-client-generator.git version v1.0.23 DO NOT EDIT.

Index

• Variables
• type Client
  • func NewRawClient[K contracts.ClientFlowConfig](server string, opts ...ClientOption[K]) (*Client[K], error)
• type ClientOption
  • func WithBaseURL[K contracts.ClientFlowConfig](baseURL string) ClientOption[K]
  • func WithHTTPClient[K contracts.ClientFlowConfig](doer contracts.ClientInterface[K]) ClientOption[K]
• type ClientWithResponses
  • func NewClient[K contracts.ClientFlowConfig](server string, opts ...ClientOption[K]) (*ClientWithResponses[K], error)
  • func NewService[K contracts.ClientFlowConfig](c contracts.ClientInterface[K]) *ClientWithResponses[K]

Variables

var BaseURLs = env.URLs(
	"argus",
	"https://argus.api.stackit.cloud",
	"https://argus.api.stg.stackit.cloud",
	"https://argus.api.dev.stackit.cloud",
)

Types

type Client

type Client[K contracts.ClientFlowConfig] struct {
	// list of connected client services
	Instances               *instances.Client[K]
	Acl                     *acl.Client[K]
	AlertConfig             *alertconfig.Client[K]
	AlertGroups             *alertgroups.Client[K]
	AlertRules              *alertrules.Client[K]
	AlertRecords            *alertrecords.Client[K]
	Backup                  *backup.Client[K]
	CertCheck               *certcheck.Client[K]
	GrafanaConfigs          *grafanaconfigs.Client[K]
	HttpCheck               *httpcheck.Client[K]
	Logs                    *logs.Client[K]
	MetricsStorageRetention *metricsstorageretention.Client[K]
	NetworkCheck            *networkcheck.Client[K]
	PingCheck               *pingcheck.Client[K]
	ScrapeConfig            *scrapeconfig.Client[K]
	Traces                  *traces.Client[K]
	Plans                   *plans.Client[K]

	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client contracts.ClientInterface[K]
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient[K contracts.ClientFlowConfig](server string, opts ...ClientOption[K]) (*Client[K], error)

type ClientOption

type ClientOption[K contracts.ClientFlowConfig] func(*Client[K]) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL[K contracts.ClientFlowConfig](baseURL string) ClientOption[K]

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient[K contracts.ClientFlowConfig](doer contracts.ClientInterface[K]) ClientOption[K]

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

type ClientWithResponses

type ClientWithResponses[K contracts.ClientFlowConfig] struct {
	Client *Client[K]

	// list of connected client services
	Instances               *instances.ClientWithResponses[K]
	Acl                     *acl.ClientWithResponses[K]
	AlertConfig             *alertconfig.ClientWithResponses[K]
	AlertGroups             *alertgroups.ClientWithResponses[K]
	AlertRules              *alertrules.ClientWithResponses[K]
	AlertRecords            *alertrecords.ClientWithResponses[K]
	Backup                  *backup.ClientWithResponses[K]
	CertCheck               *certcheck.ClientWithResponses[K]
	GrafanaConfigs          *grafanaconfigs.ClientWithResponses[K]
	HttpCheck               *httpcheck.ClientWithResponses[K]
	Logs                    *logs.ClientWithResponses[K]
	MetricsStorageRetention *metricsstorageretention.ClientWithResponses[K]
	NetworkCheck            *networkcheck.ClientWithResponses[K]
	PingCheck               *pingcheck.ClientWithResponses[K]
	ScrapeConfig            *scrapeconfig.ClientWithResponses[K]
	Traces                  *traces.ClientWithResponses[K]
	Plans                   *plans.ClientWithResponses[K]
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

func NewClient[K contracts.ClientFlowConfig](server string, opts ...ClientOption[K]) (*ClientWithResponses[K], error)

NewClient creates a new ClientWithResponses, which wraps Client with return type handling

func NewService

func NewService[K contracts.ClientFlowConfig](c contracts.ClientInterface[K]) *ClientWithResponses[K]