factory

Documentation

Index

• func NewFunc(config interface{}, dependencies factory.Dependencies, out interface{}) error
• type Config
  • func (c *Config) Validate() error
• type Dependencies
  • func (d *Dependencies) Validate() error

Functions

func NewFunc

func NewFunc(config interface{}, dependencies factory.Dependencies, out interface{}) error

NewFunc is the factory creation function for the S3 Storage implementation.

Types

type Config

type Config struct {
	// Region is the region the S3 component will operate in.
	Region string `validate:"required"`
}

Config is used to create an S3 storage component.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates that the config values are valid.

type Dependencies

type Dependencies struct {
	// Logger is used to store log information.
	Logger gz.Logger `validate:"required"`
	// API is the S3 API client used to interface with AWS S3.
	// If API is not provided, it will be initialized using Config values.
	API s3iface.S3API
}

Dependencies is used to create an S3 storage component.

func (*Dependencies) Validate

func (d *Dependencies) Validate() error

Validate validates that the dependencies values are valid.