probe

Documentation

Index

• type ComputedAttrs
• type Target
  • func (t Target) Attributes() map[string]cty.Value
  • func (t Target) Build() error
  • func (t Target) CacheEnabled()
  • func (t Target) ComputedAttrs() *ComputedAttrs
  • func (t Target) PreBuild() error

Types

type ComputedAttrs

type ComputedAttrs struct {
	DialAddress    string `hcl:"address,attr"`
	Timeout        string `hcl:"timeout,optional"`
	Delay          string `hcl:"delay,optional"`
	MaxRetries     int    `hcl:"max_retries,optional"`
	ExpectedStatus int    `hcl:"expected_status,optional"`
}

ComputedAttrs used to store the computed attributes of a probe target

type Target

type Target struct {
	*base.RawTarget `json:"-"`

	DialAddress    hcl.Expression `hcl:"address,attr"`
	Timeout        hcl.Expression `hcl:"timeout,optional"`
	Delay          hcl.Expression `hcl:"delay,optional"`
	MaxRetries     hcl.Expression `hcl:"max_retries,optional"`
	ExpectedStatus hcl.Expression `hcl:"expected_status,optional"`
}

Target blocks the build walk until the specified address is reachable or fails

func (Target) Attributes

func (t Target) Attributes() map[string]cty.Value

Attributes returns a combined map of rawTarget.Attributes and typedTarget.Attributes

func (Target) Build

func (t Target) Build() error

Build creates the file from the content in the location specified with the permissions specified

func (Target) CacheEnabled

func (t Target) CacheEnabled()

CacheEnabled overrides the default target caching behavior

func (Target) ComputedAttrs

func (t Target) ComputedAttrs() *ComputedAttrs

ComputedAttrs returns a pointer to computed attributes from the state store. If attributes are not in the state store it will create a new pointer and insert it into the state store.

func (Target) PreBuild

func (t Target) PreBuild() error

PreBuild a lifecycle hook for calculating state before the build