options

Documentation

Index

• Variables
• type LoggerKey
• type OptsKey
• type RootOptions
  • func GetRootOptions() *RootOptions
  • func (opts *RootOptions) InitFlags(cmd *cobra.Command)
  • func (opts *RootOptions) PromptAccessCredentials(...) error
  • func (opts *RootOptions) SetAccessCredentialsFromEnv() error
  • func (opts *RootOptions) SetAccessFlagsRequired(cmd *cobra.Command)
  • func (opts *RootOptions) SetZeroValues()
• type S3SvcKey

Variables

var (
	SelectRunner    prompt.SelectRunner = prompt.GetSelectRunner("Select operation", []string{"search", "clean"})
	AccessKeyRunner prompt.PromptRunner = prompt.GetPromptRunner("Provide AWS Access Key", nil)
	SecretKeyRunner prompt.PromptRunner = prompt.GetPromptRunner("Provide AWS Secret Key", nil)
	RegionRunner    prompt.PromptRunner = prompt.GetPromptRunner("Provide AWS Region", nil)
	BucketRunner    prompt.PromptRunner = prompt.GetPromptRunner("Provide AWS Bucket Name", nil)
)

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
	// Region is the region of the target bucket
	Region string
	// VerboseLog is the verbosity of the logging library
	VerboseLog bool
	// Interactive is the decision of that if you want to use interactive feature
	Interactive bool
	// BannerFilePath is the relative path to the banner file
	BannerFilePath string
}

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) PromptAccessCredentials

func (opts *RootOptions) PromptAccessCredentials(accessKeyRunner, secretKeyRunner, bucketRunner, regionRunner prompt.PromptRunner) error

func (*RootOptions) SetAccessCredentialsFromEnv

func (opts *RootOptions) SetAccessCredentialsFromEnv() error

func (*RootOptions) SetAccessFlagsRequired

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

func (*RootOptions) SetZeroValues

func (opts *RootOptions) SetZeroValues()

type S3SvcKey

type S3SvcKey struct{}