routes

Documentation

Overview

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

Index

• Constants
• func ConditionDeleted(_ *v1alpha1.Route, apiErr error) (bool, error)
• func FormatDiff(w io.Writer, leftName, rightName string, left, right *v1alpha1.Route)
• type Client
  • func NewClient(kclient kf.KfV1alpha1Interface) Client
• type ClientExtension
• type ConditionFuncE
• type CreateOption
• type CreateOptions
  • func CreateOptionDefaults() CreateOptions
  • func (opts CreateOptions) Extend(other CreateOptions) CreateOptions
• type DeleteOption
  • func WithDeleteForegroundDeletion(val bool) DeleteOption
• type DeleteOptions
  • func DeleteOptionDefaults() DeleteOptions
  • func (opts DeleteOptions) Extend(other DeleteOptions) DeleteOptions
  • func (opts DeleteOptions) ForegroundDeletion() bool
• type GetOption
• type GetOptions
  • func GetOptionDefaults() GetOptions
  • func (opts GetOptions) Extend(other GetOptions) GetOptions
• type List
  • func (list List) Filter(filter Predicate) (out List)
• type ListOption
  • func WithListFieldSelector(val map[string]string) ListOption
  • func WithListFilter(val Predicate) ListOption
• type ListOptions
  • func ListOptionDefaults() ListOptions
  • func (opts ListOptions) Extend(other ListOptions) ListOptions
• type Merger
• type Mutator
  • func DiffWrapper(w io.Writer, mutator Mutator) Mutator
• type Predicate
• type UpdateOption
• type UpdateOptions
  • func UpdateOptionDefaults() UpdateOptions
  • func (opts UpdateOptions) Extend(other UpdateOptions) UpdateOptions

Constants

const (
	// Kind contains the kind for the backing Kubernetes API.
	Kind = "Route"

	// APIVersion contains the version for the backing Kubernetes API.
	APIVersion = "v1alpha1"
)

Functions

func ConditionDeleted

func ConditionDeleted(_ *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 FormatDiff

func FormatDiff(w io.Writer, leftName, rightName string, left, right *v1alpha1.Route)

FormatDiff creates a diff between two v1alpha1.Routes and writes it to the given writer.

Types

type Client

type Client interface {
	Create(namespace string, obj *v1alpha1.Route, opts ...CreateOption) (*v1alpha1.Route, error)
	Update(namespace string, obj *v1alpha1.Route, opts ...UpdateOption) (*v1alpha1.Route, error)
	Transform(namespace string, name string, transformer Mutator) (*v1alpha1.Route, error)
	Get(namespace string, name string, opts ...GetOption) (*v1alpha1.Route, error)
	Delete(namespace string, name string, opts ...DeleteOption) error
	List(namespace string, opts ...ListOption) ([]v1alpha1.Route, error)
	Upsert(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)
	WaitForE(ctx context.Context, namespace string, name string, interval time.Duration, condition ConditionFuncE) (*v1alpha1.Route, error)

	// Utility functions
	WaitForDeletion(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(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 CreateOption

type CreateOption func(*createConfig)

CreateOption is a single option for configuring a createConfig

type CreateOptions

type CreateOptions []CreateOption

CreateOptions is a configuration set defining a createConfig

func CreateOptionDefaults

func CreateOptionDefaults() CreateOptions

CreateOptionDefaults gets the default values for Create.

func (CreateOptions) Extend

func (opts CreateOptions) Extend(other CreateOptions) CreateOptions

Extend creates a new CreateOptions with the contents of other overriding the values set in this CreateOptions.

type DeleteOption

type DeleteOption func(*deleteConfig)

DeleteOption is a single option for configuring a deleteConfig

func WithDeleteForegroundDeletion

func WithDeleteForegroundDeletion(val bool) DeleteOption

WithDeleteForegroundDeletion creates an Option that sets If the resource should be deleted in the foreground.

type DeleteOptions

type DeleteOptions []DeleteOption

DeleteOptions is a configuration set defining a deleteConfig

func DeleteOptionDefaults

func DeleteOptionDefaults() DeleteOptions

DeleteOptionDefaults gets the default values for Delete.

func (DeleteOptions) Extend

func (opts DeleteOptions) Extend(other DeleteOptions) DeleteOptions

Extend creates a new DeleteOptions with the contents of other overriding the values set in this DeleteOptions.

func (DeleteOptions) ForegroundDeletion

func (opts DeleteOptions) ForegroundDeletion() bool

ForegroundDeletion returns the last set value for ForegroundDeletion or the empty value if not set.

type GetOption

type GetOption func(*getConfig)

GetOption is a single option for configuring a getConfig

type GetOptions

type GetOptions []GetOption

GetOptions is a configuration set defining a getConfig

func GetOptionDefaults

func GetOptionDefaults() GetOptions

GetOptionDefaults gets the default values for Get.

func (GetOptions) Extend

func (opts GetOptions) Extend(other GetOptions) GetOptions

Extend creates a new GetOptions with the contents of other overriding the values set in this GetOptions.

type List

type List []v1alpha1.Route

List represents a collection of v1alpha1.Route.

func (List) Filter

func (list List) Filter(filter Predicate) (out List)

Filter returns a new list items for which the predicates fails removed.

type ListOption

type ListOption func(*listConfig)

ListOption is a single option for configuring a listConfig

func WithListFieldSelector

func WithListFieldSelector(val map[string]string) ListOption

WithListFieldSelector creates an Option that sets A selector on the resource's fields.

func WithListFilter

func WithListFilter(val Predicate) ListOption

WithListFilter creates an Option that sets Filter to apply.

type ListOptions

type ListOptions []ListOption

ListOptions is a configuration set defining a listConfig

func ListOptionDefaults

func ListOptionDefaults() ListOptions

ListOptionDefaults gets the default values for List.

func (ListOptions) Extend

func (opts ListOptions) Extend(other ListOptions) ListOptions

Extend creates a new ListOptions with the contents of other overriding the values set in this ListOptions.

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.

func DiffWrapper

func DiffWrapper(w io.Writer, mutator Mutator) Mutator

DiffWrapper wraps a mutator and prints out the diff between the original object and the one it returns if there's no error.

type Predicate

type Predicate func(*v1alpha1.Route) bool

Predicate is a boolean function for a v1alpha1.Route.

type UpdateOption

type UpdateOption func(*updateConfig)

UpdateOption is a single option for configuring a updateConfig

type UpdateOptions

type UpdateOptions []UpdateOption

UpdateOptions is a configuration set defining a updateConfig

func UpdateOptionDefaults

func UpdateOptionDefaults() UpdateOptions

UpdateOptionDefaults gets the default values for Update.

func (UpdateOptions) Extend

func (opts UpdateOptions) Extend(other UpdateOptions) UpdateOptions

Extend creates a new UpdateOptions with the contents of other overriding the values set in this UpdateOptions.