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) UnmarshalRiver ¶
func (a *Arguments) UnmarshalRiver(f func(v interface{}) error) error
UnmarshalRiver implements the unmarshaller
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"`
}
Client implements specific AWS configuration options
type Exports ¶
type Exports struct {
Content rivertypes.OptionalSecret `river:"content,attr"`
}
Exports implements the file content
type S3 ¶
type S3 struct {
// contains filtered or unexported fields
}
S3 handles reading content from a file located in an S3-compatible system.
func New ¶
func New(o component.Options, args Arguments) (*S3, error)
New initializes the S3 component.
func (*S3) CurrentHealth ¶
func (s *S3) CurrentHealth() component.Health
CurrentHealth returns the health of the component.
Click to show internal directories.
Click to hide internal directories.