routes

Documentation

Overview

Package routes provides a way of managing a v1alpha1.Route.

Index

• Variables
• func ConditionDeleted(ctx context.Context, _ *v1alpha1.Route, apiErr error) (bool, error)
• func ConditionReadyTrue(ctx context.Context, obj *v1alpha1.Route, err error) (bool, error)
• func ExtractConditions(obj *v1alpha1.Route) (extracted []apis.Condition)
• func ObservedGenerationMatchesGeneration(obj *v1alpha1.Route) bool
• func WithConditionReporter(ctx context.Context, reporter ConditionReporter) context.Context
• type Client
  • func NewClient(kclient kf.KfV1alpha1Interface) Client
• type ClientExtension
• type ConditionFuncE
• type ConditionReporter
• type Merger
• type Mutator
• type Predicate
• type ResourceInfo
  • func NewResourceInfo() *ResourceInfo
  • func (*ResourceInfo) FriendlyName() string
  • func (*ResourceInfo) GroupVersionKind(context.Context) schema.GroupVersionKind
  • func (*ResourceInfo) GroupVersionResource(context.Context) schema.GroupVersionResource
  • func (*ResourceInfo) Namespaced() bool

Variables

var (
	ConditionReady = apis.ConditionType(v1alpha1.RouteConditionReady)
)

Functions

func ConditionDeleted

func ConditionDeleted(ctx context.Context, _ *v1alpha1.Route, apiErr error) (bool, error)

ConditionDeleted is a ConditionFuncE that succeeds if the error returned by the cluster was a not found error.

func ConditionReadyTrue

func ConditionReadyTrue(ctx context.Context, obj *v1alpha1.Route, err error) (bool, error)

ConditionReadyTrue is a ConditionFuncE that waits for Condition{Ready v1alpha1.RouteConditionReady } to become true and fails with an error if the condition becomes false.

func ExtractConditions

func ExtractConditions(obj *v1alpha1.Route) (extracted []apis.Condition)

ExtractConditions converts the native condition types into an apis.Condition array with the Type, Status, Reason, and Message fields intact.

func ObservedGenerationMatchesGeneration

func ObservedGenerationMatchesGeneration(obj *v1alpha1.Route) bool

ObservedGenerationMatchesGeneration is a predicate that returns true if the object's ObservedGeneration matches the genration of the object.

func WithConditionReporter

func WithConditionReporter(ctx context.Context, reporter ConditionReporter) context.Context

WithConditionReporter adds a callback to condition waits.

Types

type Client

type Client interface {
	Create(ctx context.Context, namespace string, obj *v1alpha1.Route) (*v1alpha1.Route, error)
	Transform(ctx context.Context, namespace string, name string, transformer Mutator) (*v1alpha1.Route, error)
	Get(ctx context.Context, namespace string, name string) (*v1alpha1.Route, error)
	Delete(ctx context.Context, namespace string, name string) error
	List(ctx context.Context, namespace string) ([]v1alpha1.Route, error)
	Upsert(ctx context.Context, namespace string, newObj *v1alpha1.Route, merge Merger) (*v1alpha1.Route, error)
	WaitFor(ctx context.Context, namespace string, name string, interval time.Duration, condition Predicate) (*v1alpha1.Route, error)

	// Utility functions
	WaitForDeletion(ctx context.Context, namespace string, name string, interval time.Duration) (*v1alpha1.Route, error)
	WaitForConditionReadyTrue(ctx context.Context, namespace string, name string, interval time.Duration) (*v1alpha1.Route, error)

	// ClientExtension can be used by the developer to extend the client.
	ClientExtension
}

Client is the interface for interacting with v1alpha1.Route types as Route CF style objects.

func NewClient

func NewClient(kclient kf.KfV1alpha1Interface) Client

NewClient creates a new Route client.

type ClientExtension

type ClientExtension interface {
}

ClientExtension holds additional functions that should be exposed by Client.

type ConditionFuncE

type ConditionFuncE func(ctx context.Context, instance *v1alpha1.Route, apiErr error) (done bool, err error)

ConditionFuncE is a callback used by waitForE. Done should be set to true once the condition succeeds and shouldn't be called anymore. The error will be passed back to the user.

This function MAY retrieve a nil instance and an apiErr. It's up to the function to decide how to handle the apiErr.

type ConditionReporter

type ConditionReporter func(message string)

ConditionReporter reports on changes to conditions while waiting.

type Merger

type Merger func(newObj, oldObj *v1alpha1.Route) *v1alpha1.Route

Merger is a type to merge an existing value with a new one.

type Mutator

type Mutator func(*v1alpha1.Route) error

Mutator is a function that changes v1alpha1.Route.

type Predicate

type Predicate func(*v1alpha1.Route) bool

Predicate is a boolean function for a v1alpha1.Route.

type ResourceInfo

type ResourceInfo struct{}

func NewResourceInfo

func NewResourceInfo() *ResourceInfo

NewResourceInfo returns a new instance of ResourceInfo

func (*ResourceInfo) FriendlyName

func (*ResourceInfo) FriendlyName() string

FriendlyName gets the user-facing name of the resource.

func (*ResourceInfo) GroupVersionKind

func (*ResourceInfo) GroupVersionKind(context.Context) schema.GroupVersionKind

GroupVersionKind gets the GVK struct for the resource.

func (*ResourceInfo) GroupVersionResource

func (*ResourceInfo) GroupVersionResource(context.Context) schema.GroupVersionResource

GroupVersionResource gets the GVR struct for the resource.

func (*ResourceInfo) Namespaced

func (*ResourceInfo) Namespaced() bool

Namespaced returns true if the type belongs in a namespace.