client

Documentation

Index

• func ControlledListSingle(ctx context.Context, r client.Reader, scheme *runtime.Scheme, ...) error
• func ControlledListSingleAndDelete(ctx context.Context, r client.Reader, c client.Client, ...) error
• func ControlledListSingleGenerateOrPatch(ctx context.Context, r client.Reader, c client.Client, ...) (controllerutil.OperationResult, error)
• func ListSingle(ctx context.Context, r client.Reader, scheme *runtime.Scheme, ...) error
• func ListSingleAndDelete(ctx context.Context, r client.Reader, c client.Client, obj client.Object, ...) error
• func ListSingleGenerateOrPatch(ctx context.Context, r client.Reader, c client.Client, obj client.Object, ...) (controllerutil.OperationResult, error)

Functions

func ControlledListSingle

func ControlledListSingle(ctx context.Context, r client.Reader, scheme *runtime.Scheme, owner, obj client.Object, opts ...client.ListOption) error

func ControlledListSingleAndDelete

func ControlledListSingleAndDelete(ctx context.Context, r client.Reader, c client.Client, owner, obj client.Object, opts ...client.DeleteAllOfOption) error

func ControlledListSingleGenerateOrPatch

func ControlledListSingleGenerateOrPatch(ctx context.Context, r client.Reader, c client.Client, owner, obj client.Object, f controllerutil.MutateFn, opts ...client.ListOption) (controllerutil.OperationResult, error)

func ListSingle

func ListSingle(ctx context.Context, r client.Reader, scheme *runtime.Scheme, obj client.Object, opts ...client.ListOption) error

func ListSingleAndDelete

func ListSingleAndDelete(ctx context.Context, r client.Reader, c client.Client, obj client.Object, opts ...client.DeleteAllOfOption) error

func ListSingleGenerateOrPatch

func ListSingleGenerateOrPatch(ctx context.Context, r client.Reader, c client.Client, obj client.Object, f controllerutil.MutateFn, opts ...client.ListOption) (controllerutil.OperationResult, error)

ListSingleGenerateOrPatch lists a single object and, if it does not exist, generates (i.e. create an object with GenerateName set) an object or updates the single object.

The caller of ListSingleGenerateOrPatch *has* to make sure that the list call issued using client.Reader returns at most 1 object. client.Reader is used over client.Client since cached List calls may not yield objects created in previous invocations of ListSingleGenerateOrPatch, leading to inconsistent behavior.