client

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 4, 2022 License: Apache-2.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ResourcesToGroupKindSet added in v0.5.0

func ResourcesToGroupKindSet(apis []APIResource) map[schema.GroupKind]struct{}

Types

type APIResource

type APIResource metav1.APIResource

APIResource represents a Kubernetes API resource.

func (APIResource) GroupKind added in v0.5.0

func (r APIResource) GroupKind() schema.GroupKind

func (APIResource) GroupVersionKind

func (r APIResource) GroupVersionKind() schema.GroupVersionKind

func (APIResource) GroupVersionResource

func (r APIResource) GroupVersionResource() schema.GroupVersionResource

func (APIResource) String

func (r APIResource) String() string

func (APIResource) WithGroupString added in v0.4.0

func (r APIResource) WithGroupString() string

type Flags

type Flags struct {
	*genericclioptions.ConfigFlags
}

Flags composes common client configuration flag structs used in the command.

func NewFlags

func NewFlags() *Flags

NewFlags returns flags associated with client configuration, with default values set.

func (*Flags) AddFlags

func (f *Flags) AddFlags(flags *pflag.FlagSet)

AddFlags receives a pflag.FlagSet reference and binds flags related to client configuration to it.

func (*Flags) Copy

func (f *Flags) Copy() Flags

Copy returns a copy of Flags for mutation.

func (*Flags) RegisterFlagCompletionFunc added in v0.4.0

func (*Flags) RegisterFlagCompletionFunc(cmd *cobra.Command, f cmdutil.Factory)

RegisterFlagCompletionFunc receives a *cobra.Command & register functions to to provide completion for flags related to client configuration.

Based off `registerCompletionFuncForGlobalFlags` from https://github.com/kubernetes/kubectl/blob/v0.22.1/pkg/cmd/cmd.go#L439-L460

func (*Flags) ToClient

func (f *Flags) ToClient() (Interface, error)

ToClient returns a client based on the flag configuration.

type GetOptions

type GetOptions struct {
	APIResource APIResource
	Namespace   string
}

type GetTableOptions

type GetTableOptions struct {
	APIResource APIResource
	Namespace   string
	Names       []string
}

type Interface

type Interface interface {
	GetMapper() meta.RESTMapper
	IsReachable() error
	ResolveAPIResource(s string) (*APIResource, error)

	Get(ctx context.Context, name string, opts GetOptions) (*unstructuredv1.Unstructured, error)
	GetAPIResources(ctx context.Context) ([]APIResource, error)
	GetTable(ctx context.Context, opts GetTableOptions) (*metav1.Table, error)
	List(ctx context.Context, opts ListOptions) (*unstructuredv1.UnstructuredList, error)
}

type ListOptions

type ListOptions struct {
	APIResourcesToExclude []APIResource
	APIResourcesToInclude []APIResource
	Namespaces            []string
}

type ObjectMeta

type ObjectMeta struct {
	APIResource
	Name      string
	Namespace string
}

ObjectMeta contains the metadata for identifying a Kubernetes object.

func (ObjectMeta) String

func (o ObjectMeta) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL