action

Documentation

Overview

Package action contains a set of APIs for mutating kubernetes objects.

Index

• func Create(object sdkTypes.Object) (err error)
• func Delete(object sdkTypes.Object, opts ...DeleteOption) (err error)
• func Update(object sdkTypes.Object) (err error)
• type DeleteOp
  • func NewDeleteOp() *DeleteOp
• type DeleteOption
  • func WithDeleteOptions(metaDeleteOptions *metav1.DeleteOptions) DeleteOption

Functions

func Create

func Create(object sdkTypes.Object) (err error)

Create creates the provided object on the server and updates the arg "object" with the result from the server(UID, resourceVersion, etc). Returns an error if the object’s TypeMeta(Kind, APIVersion) or ObjectMeta(Name/GenerateName, Namespace) is missing or incorrect. Can also return an api error from the server e.g AlreadyExists https://github.com/kubernetes/apimachinery/blob/master/pkg/api/errors/errors.go#L423

func Delete

func Delete(object sdkTypes.Object, opts ...DeleteOption) (err error)

Delete deletes the specified object Returns an error if the object’s TypeMeta(Kind, APIVersion) or ObjectMeta(Name, Namespace) is missing or incorrect. e.g NotFound https://github.com/kubernetes/apimachinery/blob/master/pkg/api/errors/errors.go#L418 “opts” configures the DeleteOptions When passed WithDeleteOptions(o), the specified metav1.DeleteOptions are set.

func Update

func Update(object sdkTypes.Object) (err error)

Update updates the provided object on the server and updates the arg "object" with the result from the server(UID, resourceVersion, etc). Returns an error if the object’s TypeMeta(Kind, APIVersion) or ObjectMeta(Name, Namespace) is missing or incorrect. Can also return an api error from the server e.g Conflict https://github.com/kubernetes/apimachinery/blob/master/pkg/api/errors/errors.go#L428

Types

type DeleteOp

type DeleteOp struct {
	// contains filtered or unexported fields
}

DeleteOp wraps all the options for Delete().

func NewDeleteOp

func NewDeleteOp() *DeleteOp

type DeleteOption

type DeleteOption func(*DeleteOp)

DeleteOption configures DeleteOp.

func WithDeleteOptions

func WithDeleteOptions(metaDeleteOptions *metav1.DeleteOptions) DeleteOption

WithDeleteOptions sets the metav1.DeleteOptions for the Delete() operation.