package
0.6.1
Repository: https://github.com/cosi-project/runtime.git
Documentation: pkg.go.dev

# Packages

Package conformance implements tests which verify conformance of the implementation with the spec.
No description provided by the author
Package protobuf provides wrappers/adapters between gRPC service and state.CoreState.
Package registry provides registries for namespaces and resource definitions.

# Functions

DefaultUpdateOptions returns default value for UpdateOptions.
Filter state access by some rules.
IsConflictError checks if err is resource already exists/update conflict.
IsNotFoundError checks if err is resource not found.
IsOwnerConflictError checks if err is owner conflict error.
IsPhaseConflictError checks if err is phase conflict error.
IsUnsupportedError checks if err is unsupported operation.
WatchWithIDQuery appends an ID query to the watch options.
WatchWithLabelQuery appends a label query to the watch options.
WithBootstrapContents enables loading initial list of resources as 'created' events for WatchKind API.
WithCondition for specified condition on the resource.
WithCreateOwner sets an owner for the created object.
WithDestroyOwner checks an owner on the object being destroyed.
WithEventTypes watches for specified event types (one of).
WithExpectedPhase modifies expected resource phase for the update request.
WithExpectedPhaseAny accepts any resource phase for the update request.
WithFinalizerEmpty waits for the resource finalizers to be empty.
WithGetUnmarshalOptions sets unmarshal options for Get API.
WithIDQuery appends an ID query to the list options.
WithKindTailEvents returns N most recent events as part of the response.
WithLabelQuery appends a label query to the list options.
WithListUnmarshalOptions sets unmarshal options for List API.
WithPhases watches for specified resource phases.
WithSkipProtobufUnmarshal skips full unmarshaling returning a generic wrapper.
WithTailEvents returns N most recent events as part of the response.
WithTeardownOwner checks an owner on the object being torn down.
WithUpdateOwner checks an owner on the object being updated.
WithWatchKindUnmarshalOptions sets unmarshal options for WatchKind API.
WithWatchUnmarshalOptions sets unmarshal options for Watch API.
WrapCore converts CoreState to State.

# Constants

Initial set of items for WatchKind(WithBootstrapContents) was sent.
Verb definitions.
Resource got created.
Verb definitions.
Resource was destroyed.
Error happened in the watch.
Verb definitions.
Verb definitions.
Verb definitions.
Resource got changed.
Verb definitions.

# Structs

Access describes state API access in a generic way.
CreateOptions for the CoreState.Create function.
DestroyOptions for the CoreState.Destroy function.
Event is emitted when resource changes.
GetOptions for the CoreState.Get function.
ListOptions for the CoreState.List function.
TeardownOptions for the CoreState.Teardown function.
UnmarshalOptions control resources marshaling/unmarshaling.
UpdateOptions for the CoreState.Update function.
WatchForCondition describes condition WatchFor is waiting for.
WatchKindOptions for the CoreState.WatchKind function.
WatchOptions for the CoreState.Watch function.

# Interfaces

CoreState is the central broker in the system handling state and changes.
ErrConflict should be implemented by already exists/update conflict errors.
ErrNotFound should be implemented by "not found" errors.
ErrOwnerConflict should be implemented by owner conflict errors.
ErrPhaseConflict should be implemented by resource phase conflict errors.
ErrUnsupported should be implemented by unsupported operation errors.
State extends CoreState with additional features which can be implemented on any CoreState.

# Type aliases

CreateOption builds CreateOptions.
DestroyOption builds DestroyOptions.
EventType is a type of StateEvent related to resource change.
FilteringRule defines a function which gets invoked on each state access.
GetOption builds GetOptions.
ListOption builds ListOptions.
ResourceConditionFunc checks some condition on the resource.
TeardownOption builds TeardownOptions.
UnmarshalOption builds MarshalOptions.
UpdateOption builds UpdateOptions.
UpdaterFunc is called on resource to update it to the desired state.
Verb is API verb.
WatchForConditionFunc builds WatchForCondition.
WatchKindOption builds WatchOptions.
WatchOption builds WatchOptions.