cleaner

Documentation

Index

• type Cleaner
  • func (c *Cleaner) Destroy() error
  • func (c *Cleaner) Start() error
  • func (c *Cleaner) Stop() error
• type CleanerBuilder
  • func NewCleaner() *CleanerBuilder
  • func (b *CleanerBuilder) Build() (c *Cleaner, err error)
  • func (b *CleanerBuilder) Wait(value time.Duration) *CleanerBuilder

Types

type Cleaner

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

Cleaner is the implementation of the cleaner.

func (*Cleaner) Destroy

func (c *Cleaner) Destroy() error

Destroy releases all the resources used by the cleaner.

func (*Cleaner) Start

func (c *Cleaner) Start() error

Start starts the cleaner. This will wait the time given in the configuration and then will delete the project.

func (*Cleaner) Stop

func (c *Cleaner) Stop() error

Stop stops the the cleaner. This will cancel the deletion of the project, if it didn't happen already.

type CleanerBuilder

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

CleanerBuilder contains the information and logic needed to create the cleaner. Don't create instances of this type directly; use the NewCleaner function instead.

func NewCleaner

func NewCleaner() *CleanerBuilder

NewCleaner creates a new object that knows how to delete the OpenShift project.

func (*CleanerBuilder) Build

func (b *CleanerBuilder) Build() (c *Cleaner, err error)

Build uses the information stored in the builder to create a new cleaner. Note that this will create the cleaner but will not start it. To start it use the Start method.

func (*CleanerBuilder) Wait

func (b *CleanerBuilder) Wait(value time.Duration) *CleanerBuilder

Wait sets the time that the cleaner should wait before deleting the OpenShift project.