deputil

Documentation

Index

• func NewInvalidDeploymentIDError(id string) error
• func ValidateParams(params Validator) error
• type QueryParams
• type Validator

Functions

func NewInvalidDeploymentIDError

func NewInvalidDeploymentIDError(id string) error

NewInvalidDeploymentIDError is returned when a deployment ID is invalid.

func ValidateParams

func ValidateParams(params Validator) error

ValidateParams validates that the Validator that is passed complies the basic Validate function

Types

type QueryParams

type QueryParams struct {
	// Single part
	ShowPlans                  bool
	ShowPlanDefaults           bool
	ShowPlanLogs               bool
	ShowPlanHistory            bool
	ShowMetadata               bool
	ShowSettings               bool
	ShowInstanceConfigurations bool
	EnrichtWithTemplate        bool
	ForceAllPlanHistory        bool
	ClearTransient             bool

	// List part
	ShowHidden bool
	Query      string
	Size       int64
}

QueryParams is meant to be embedded in other param structs to provide common deployment parameter query settings.

type Validator

type Validator interface {
	Validate() error
}

Validator wraps the Validate signature