storage

Documentation

Overview

Package storage provides Registry interface and its REST implementation for storing chain api objects.

Index

• func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST, error)
• type ChainStorage
  • func NewStorage(optsGetter generic.RESTOptionsGetter) (ChainStorage, error)
• type REST
  • func (r *REST) Categories() []string
  • func (r *REST) ShortNames() []string
• type StatusREST
  • func (r *StatusREST) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1.Table, error)
  • func (r *StatusREST) Destroy()
  • func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)
  • func (r *StatusREST) GetResetFields() map[fieldpath.APIVersion]*fieldpath.Set
  • func (r *StatusREST) New() runtime.Object
  • func (r *StatusREST) Update(ctx context.Context, name string, objInfo rest.UpdatedObjectInfo, ...) (runtime.Object, bool, error)

Functions

func NewREST

func NewREST(optsGetter generic.RESTOptionsGetter) (*REST, *StatusREST, error)

NewREST returns a RESTStorage object that will work against chains.

Types

type ChainStorage

type ChainStorage struct {
	Chain  *REST
	Status *StatusREST
}

ChainStorage includes storage for chains and all sub resources.

func NewStorage

func NewStorage(optsGetter generic.RESTOptionsGetter) (ChainStorage, error)

NewStorage returns new instance of ChainStorage.

type REST

type REST struct {
	*genericregistry.Store
}

REST implements a RESTStorage for chains.

func (*REST) Categories

func (r *REST) Categories() []string

Categories implements the CategoriesProvider interface. Returns a list of categories a resource is part of.

func (*REST) ShortNames

func (r *REST) ShortNames() []string

ShortNames implements the ShortNamesProvider interface. Returns a list of short names for a resource.

type StatusREST

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

StatusREST implements the REST endpoint for changing the status of a chain.

func (*StatusREST) ConvertToTable

func (r *StatusREST) ConvertToTable(ctx context.Context, object runtime.Object, tableOptions runtime.Object) (*metav1.Table, error)

func (*StatusREST) Destroy

func (r *StatusREST) Destroy()

Destroy cleans up resources on shutdown.

func (*StatusREST) Get

func (r *StatusREST) Get(ctx context.Context, name string, options *metav1.GetOptions) (runtime.Object, error)

Get retrieves the object from the storage. It is required to support Patch.

func (*StatusREST) GetResetFields

func (r *StatusREST) GetResetFields() map[fieldpath.APIVersion]*fieldpath.Set

GetResetFields implements rest.ResetFieldsStrategy.

func (*StatusREST) New

func (r *StatusREST) New() runtime.Object

New returns empty Chain object.

func (*StatusREST) Update

func (r *StatusREST) Update(
	ctx context.Context,
	name string,
	objInfo rest.UpdatedObjectInfo,
	createValidation rest.ValidateObjectFunc,
	updateValidation rest.ValidateObjectUpdateFunc,
	forceAllowCreate bool,
	options *metav1.UpdateOptions,
) (runtime.Object, bool, error)

Update alters the status subset of an object.