check

Documentation

Overview

Package check provides the messaging structures specific to poller checks

Index

• type CheckHeader
• type CheckIn
• type HTTPCheckDetails
• type HTTPCheckOut
• type PingCheckDetails
• type PingCheckOut
• type TCPCheckDetails
• type TCPCheckOut

Types

type CheckHeader

type CheckHeader struct {
	Id             string            `json:"id"`
	CheckType      string            `json:"type"`
	Period         uint64            `json:"period"`
	Timeout        uint64            `json:"timeout"`
	EntityId       string            `json:"entity_id"`
	ZoneId         string            `json:"zone_id"`
	Disabled       bool              `json:"disabled"`
	IpAddresses    map[string]string `json:"ip_addresses"`
	TargetAlias    *string           `json:"target_alias"`
	TargetHostname *string           `json:"target_hostname"`
	TargetResolver *string           `json:"target_resolver"`
}

type CheckIn

type CheckIn struct {
	CheckHeader

	RawDetails *json.RawMessage `json:"details"`
}

CheckIn is used for unmarshalling received check requests. Since the details are polymorphic, they are captured for delayed unmarshalling via the RawDetails field.

type HTTPCheckDetails

type HTTPCheckDetails struct {
	Details struct {
		AuthPassword    string            `json:"auth_password"`
		AuthUser        string            `json:"auth_user"`
		Body            string            `json:"body"`
		BodyMatches     map[string]string `json:"body_matches"`
		FollowRedirects bool              `json:"follow_redirects"`
		Headers         map[string]string `json:"headers"`
		IncludeBody     bool              `json:"include_body"`
		Method          string            `json:"method"`
		Url             string            `json:"url"`
	}
}

type HTTPCheckOut

type HTTPCheckOut struct {
	CheckHeader
	HTTPCheckDetails
}

type PingCheckDetails

type PingCheckDetails struct {
	Details struct {
		Count uint8 `json:"count"`
	}
}

type PingCheckOut

type PingCheckOut struct {
	CheckHeader
	PingCheckDetails
}

type TCPCheckDetails

type TCPCheckDetails struct {
	Details struct {
		BannerMatch string `json:"banner_match"`
		BodyMatch   string `json:"body_match"`
		Port        uint64 `json:"port"`
		SendBody    string `json:"send_body"`
		UseSSL      bool   `json:"ssl"`
	}
}

type TCPCheckOut

type TCPCheckOut struct {
	CheckHeader
	TCPCheckDetails
}