config

Documentation

Index

• type Config
  • func ParseConfigJSON(path string) (Config, error)
  • func ParseConfigYAML(path string) (Config, error)
  • func (c *Config) SetTimeout(dur time.Duration)
• type Duration
  • func (d *Duration) Get() time.Duration
  • func (d *Duration) UnmarshalJSON(b []byte) error
  • func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error
• type LegacyConfig
  • func ParseLegacyConfigJSON(path string) (LegacyConfig, error)
  • func ParseLegacyConfigYAML(path string) (LegacyConfig, error)
  • func (c *LegacyConfig) SetTimeout(dur time.Duration)

Types

type Config

type Config struct {
	// JWT platform token
	// Required: false
	// Example: "qwqwdfwv68979we0q9bfv7e9sbvd89798qrwv97ff"
	Token string `json:"token" yaml:"token"`

	// Application (client) identifier for authorization
	// in the cloud platform controller in oauth2 mode.
	// Required: true
	// Example: "ewqfrvea7s890avw804389qwguf234h0otfi3w4eiu"
	AppID string `json:"appId" yaml:"appId" validate:"required"`

	// Application (client) secret code for authorization
	// in the cloud platform controller in oauth2 mode.
	// Example: "frvet09rvesfis0c9erv9fsov0vsdfi09ovds0f"
	AppSecret string `json:"appSecret" yaml:"appSecret" validate:"required"`

	// Platform authentication service address
	// Required: true
	// Example: "https://sso.digitalenergy.online"
	SSOURL string `json:"ssoUrl" yaml:"ssoUrl" validate:"url"`

	// The address of the platform on which the actions are planned
	// Required: true
	// Example: "https://mr4.digitalenergy.online"
	DecortURL string `json:"decortUrl" yaml:"decortUrl" validate:"url"`

	// Amount platform request attempts
	// Default value: 5
	// Required: false
	Retries uint64 `json:"retries" yaml:"retries"`

	// Skip verify
	// Required: false
	SSLSkipVerify bool `json:"sslSkipVerify" yaml:"sslSkipVerify"`

	// HTTP client timeout, unlimited if left empty
	// Required: false
	Timeout Duration `json:"timeout" yaml:"timeout"`
}

Configuration for creating request to platform

func ParseConfigJSON

func ParseConfigJSON(path string) (Config, error)

ParseConfigJSON parses Config from specified JSON-formatted file.

func ParseConfigYAML

func ParseConfigYAML(path string) (Config, error)

ParseConfigYAML parses Config from specified YAML-formatted file.

func (*Config) SetTimeout

func (c *Config) SetTimeout(dur time.Duration)

SetTimeout is used to set HTTP client timeout.

type Duration

type Duration time.Duration

Duration is a wrapper around time.Duration (used for better user experience)

func (*Duration) Get

func (d *Duration) Get() time.Duration

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

func (*Duration) UnmarshalYAML

func (d *Duration) UnmarshalYAML(unmarshal func(interface{}) error) error

type LegacyConfig

type LegacyConfig struct {
	// ServiceAccount username
	// Required: true
	// Example : "osh_mikoev"
	Username string `json:"username" yaml:"username" validate:"required"`

	// ServiceAccount password
	// Required: true
	// Example: "[1o>hYkjnJr)HI78q7t&#%8Lm"
	Password string `json:"password" yaml:"password" validate:"required"`

	// Platform token
	// Required: false
	// Example: "158e76424b0d4810b6086hgbhj928fc4a6bc06e"
	Token string `json:"token" yaml:"token"`

	// Address of the platform on which the actions are planned
	// Required: true
	// Example: "https://mr4.digitalenergy.online"
	DecortURL string `json:"decortUrl" yaml:"decortUrl" validate:"url"`

	// Amount platform request attempts
	// Default value: 5
	// Required: false
	Retries uint64 `json:"retries" yaml:"retries"`

	// Skip verify
	// Required: false
	SSLSkipVerify bool `json:"sslSkipVerify" yaml:"sslSkipVerify"`

	// HTTP client timeout, unlimited if left empty
	// Required: false
	Timeout Duration `json:"timeout" yaml:"timeout"`
}

Legacy client configuration

func ParseLegacyConfigJSON

func ParseLegacyConfigJSON(path string) (LegacyConfig, error)

ParseLegacyConfigJSON parses LegacyConfig from specified JSON-formatted file.

func ParseLegacyConfigYAML

func ParseLegacyConfigYAML(path string) (LegacyConfig, error)

ParseLegacyConfigYAML parses LegacyConfig from specified YAML-formatted file.

func (*LegacyConfig) SetTimeout

func (c *LegacyConfig) SetTimeout(dur time.Duration)

SetTimeout is used to set HTTP client timeout.