v1

Documentation

Overview

Definitions for the Kubernetes types

Index

• func NewCustomResourceDefinitionClient(client client.Client) *customResourceDefinitionClient
• type Clientset
  • func NewClientset(client client.Client) Clientset
  • func NewClientsetFromConfig(cfg *rest.Config) (Clientset, error)
• type CustomResourceDefinitionClient
• type CustomResourceDefinitionReader
• type CustomResourceDefinitionSlice
• type CustomResourceDefinitionStatusWriter
• type CustomResourceDefinitionTransitionFunction
• type CustomResourceDefinitionWriter
• type MulticlusterClientset
  • func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset
• type MulticlusterCustomResourceDefinitionClient
  • func NewMulticlusterCustomResourceDefinitionClient(client multicluster.Client) MulticlusterCustomResourceDefinitionClient

Functions

func NewCustomResourceDefinitionClient

func NewCustomResourceDefinitionClient(client client.Client) *customResourceDefinitionClient

Types

type Clientset

type Clientset interface {
	// clienset for the apiextensions.k8s.io/v1/v1 APIs
	CustomResourceDefinitions() CustomResourceDefinitionClient
}

clienset for the apiextensions.k8s.io/v1 APIs

func NewClientset

func NewClientset(client client.Client) Clientset

func NewClientsetFromConfig

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

type CustomResourceDefinitionClient

type CustomResourceDefinitionClient interface {
	CustomResourceDefinitionReader
	CustomResourceDefinitionWriter
	CustomResourceDefinitionStatusWriter
}

Client knows how to perform CRUD operations on CustomResourceDefinitions.

type CustomResourceDefinitionReader

type CustomResourceDefinitionReader interface {
	// Get retrieves a CustomResourceDefinition for the given object key
	GetCustomResourceDefinition(ctx context.Context, name string) (*apiextensions_k8s_io_v1.CustomResourceDefinition, error)

	// List retrieves list of CustomResourceDefinitions for a given namespace and list options.
	ListCustomResourceDefinition(ctx context.Context, opts ...client.ListOption) (*apiextensions_k8s_io_v1.CustomResourceDefinitionList, error)
}

Reader knows how to read and list CustomResourceDefinitions.

type CustomResourceDefinitionSlice

type CustomResourceDefinitionSlice []*CustomResourceDefinition

CustomResourceDefinitionSlice represents a slice of *CustomResourceDefinition

type CustomResourceDefinitionStatusWriter

type CustomResourceDefinitionStatusWriter interface {
	// Update updates the fields corresponding to the status subresource for the
	// given CustomResourceDefinition object.
	UpdateCustomResourceDefinitionStatus(ctx context.Context, obj *apiextensions_k8s_io_v1.CustomResourceDefinition, opts ...client.SubResourceUpdateOption) error

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

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

type CustomResourceDefinitionTransitionFunction

type CustomResourceDefinitionTransitionFunction func(existing, desired *apiextensions_k8s_io_v1.CustomResourceDefinition) error

CustomResourceDefinitionTransitionFunction instructs the CustomResourceDefinitionWriter how to transition between an existing CustomResourceDefinition object and a desired on an Upsert

type CustomResourceDefinitionWriter

type CustomResourceDefinitionWriter interface {
	// Create saves the CustomResourceDefinition object.
	CreateCustomResourceDefinition(ctx context.Context, obj *apiextensions_k8s_io_v1.CustomResourceDefinition, opts ...client.CreateOption) error

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

	// Update updates the given CustomResourceDefinition object.
	UpdateCustomResourceDefinition(ctx context.Context, obj *apiextensions_k8s_io_v1.CustomResourceDefinition, opts ...client.UpdateOption) error

	// Patch patches the given CustomResourceDefinition object.
	PatchCustomResourceDefinition(ctx context.Context, obj *apiextensions_k8s_io_v1.CustomResourceDefinition, patch client.Patch, opts ...client.PatchOption) error

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

	// Create or Update the CustomResourceDefinition object.
	UpsertCustomResourceDefinition(ctx context.Context, obj *apiextensions_k8s_io_v1.CustomResourceDefinition, transitionFuncs ...CustomResourceDefinitionTransitionFunction) error
}

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

type MulticlusterClientset

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

MulticlusterClientset for the apiextensions.k8s.io/v1 APIs

func NewMulticlusterClientset

func NewMulticlusterClientset(client multicluster.Client) MulticlusterClientset

type MulticlusterCustomResourceDefinitionClient

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

Provides CustomResourceDefinitionClients for multiple clusters.

func NewMulticlusterCustomResourceDefinitionClient

func NewMulticlusterCustomResourceDefinitionClient(client multicluster.Client) MulticlusterCustomResourceDefinitionClient