options

Documentation

Index

• type LoggerKey
• type OptsKey
• type RootOptions
  • func GetRootOptions() *RootOptions
  • func (opts *RootOptions) InitFlags(cmd *cobra.Command)
  • func (opts *RootOptions) SetAccessCredentialsFromEnv(cmd *cobra.Command) error

Types

type LoggerKey

type LoggerKey struct{}

type OptsKey

type OptsKey struct{}

type RootOptions

type RootOptions struct {
	// AccessKey is the access key credentials for accessing AWS over client
	AccessKey string
	// SecretKey is the secret key credentials for accessing AWS over client
	SecretKey string
	// BucketName is the name of target bucket
	BucketName string
	// FileNamePrefix is the prefix of target bucket objects, means it can be used for folder-based object grouping buckets
	FileNamePrefix string
	// Region is the region of the target bucket
	Region string
	// VerboseLog is the verbosity of the logging library
	VerboseLog bool
}

RootOptions contains frequent command line and application options.

func GetRootOptions

func GetRootOptions() *RootOptions

GetRootOptions returns the pointer of S3CleanerOptions

func (*RootOptions) InitFlags

func (opts *RootOptions) InitFlags(cmd *cobra.Command)

func (*RootOptions) SetAccessCredentialsFromEnv

func (opts *RootOptions) SetAccessCredentialsFromEnv(cmd *cobra.Command) error