client

Documentation

Index

• Constants
• func BuildTypeMap(kc client.Client, gvks ...schema.GroupVersionKind) (map[schema.GroupVersionKind]schema.GroupVersionKind, error)
• func CreateOrPatch(ctx context.Context, c client.Client, obj client.Object, ...) (kutil.VerbType, error)
• func GetForGVK(ctx context.Context, c client.Client, gvk schema.GroupVersionKind, ...) (client.Object, error)
• func GetForGVR(ctx context.Context, c client.Client, gvr schema.GroupVersionResource, ...) (client.Object, error)
• func GetServiceAccountTokenSecret(kc client.Client, sa client.ObjectKey) (*core.Secret, error)
• func NewAutoConvertClient(gvks ...schema.GroupVersionKind) client.NewClientFunc
• func NewClient(config *restclient.Config, options client.Options) (client.Client, error)
• func NewDelegatingClient(in NewDelegatingClientInput) (client.Client, error)
• func NewRetryClient(d client.Client) client.Client
• func NewRetryClientWithOptions(d client.Client, interval time.Duration, timeout time.Duration) client.Client
• func NewUncachedClient(cfg *rest.Config, funcs ...func(*runtime.Scheme) error) (client.Client, error)
• func PatchStatus(ctx context.Context, c client.Client, obj client.Object, ...) (kutil.VerbType, error)
• type DelegatingClient
  • func (d *DelegatingClient) GroupVersionKindFor(obj runtime.Object) (schema.GroupVersionKind, error)
  • func (d *DelegatingClient) Impersonate(u user.Info) (*restclient.Config, client.Client, error)
  • func (d *DelegatingClient) IsObjectNamespaced(obj runtime.Object) (bool, error)
  • func (d *DelegatingClient) RESTMapper() meta.RESTMapper
  • func (d *DelegatingClient) RestConfig() *restclient.Config
  • func (d *DelegatingClient) Scheme() *runtime.Scheme
  • func (d *DelegatingClient) SubResource(subResource string) client.SubResourceClient
• type NewDelegatingClientInput
• type TransformFunc
• type TransformStatusFunc

Constants

const (
	RetryTimeout = 10 * time.Second
)

Functions

func BuildTypeMap

func BuildTypeMap(kc client.Client, gvks ...schema.GroupVersionKind) (map[schema.GroupVersionKind]schema.GroupVersionKind, error)

func CreateOrPatch

func CreateOrPatch(ctx context.Context, c client.Client, obj client.Object, transform TransformFunc, opts ...client.PatchOption) (kutil.VerbType, error)

func GetForGVK

func GetForGVK(ctx context.Context, c client.Client, gvk schema.GroupVersionKind, ref types.NamespacedName) (client.Object, error)

func GetForGVR

func GetForGVR(ctx context.Context, c client.Client, gvr schema.GroupVersionResource, ref types.NamespacedName) (client.Object, error)

func GetServiceAccountTokenSecret

func GetServiceAccountTokenSecret(kc client.Client, sa client.ObjectKey) (*core.Secret, error)

func NewAutoConvertClient

func NewAutoConvertClient(gvks ...schema.GroupVersionKind) client.NewClientFunc

func NewClient

func NewClient(config *restclient.Config, options client.Options) (client.Client, error)

func NewDelegatingClient

func NewDelegatingClient(in NewDelegatingClientInput) (client.Client, error)

NewDelegatingClient creates a new delegating client.

A delegating client forms a Client by composing separate reader, writer and statusclient interfaces. This way, you can have an Client that reads from a cache and writes to the API server.

func NewRetryClient

func NewRetryClient(d client.Client) client.Client

func NewRetryClientWithOptions

func NewRetryClientWithOptions(d client.Client, interval time.Duration, timeout time.Duration) client.Client

func NewUncachedClient

func NewUncachedClient(cfg *rest.Config, funcs ...func(*runtime.Scheme) error) (client.Client, error)

func PatchStatus

func PatchStatus(ctx context.Context, c client.Client, obj client.Object, transform TransformStatusFunc, opts ...client.SubResourcePatchOption) (kutil.VerbType, error)

Types

type DelegatingClient

type DelegatingClient struct {
	client.Reader
	client.Writer
	client.StatusClient
	client.SubResourceClientConstructor
	// contains filtered or unexported fields
}

func (*DelegatingClient) GroupVersionKindFor

func (d *DelegatingClient) GroupVersionKindFor(obj runtime.Object) (schema.GroupVersionKind, error)

GroupVersionKindFor returns the GroupVersionKind for the given object.

func (*DelegatingClient) Impersonate

func (d *DelegatingClient) Impersonate(u user.Info) (*restclient.Config, client.Client, error)

func (*DelegatingClient) IsObjectNamespaced

func (d *DelegatingClient) IsObjectNamespaced(obj runtime.Object) (bool, error)

IsObjectNamespaced returns true if the GroupVersionKind of the object is namespaced.

func (*DelegatingClient) RESTMapper

func (d *DelegatingClient) RESTMapper() meta.RESTMapper

RESTMapper returns the rest mapper this client is using.

func (*DelegatingClient) RestConfig

func (d *DelegatingClient) RestConfig() *restclient.Config

func (*DelegatingClient) Scheme

func (d *DelegatingClient) Scheme() *runtime.Scheme

Scheme returns the scheme this client is using.

func (*DelegatingClient) SubResource

func (d *DelegatingClient) SubResource(subResource string) client.SubResourceClient

type NewDelegatingClientInput

type NewDelegatingClientInput struct {
	CacheReader       client.Reader
	Client            client.Client
	UncachedObjects   []client.Object
	CacheUnstructured bool
	Cachable          apiutil2.Cachable
	// contains filtered or unexported fields
}

NewDelegatingClientInput encapsulates the input parameters to create a new delegating client.

type TransformFunc

type TransformFunc func(obj client.Object, createOp bool) client.Object

type TransformStatusFunc

type TransformStatusFunc func(obj client.Object) client.Object