client-go: kmodules.xyz/client-go/tools/wait Index | Files

package wait

import "kmodules.xyz/client-go/tools/wait"

Index

Package Files

wait.go

func IsDeleted Uses

func IsDeleted(info *resource.Info, o *WaitOptions) (runtime.Object, bool, error)

IsDeleted is a condition func for waiting for something to be deleted

type ConditionFunc Uses

type ConditionFunc func(info *resource.Info, o *WaitOptions) (finalObject runtime.Object, done bool, err error)

ConditionFunc is the interface for providing condition checks

func ConditionFuncFor Uses

func ConditionFuncFor(condition string, errOut io.Writer) (ConditionFunc, error)

type ConditionalWait Uses

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

ConditionalWait hold information to check an API status condition

func (ConditionalWait) IsConditionMet Uses

func (w ConditionalWait) IsConditionMet(info *resource.Info, o *WaitOptions) (runtime.Object, bool, error)

IsConditionMet is a conditionfunc for waiting on an API condition to be met

type ResourceLocation Uses

type ResourceLocation struct {
    GroupResource schema.GroupResource
    Namespace     string
    Name          string
}

ResourceLocation holds the location of a resource

type UIDMap Uses

type UIDMap map[ResourceLocation]types.UID

UIDMap maps ResourceLocation with UID

type Wait Uses

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

Wait has helper methods for handling watches, including error handling.

func (Wait) IsDeleted Uses

func (w Wait) IsDeleted(event watch.Event) (bool, error)

IsDeleted returns true if the object is deleted. It prints any errors it encounters.

type WaitOptions Uses

type WaitOptions struct {
    ResourceFinder genericclioptions.ResourceFinder
    // UIDMap maps a resource location to a UID.  It is optional, but ConditionFuncs may choose to use it to make the result
    // more reliable.  For instance, delete can look for UID consistency during delegated calls.
    UIDMap        UIDMap
    DynamicClient dynamic.Interface
    Timeout       time.Duration

    Printer     printers.ResourcePrinter
    ConditionFn ConditionFunc
    genericclioptions.IOStreams
}

WaitOptions is a set of options that allows you to wait. This is the object reflects the runtime needs of a wait command, making the logic itself easy to unit test with our existing mocks.

func (*WaitOptions) RunWait Uses

func (o *WaitOptions) RunWait() error

RunWait runs the waiting logic

func (*WaitOptions) WaitUntilAvailable Uses

func (o *WaitOptions) WaitUntilAvailable(forCondition string) error

Package wait imports 20 packages (graph) and is imported by 2 packages. Updated 2020-09-30. Refresh now. Tools for package owners.