v1beta1

Documentation

Overview

Definitions for the Kubernetes types

Index

• func NewGatewayClient(client client.Client) *gatewayClient
• type Clientset
  • func NewClientset(client client.Client) Clientset
  • func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)
• type GatewayClient
• type GatewayReader
• type GatewaySlice
• type GatewayStatusWriter
• type GatewayTransitionFunction
• type GatewayWriter
• type MulticlusterClientset
  • func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset
• type MulticlusterGatewayClient
  • func NewMulticlusterGatewayClient(client multicluster.Client) MulticlusterGatewayClient

Functions

func NewGatewayClient

func NewGatewayClient(client client.Client) *gatewayClient

Types

type Clientset

type Clientset interface {
	// clienset for the gateway.networking.k8s.io/v1beta1/v1beta1 APIs
	Gateways() GatewayClient
}

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

func NewClientset

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig

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

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, name string) (*gateway_networking_k8s_io_v1beta1.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_v1beta1.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_v1beta1.Gateway, opts ...client.UpdateOption) error

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

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

type GatewayTransitionFunction

type GatewayTransitionFunction func(existing, desired *gateway_networking_k8s_io_v1beta1.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_v1beta1.Gateway, opts ...client.CreateOption) error

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

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

	// Patch patches the given Gateway object.
	PatchGateway(ctx context.Context, obj *gateway_networking_k8s_io_v1beta1.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_v1beta1.Gateway, transitionFuncs ...GatewayTransitionFunction) error
}

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

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/v1beta1 APIs

func NewMulticlusterClientset

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

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