cleaner

Documentation

Index

• Variables
• type API
  • func NewAPI(caller base.APICaller, options ...Option) *API
  • func (api *API) Cleanup(ctx context.Context) error
  • func (api *API) WatchCleanups(ctx context.Context) (watcher.NotifyWatcher, error)
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type API

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

API provides access to the Cleaner API facade.

func NewAPI

func NewAPI(caller base.APICaller, options ...Option) *API

NewAPI creates a new client-side Cleaner facade.

func (*API) Cleanup

func (api *API) Cleanup(ctx context.Context) error

Cleanup calls the server-side Cleanup method.

func (*API) WatchCleanups

func (api *API) WatchCleanups(ctx context.Context) (watcher.NotifyWatcher, error)

WatchCleanups calls the server-side WatchCleanups method.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.