Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrRedirectAttempted = errors.New("redirect")
ErrRedirectAttempted indicates that a redirect occurred.
Functions ¶
func NewHTTPClient ¶
NewHTTPClient creates new HTTPClient.
func NewHTTPRequest ¶
NewHTTPRequest creates a new *http.Requests based on Request fields and returns *http.Requests and error if any encountered.
func NewTLSConfig ¶ added in v0.0.2
func NewTLSConfig(config ClientTLSConfig) (*tls.Config, error)
NewTLSConfig returns a tls.Config, may be nil without error if TLS is not configured.
Types ¶
type Client ¶
type Client struct {
Timeout Duration `yaml:"timeout"` // default is zero (no timeout) must be tuned by modules
NotFollowRedirect bool `yaml:"not_follow_redirects"` // default is follow
ProxyURL string `yaml:"proxy_url"`
ClientTLSConfig `yaml:",inline"`
}
Client is a struct that contains the fields that are needed fore creating HTTPClient.
type ClientTLSConfig ¶ added in v0.0.2
type ClientTLSConfig struct {
TLSCA string `yaml:"tls_ca"`
TLSCert string `yaml:"tls_cert"`
TLSKey string `yaml:"tls_key"`
InsecureSkipVerify bool `yaml:"tls_skip_verify"`
}
ClientTLSConfig represents the standard client TLS config.
type Duration ¶
Duration is a time.Duration wrapper.
func (*Duration) UnmarshalYAML ¶
UnmarshalYAML implements yaml.Unmarshaler.
type Request ¶
type Request struct {
URL *url.URL `yaml:"-"`
UserURL string `yaml:"url"`
Body string `yaml:"body"`
Method string `yaml:"method"`
Headers map[string]string `yaml:"headers"`
Username string `yaml:"username"`
Password string `yaml:"password"`
ProxyUsername string `yaml:"proxy_username"`
ProxyPassword string `yaml:"proxy_password"`
}
Request is a struct that contains the fields that are needed to newHTTPClient *http.Request.
func (*Request) ParseUserURL ¶ added in v0.5.0
ParseUserURL parses UserURL into *url.URL and sets URL.