futures

Documentation

Index

• func Delete(to Setter, name, service, futureType string)
• func Get(from Getter, name, service, futureType string) *infrav1.Future
• func Has(from Getter, name, service, futureType string) bool
• func Set(to Setter, future *infrav1.Future)
• type Getter
• type Setter

Functions

func Delete

func Delete(to Setter, name, service, futureType string)

Delete deletes the specified future.

func Get

func Get(from Getter, name, service, futureType string) *infrav1.Future

Get returns the future with the given name, if the future does not exists, it returns nil.

func Has

func Has(from Getter, name, service, futureType string) bool

Has returns true if a future with the given name exists.

func Set

func Set(to Setter, future *infrav1.Future)

Set sets the given future.

NOTE: If a future already exists, we update it.

Types

type Getter

type Getter interface {
	client.Object

	// GetFutures returns the list of long running operation states for an object.
	GetFutures() infrav1.Futures
}

Getter interface defines methods that an object should implement in order to use the futures package for getting long running operation states.

type Setter

type Setter interface {
	Getter
	SetFutures(infrav1.Futures)
}

Setter interface defines methods that an object should implement in order to use the futures package for setting futures.