preparedDataBucket

Documentation

Index

• Variables
• type Cmd
  • func (cmd *Cmd) AfterApply(app *kong.Kong) error
  • func (cmd *Cmd) BeforeApply(app *kong.Kong, logger *log.Logger) error
  • func (cmd *Cmd) Run(app *kong.Kong) error
• type FilePathMatcher
  • func (m *FilePathMatcher) IsSet() bool
  • func (m *FilePathMatcher) Match(key string) bool
  • func (m *FilePathMatcher) Pattern() string
  • func (m *FilePathMatcher) SetPattern(pattern string) error
  • func (m *FilePathMatcher) UnmarshalText(text []byte) (err error)
• type Matcher
• type RegexMatcher
  • func (m *RegexMatcher) IsSet() bool
  • func (m *RegexMatcher) Match(key string) bool
  • func (m *RegexMatcher) Pattern() string
  • func (m *RegexMatcher) SetPattern(pattern string) error
  • func (m *RegexMatcher) UnmarshalText(text []byte) error

Variables

var (
	ErrCompletion = errors.New("the operation completed with errors")
	ErrNoMatchers = errors.New("no match options are configured for purging data")
)

var (
	FFISMatcher      = &RegexMatcher{regexp.MustCompile(`\d{3}/\d{3,}/ffis.org/v1.json`)}
	GrantsGovMatcher = &RegexMatcher{regexp.MustCompile(`\d{3}/\d{3,}/grants.gov/v2.xml`)}
	AllMatcher       = &RegexMatcher{regexp.MustCompile(`.*`)}
)

Types

type Cmd

type Cmd struct {
	// Positional arguments
	S3Bucket string `arg:"" name:"bucket" help:"Prepared data S3 bucket name from which to purge objects."`

	// Flags
	MatchPaths     []FilePathMatcher   `placeholder:"glob" help:"Shell filename pattern (i.e. glob) for matching S3 keys to delete."`
	MatchRegex     []RegexMatcher      `placeholder:"expression" help:"Regex pattern for matching S3 keys to delete."`
	PurgeFFIS      bool                `help:"Delete all FFIS.org S3 objects (after applying --filter-prefix, if given)."`
	PurgeGov       bool                `help:"Delete all Grants.gov S3 objects (after applying --filter-prefix, if given)."`
	PurgeAll       bool                `help:"Delete all S3 objects (after applying --filter-prefix, if given)."`
	FilterPrefix   string              `name:"s3-prefix" default:"" help:"Prevent deleting bucket objects outside this prefix."`
	Concurrency    ct.ConcurrencyLimit `default:"10" help:"Max concurrent batch-delete operations."`
	TotalsAfter    ct.TotalsAfter      `default:"1000" help:"Log S3 object totals after this many successful/failed deletions (silent if 0)."`
	S3UsePathStyle bool                `name:"s3-use-path-style" help:"Use path-style addressing for S3 bucket."`
	DryRun         bool                `help:"Dry run only - no files will be uploaded to S3."`
	// contains filtered or unexported fields
}

func (*Cmd) AfterApply

func (cmd *Cmd) AfterApply(app *kong.Kong) error

func (*Cmd) BeforeApply

func (cmd *Cmd) BeforeApply(app *kong.Kong, logger *log.Logger) error

func (*Cmd) Run

func (cmd *Cmd) Run(app *kong.Kong) error

type FilePathMatcher

type FilePathMatcher struct {
	// contains filtered or unexported fields
}

func (*FilePathMatcher) IsSet

func (m *FilePathMatcher) IsSet() bool

func (*FilePathMatcher) Match

func (m *FilePathMatcher) Match(key string) bool

func (*FilePathMatcher) Pattern

func (m *FilePathMatcher) Pattern() string

func (*FilePathMatcher) SetPattern

func (m *FilePathMatcher) SetPattern(pattern string) error

func (*FilePathMatcher) UnmarshalText

func (m *FilePathMatcher) UnmarshalText(text []byte) (err error)

type Matcher

type Matcher interface {
	SetPattern(string) error
	Pattern() string
	Match(string) bool
}

type RegexMatcher

type RegexMatcher struct {
	// contains filtered or unexported fields
}

func (*RegexMatcher) IsSet

func (m *RegexMatcher) IsSet() bool

func (*RegexMatcher) Match

func (m *RegexMatcher) Match(key string) bool

func (*RegexMatcher) Pattern

func (m *RegexMatcher) Pattern() string

func (*RegexMatcher) SetPattern

func (m *RegexMatcher) SetPattern(pattern string) error

func (*RegexMatcher) UnmarshalText

func (m *RegexMatcher) UnmarshalText(text []byte) error