Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultArguments = Arguments{
PollFrequency: 10 * time.Minute,
}
DefaultArguments sets the poll frequency
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
type Arguments struct {
Path string `river:"path,attr"`
// PollFrequency determines the frequency to check for changes
// defaults to 10m.
PollFrequency time.Duration `river:"poll_frequency,attr,optional"`
// IsSecret determines if the content should be displayed to the user.
IsSecret bool `river:"is_secret,attr,optional"`
// Options allows the overriding of default settings.
Options Client `river:"client,block,optional"`
}
Arguments implements the input for the S3 component.
func (*Arguments) SetToDefault ¶ added in v0.35.0
func (a *Arguments) SetToDefault()
SetToDefault implements river.Defaulter.
type Client ¶ added in v0.32.0
type Client struct {
AccessKey string `river:"key,attr,optional"`
Secret rivertypes.Secret `river:"secret,attr,optional"`
Endpoint string `river:"endpoint,attr,optional"`
DisableSSL bool `river:"disable_ssl,attr,optional"`
UsePathStyle bool `river:"use_path_style,attr,optional"`
Region string `river:"region,attr,optional"`
SigningRegion string `river:"signing_region,attr,optional"`
}
Client implements specific AWS configuration options
type Component ¶ added in v0.35.0
type Component struct {
// contains filtered or unexported fields
}
Component handles reading content from a file located in an Component-compatible system.
func New ¶
func New(o component.Options, args Arguments) (*Component, error)
New initializes the S3 component.
func (*Component) CurrentHealth ¶ added in v0.35.0
func (s *Component) CurrentHealth() component.Health
CurrentHealth returns the health of the component.
Click to show internal directories.
Click to hide internal directories.