waiter

Documentation

Index

• type Config
• type WaitAcceptor
• type Waiter
  • func (w *Waiter) Wait() error

Types

type Config

type Config struct {
	Name        string
	Delay       int
	MaxAttempts int
	Operation   string
	Acceptors   []WaitAcceptor
}

A Config provides a collection of configuration values to setup a generated waiter code with.

type WaitAcceptor

type WaitAcceptor struct {
	Expected interface{}
	Matcher  string
	State    string
	Argument string
}

A WaitAcceptor provides the information needed to wait for an API operation to complete.

type Waiter

type Waiter struct {
	Config
	Client interface{}
	Input  interface{}
}

A Waiter provides waiting for an operation to complete.

func (*Waiter) Wait

func (w *Waiter) Wait() error

Wait waits for an operation to complete, expire max attempts, or fail. Error is returned if the operation fails.