config

Documentation

Index

• Variables
• type Config
  • func New() *Config
• type GuardRailsClient
  • func NewGuardRailsClientConfig() *GuardRailsClient
• type HttpClientConfig

Variables

var (
	ErrMissingGuardRailsAPIHost = errors.New("missing mandatory GUARDRAILS_API_HOST environment variables.")
)

Types

type Config

type Config struct {
	HttpClient       *HttpClientConfig
	GuardRailsClient *GuardRailsClient
}

Config provides centralized configuration for the application.

func New

func New() *Config

New instantiates new config.

type GuardRailsClient

type GuardRailsClient struct {
	APIHost string
}

GuardRailsClient contains configuration for guardrails client.

func NewGuardRailsClientConfig

func NewGuardRailsClientConfig() *GuardRailsClient

type HttpClientConfig

type HttpClientConfig struct {
	// PollingInterval define how long the client should wait before attempting to connect to API server.
	PollingInterval time.Duration
	// Timeout define maximum waiting time allowed for http connections before it considered timeout.
	Timeout time.Duration
	// RetryTimeout define maximum waiting time of doing backoff retry in case client get unexpected response from API server.
	RetryTimeout time.Duration
}

HttpClientConfig provides configuration for guardrails cli http client.