v1

Documentation

Overview

Definitions for the Kubernetes types

Index

• func NewGatewayClassClient(client client.Client) *gatewayClassClient
• func NewGatewayClient(client client.Client) *gatewayClient
• func NewHTTPRouteClient(client client.Client) *hTTPRouteClient
• type Clientset
  • func NewClientset(client client.Client) Clientset
  • func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)
• type GatewayClassClient
• type GatewayClassReader
• type GatewayClassSlice
• type GatewayClassStatusWriter
• type GatewayClassTransitionFunction
• type GatewayClassWriter
• type GatewayClient
• type GatewayReader
• type GatewaySlice
• type GatewayStatusWriter
• type GatewayTransitionFunction
• type GatewayWriter
• type HTTPRouteClient
• type HTTPRouteReader
• type HTTPRouteSlice
• type HTTPRouteStatusWriter
• type HTTPRouteTransitionFunction
• type HTTPRouteWriter
• type MulticlusterClientset
  • func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset
• type MulticlusterGatewayClassClient
  • func NewMulticlusterGatewayClassClient(client multicluster.Client) MulticlusterGatewayClassClient
• type MulticlusterGatewayClient
  • func NewMulticlusterGatewayClient(client multicluster.Client) MulticlusterGatewayClient
• type MulticlusterHTTPRouteClient
  • func NewMulticlusterHTTPRouteClient(client multicluster.Client) MulticlusterHTTPRouteClient

Functions

func NewGatewayClassClient

func NewGatewayClassClient(client client.Client) *gatewayClassClient

func NewGatewayClient

func NewGatewayClient(client client.Client) *gatewayClient

func NewHTTPRouteClient

func NewHTTPRouteClient(client client.Client) *hTTPRouteClient

Types

type Clientset

type Clientset interface {
	// clienset for the gateway.networking.k8s.io/v1/v1 APIs
	Gateways() GatewayClient
	// clienset for the gateway.networking.k8s.io/v1/v1 APIs
	GatewayClasses() GatewayClassClient
	// clienset for the gateway.networking.k8s.io/v1/v1 APIs
	HTTPRoutes() HTTPRouteClient
}

clienset for the gateway.networking.k8s.io/v1 APIs

func NewClientset

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig

func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)

type GatewayClassClient

type GatewayClassClient interface {
	GatewayClassReader
	GatewayClassWriter
	GatewayClassStatusWriter
}

Client knows how to perform CRUD operations on GatewayClasss.

type GatewayClassReader

type GatewayClassReader interface {
	// Get retrieves a GatewayClass for the given object key
	GetGatewayClass(ctx context.Context, name string) (*gateway_networking_k8s_io_v1.GatewayClass, error)

	// List retrieves list of GatewayClasss for a given namespace and list options.
	ListGatewayClass(ctx context.Context, opts ...client.ListOption) (*gateway_networking_k8s_io_v1.GatewayClassList, error)
}

Reader knows how to read and list GatewayClasss.

type GatewayClassSlice

type GatewayClassSlice []*GatewayClass

GatewayClassSlice represents a slice of *GatewayClass

type GatewayClassStatusWriter

type GatewayClassStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given GatewayClass object.
	UpdateGatewayClassStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given GatewayClass object's subresource.
	PatchGatewayClassStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a GatewayClass object.

type GatewayClassTransitionFunction

type GatewayClassTransitionFunction func(existing, desired *gateway_networking_k8s_io_v1.GatewayClass) error

GatewayClassTransitionFunction instructs the GatewayClassWriter how to transition between an existing GatewayClass object and a desired on an Upsert

type GatewayClassWriter

type GatewayClassWriter interface {
	// Create saves the GatewayClass object.
	CreateGatewayClass(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, opts ...client.CreateOption) error

	// Delete deletes the GatewayClass object.
	DeleteGatewayClass(ctx context.Context, name string, opts ...client.DeleteOption) error

	// Update updates the given GatewayClass object.
	UpdateGatewayClass(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, opts ...client.UpdateOption) error

	// Patch patches the given GatewayClass object.
	PatchGatewayClass(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all GatewayClass objects matching the given options.
	DeleteAllOfGatewayClass(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the GatewayClass object.
	UpsertGatewayClass(ctx context.Context, obj *gateway_networking_k8s_io_v1.GatewayClass, transitionFuncs ...GatewayClassTransitionFunction) error
}

Writer knows how to create, delete, and update GatewayClasss.

type GatewayClient

type GatewayClient interface {
	GatewayReader
	GatewayWriter
	GatewayStatusWriter
}

Client knows how to perform CRUD operations on Gateways.

type GatewayReader

type GatewayReader interface {
	// Get retrieves a Gateway for the given object key
	GetGateway(ctx context.Context, key client.ObjectKey) (*gateway_networking_k8s_io_v1.Gateway, error)

	// List retrieves list of Gateways for a given namespace and list options.
	ListGateway(ctx context.Context, opts ...client.ListOption) (*gateway_networking_k8s_io_v1.GatewayList, error)
}

Reader knows how to read and list Gateways.

type GatewaySlice

type GatewaySlice []*Gateway

GatewaySlice represents a slice of *Gateway

type GatewayStatusWriter

type GatewayStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given Gateway object.
	UpdateGatewayStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given Gateway object's subresource.
	PatchGatewayStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a Gateway object.

type GatewayTransitionFunction

type GatewayTransitionFunction func(existing, desired *gateway_networking_k8s_io_v1.Gateway) error

GatewayTransitionFunction instructs the GatewayWriter how to transition between an existing Gateway object and a desired on an Upsert

type GatewayWriter

type GatewayWriter interface {
	// Create saves the Gateway object.
	CreateGateway(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, opts ...client.CreateOption) error

	// Delete deletes the Gateway object.
	DeleteGateway(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given Gateway object.
	UpdateGateway(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, opts ...client.UpdateOption) error

	// Patch patches the given Gateway object.
	PatchGateway(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all Gateway objects matching the given options.
	DeleteAllOfGateway(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the Gateway object.
	UpsertGateway(ctx context.Context, obj *gateway_networking_k8s_io_v1.Gateway, transitionFuncs ...GatewayTransitionFunction) error
}

Writer knows how to create, delete, and update Gateways.

type HTTPRouteClient

type HTTPRouteClient interface {
	HTTPRouteReader
	HTTPRouteWriter
	HTTPRouteStatusWriter
}

Client knows how to perform CRUD operations on HTTPRoutes.

type HTTPRouteReader

type HTTPRouteReader interface {
	// Get retrieves a HTTPRoute for the given object key
	GetHTTPRoute(ctx context.Context, key client.ObjectKey) (*gateway_networking_k8s_io_v1.HTTPRoute, error)

	// List retrieves list of HTTPRoutes for a given namespace and list options.
	ListHTTPRoute(ctx context.Context, opts ...client.ListOption) (*gateway_networking_k8s_io_v1.HTTPRouteList, error)
}

Reader knows how to read and list HTTPRoutes.

type HTTPRouteSlice

type HTTPRouteSlice []*HTTPRoute

HTTPRouteSlice represents a slice of *HTTPRoute

type HTTPRouteStatusWriter

type HTTPRouteStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given HTTPRoute object.
	UpdateHTTPRouteStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, opts ...client.SubResourceUpdateOption) error

	// Patch patches the given HTTPRoute object's subresource.
	PatchHTTPRouteStatus(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, patch client.Patch, opts ...client.SubResourcePatchOption) error
}

StatusWriter knows how to update status subresource of a HTTPRoute object.

type HTTPRouteTransitionFunction

type HTTPRouteTransitionFunction func(existing, desired *gateway_networking_k8s_io_v1.HTTPRoute) error

HTTPRouteTransitionFunction instructs the HTTPRouteWriter how to transition between an existing HTTPRoute object and a desired on an Upsert

type HTTPRouteWriter

type HTTPRouteWriter interface {
	// Create saves the HTTPRoute object.
	CreateHTTPRoute(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, opts ...client.CreateOption) error

	// Delete deletes the HTTPRoute object.
	DeleteHTTPRoute(ctx context.Context, key client.ObjectKey, opts ...client.DeleteOption) error

	// Update updates the given HTTPRoute object.
	UpdateHTTPRoute(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, opts ...client.UpdateOption) error

	// Patch patches the given HTTPRoute object.
	PatchHTTPRoute(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, patch client.Patch, opts ...client.PatchOption) error

	// DeleteAllOf deletes all HTTPRoute objects matching the given options.
	DeleteAllOfHTTPRoute(ctx context.Context, opts ...client.DeleteAllOfOption) error

	// Create or Update the HTTPRoute object.
	UpsertHTTPRoute(ctx context.Context, obj *gateway_networking_k8s_io_v1.HTTPRoute, transitionFuncs ...HTTPRouteTransitionFunction) error
}

Writer knows how to create, delete, and update HTTPRoutes.

type MulticlusterClientset

type MulticlusterClientset interface {
	// Cluster returns a Clientset for the given cluster
	Cluster(cluster string) (Clientset, error)
}

MulticlusterClientset for the gateway.networking.k8s.io/v1 APIs

func NewMulticlusterClientset

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterGatewayClassClient

type MulticlusterGatewayClassClient interface {
	// Cluster returns a GatewayClassClient for the given cluster
	Cluster(cluster string) (GatewayClassClient, error)
}

Provides GatewayClassClients for multiple clusters.

func NewMulticlusterGatewayClassClient

func NewMulticlusterGatewayClassClient(client multicluster.Client) MulticlusterGatewayClassClient

type MulticlusterGatewayClient

type MulticlusterGatewayClient interface {
	// Cluster returns a GatewayClient for the given cluster
	Cluster(cluster string) (GatewayClient, error)
}

Provides GatewayClients for multiple clusters.

func NewMulticlusterGatewayClient

func NewMulticlusterGatewayClient(client multicluster.Client) MulticlusterGatewayClient

type MulticlusterHTTPRouteClient

type MulticlusterHTTPRouteClient interface {
	// Cluster returns a HTTPRouteClient for the given cluster
	Cluster(cluster string) (HTTPRouteClient, error)
}

Provides HTTPRouteClients for multiple clusters.

func NewMulticlusterHTTPRouteClient

func NewMulticlusterHTTPRouteClient(client multicluster.Client) MulticlusterHTTPRouteClient