Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultArguments = Arguments{
Type: DetectorFSNotify,
PollFrequency: time.Minute,
}
DefaultArguments provides the default arguments for the local.file component.
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
type Arguments struct {
// Filename indicates the file to watch.
Filename string `river:"filename,attr"`
// Type indicates how to detect changes to the file.
Type Detector `river:"detector,attr,optional"`
// PollFrequency determines the frequency to check for changes when Type is
// UpdateTypePoll.
PollFrequency time.Duration `river:"poll_freqency,attr,optional"`
// IsSecret marks the file as holding a secret value which should not be
// displayed to the user.
IsSecret bool `river:"is_secret,attr,optional"`
}
Arguments holds values which are used to configure the local.file component.
func (*Arguments) UnmarshalRiver ¶ added in v0.27.0
func (a *Arguments) UnmarshalRiver(f func(interface{}) error) error
UnmarshalRiver implements river.Unmarshaler.
type Component ¶
type Component struct {
// contains filtered or unexported fields
}
Component implements the local.file component.
func New ¶
func New(o component.Options, args Arguments) (*Component, error)
New creates a new local.file component.
func (*Component) CurrentHealth ¶
func (c *Component) CurrentHealth() component.Health
CurrentHealth implements component.HealthComponent.
type Detector ¶
type Detector int
Detector is used to specify how changes to the file should be detected.
const (
// DetectorInvalid indicates an invalid UpdateType.
DetectorInvalid Detector = iota
// DetectorFSNotify uses filesystem events to wait for changes to the file.
DetectorFSNotify
// DetectorPoll will re-read the file on an interval to detect changes.
DetectorPoll
// DetectorDefault holds the default UpdateType.
DetectorDefault = DetectorFSNotify
)
func (Detector) MarshalText ¶
func (ut Detector) MarshalText() (text []byte, err error)
MarshalText implements encoding.TextMarshaler.
func (Detector) String ¶
func (ut Detector) String() string
String returns the string representation of the UpdateType.
func (*Detector) UnmarshalText ¶
func (ut *Detector) UnmarshalText(text []byte) error
UnmarshalText implements encoding.TextUnmarshaler.
Source Files
Click to show internal directories.
Click to hide internal directories.