resource

package

Go to main page

Versions in this module

v0

v0.5.2

Mar 28, 2026

v0.5.1

Mar 28, 2026

v0.5.0

Mar 20, 2026

v0.4.1

Mar 18, 2026

v0.4.0

Mar 16, 2026

Changes in this version

type RelationshipDescriptor

+ TargetNamespaced *bool

v0.3.1

Mar 14, 2026

Changes in this version

+ type EdgeDirection string

+ const EdgeIncoming

+ const EdgeOutgoing

type RelationshipDescriptor

+ Direction EdgeDirection

type RelationshipType

+ const RelSelects

+ type ResourceMetadata struct

+ CreatedAt *time.Time

+ Labels map[string]string

+ UID string

type WatchAddPayload

+ Metadata ResourceMetadata

type WatchUpdatePayload

+ Metadata ResourceMetadata

v0.3.0

Mar 12, 2026

v0.2.1

Mar 10, 2026

Changes in this version

type ConnectionLifecycleProvider

+ CheckConnection func(ctx context.Context, connectionID string) (types.ConnectionStatus, error)

v0.2.0

Mar 6, 2026

Changes in this version

+ var AllScopeModes = []struct{ ... }

+ var AllSyncPolicies = []struct{ ... }

+ var AllWatchStates = []struct{ ... }

+ var ErrConnectionUnchanged = errors.New("connection unchanged")

+ func BuildResourceController[ClientT any](ctx context.Context, cfg ResourcePluginConfig[ClientT]) (*resourceController[ClientT], error)

+ func ConnectionFromContext(ctx context.Context) *types.Connection

+ func PtrFloat64(v float64) *float64

+ func WithSession(ctx context.Context, s *Session) context.Context

+ func WithWatchScope(ctx context.Context, scope *WatchScope) context.Context

+ type ActionDescriptor struct

+ Dangerous bool

+ Description string

+ ID string

+ Icon string

+ Label string

+ OutputSchema *Schema

+ ParamsSchema *Schema

+ Scope ActionScope

+ Streaming bool

+ type ActionEvent struct

+ Data map[string]interface{}

+ Type string

+ type ActionInput struct

+ ID string

+ Namespace string

+ Params map[string]interface{}

+ type ActionProvider interface

+ ExecuteAction func(ctx context.Context, key string, actionID string, input ActionInput) (*ActionResult, error)

+ GetActions func(ctx context.Context, key string) ([]ActionDescriptor, error)

+ StreamAction func(ctx context.Context, key string, actionID string, input ActionInput, ...) error

+ type ActionResourcer interface

+ ExecuteAction func(ctx context.Context, client *ClientT, meta ResourceMeta, actionID string, ...) (*ActionResult, error)

+ GetActions func(ctx context.Context, client *ClientT, meta ResourceMeta) ([]ActionDescriptor, error)

+ StreamAction func(ctx context.Context, client *ClientT, meta ResourceMeta, actionID string, ...) error

+ type ActionResult struct

+ Data map[string]interface{}

+ Message string

+ Success bool

+ type ActionScope string

+ const ActionScopeInstance

+ const ActionScopeType

+ type ClientRefresher interface

+ RefreshClient func(ctx context.Context, client *ClientT) error

+ type ColumnDefinition struct

+ AccessorPriority string

+ Accessors string

+ Alignment string

+ Color string

+ ColorMap map[string]string

+ Component string

+ ComponentParams interface{}

+ Formatter string

+ Header string

+ Hidden bool

+ ID string

+ ResourceLink *ResourceLink

+ ValueMap map[string]string

+ Width int

+ type ConnectionLifecycleProvider interface

+ DeleteConnection func(ctx context.Context, id string) error

+ GetConnection func(ctx context.Context, id string) (types.Connection, error)

+ GetConnectionNamespaces func(ctx context.Context, id string) ([]string, error)

+ ListConnections func(ctx context.Context) ([]types.Connection, error)

+ LoadConnections func(ctx context.Context) ([]types.Connection, error)

+ StartConnection func(ctx context.Context, connectionID string) (types.ConnectionStatus, error)

+ StopConnection func(ctx context.Context, connectionID string) (types.Connection, error)

+ UpdateConnection func(ctx context.Context, connection types.Connection) (types.Connection, error)

+ WatchConnections func(ctx context.Context, stream chan<- []types.Connection) error

+ type ConnectionProvider interface

+ CheckConnection func(ctx context.Context, conn *types.Connection, client *ClientT) (types.ConnectionStatus, error)

+ CreateClient func(ctx context.Context) (*ClientT, error)

+ DestroyClient func(ctx context.Context, client *ClientT) error

+ GetNamespaces func(ctx context.Context, client *ClientT) ([]string, error)

+ LoadConnections func(ctx context.Context) ([]types.Connection, error)

+ type ConnectionWatcher interface

+ WatchConnections func(ctx context.Context) (<-chan []types.Connection, error)

+ type CreateInput struct

+ Input json.RawMessage

+ Namespace string

+ type CreateResult struct

+ Result json.RawMessage

+ Success bool

+ type DefinitionProvider interface

+ Definition func() ResourceDefinition

+ type DeleteInput struct

+ GracePeriodSeconds *int64

+ ID string

+ Namespace string

+ type DeleteResult struct

+ Result json.RawMessage

+ Success bool

+ type DiscoveryProvider interface

+ Discover func(ctx context.Context, conn *types.Connection) ([]ResourceMeta, error)

+ OnConnectionRemoved func(ctx context.Context, conn *types.Connection) error

+ type EditorSchema struct

+ Content []byte

+ FileMatch string

+ Language string

+ ResourceKey string

+ URI string

+ URL string

+ type EditorSchemaProvider interface

+ GetEditorSchemas func(ctx context.Context, connectionID string) ([]EditorSchema, error)

+ type ErrorClassifier interface

+ ClassifyError func(err error) error

+ type EventRetriever interface

+ GetEvents func(ctx context.Context, client *ClientT, meta ResourceMeta, id string, ...) ([]ResourceEvent, error)

+ type EventSeverity string

+ const SeverityError

+ const SeverityNormal

+ const SeverityWarning

+ type FilterExpression struct

+ Groups []FilterExpression

+ Logic FilterLogic

+ Predicates []FilterPredicate

+ type FilterField struct

+ AllowedValues []string

+ Description string

+ DisplayName string

+ Operators []FilterOperator

+ Path string

+ Required bool

+ Type FilterFieldType

+ type FilterFieldType string

+ const FilterFieldBool

+ const FilterFieldEnum

+ const FilterFieldFloat

+ const FilterFieldInt

+ const FilterFieldMap

+ const FilterFieldString

+ const FilterFieldTime

+ type FilterLogic string

+ const FilterAnd

+ const FilterOr

+ type FilterOperator string

+ const OpContains

+ const OpEqual

+ const OpExists

+ const OpGreaterOrEqual

+ const OpGreaterThan

+ const OpHasKey

+ const OpIn

+ const OpLessOrEqual

+ const OpLessThan

+ const OpNotEqual

+ const OpNotExists

+ const OpNotIn

+ const OpPrefix

+ const OpRegex

+ const OpSuffix

+ type FilterPredicate struct

+ Field string

+ Operator FilterOperator

+ Value interface{}

+ type FilterableProvider interface

+ FilterFields func(ctx context.Context, connectionID string) ([]FilterField, error)

+ type FindInput struct

+ Filters *FilterExpression

+ Namespaces []string

+ Order []OrderField

+ Pagination PaginationParams

+ TextQuery string

+ type FindResult struct

+ NextCursor string

+ Result []json.RawMessage

+ Success bool

+ TotalCount int

+ type GetInput struct

+ ID string

+ Namespace string

+ type GetResult struct

+ Result json.RawMessage

+ Success bool

+ type HealthAssessor interface

+ AssessHealth func(ctx context.Context, client *ClientT, meta ResourceMeta, data json.RawMessage) (*ResourceHealth, error)

+ type HealthCondition struct

+ LastProbeTime *time.Time

+ LastTransitionTime *time.Time

+ Message string

+ Reason string

+ Status string

+ Type string

+ type HealthProvider interface

+ GetHealth func(ctx context.Context, connectionID string, resourceKey string, ...) (*ResourceHealth, error)

+ GetResourceEvents func(ctx context.Context, connectionID string, resourceKey string, id string, ...) ([]ResourceEvent, error)

+ type HealthStatus string

+ const HealthDegraded

+ const HealthHealthy

+ const HealthPending

+ const HealthUnhealthy

+ const HealthUnknown

+ type ListInput struct

+ Namespaces []string

+ Order []OrderField

+ Pagination PaginationParams

+ type ListResult struct

+ NextCursor string

+ Result []json.RawMessage

+ Success bool

+ TotalCount int

+ type OperationProvider interface

+ Create func(ctx context.Context, key string, input CreateInput) (*CreateResult, error)

+ Delete func(ctx context.Context, key string, input DeleteInput) (*DeleteResult, error)

+ Find func(ctx context.Context, key string, input FindInput) (*FindResult, error)

+ Get func(ctx context.Context, key string, input GetInput) (*GetResult, error)

+ List func(ctx context.Context, key string, input ListInput) (*ListResult, error)

+ Update func(ctx context.Context, key string, input UpdateInput) (*UpdateResult, error)

+ type OrderField struct

+ Descending bool

+ Field string

+ type PaginationParams struct

+ Cursor string

+ Page int

+ PageSize int

+ type Provider interface

+ type RelationshipDeclarer interface

+ DeclareRelationships func() []RelationshipDescriptor

+ type RelationshipDescriptor struct

+ Cardinality string

+ Extractor *RelationshipExtractor

+ InverseLabel string

+ Label string

+ TargetResourceKey string

+ Type RelationshipType

+ type RelationshipExtractor struct

+ FieldPath string

+ LabelSelector map[string]string

+ Method string

+ OwnerRefKind string

+ type RelationshipProvider interface

+ GetRelationships func(ctx context.Context, resourceKey string) ([]RelationshipDescriptor, error)

+ ResolveRelationships func(ctx context.Context, connectionID string, resourceKey string, id string, ...) ([]ResolvedRelationship, error)

+ type RelationshipResolver interface

+ ResolveRelationships func(ctx context.Context, client *ClientT, meta ResourceMeta, id string, ...) ([]ResolvedRelationship, error)

+ type RelationshipType string

+ const RelExposes

+ const RelManages

+ const RelMemberOf

+ const RelOwns

+ const RelRunsOn

+ const RelUses

+ type ResolvedRelationship struct

+ Descriptor RelationshipDescriptor

+ Targets []ResourceRef

+ type ResourceCapabilities struct

+ CanCreate bool

+ CanDelete bool

+ CanFind bool

+ CanGet bool

+ CanList bool

+ CanUpdate bool

+ Filterable bool

+ HasActions bool

+ HasEvents bool

+ HasHealth bool

+ HasRelationships bool

+ HasSchema bool

+ NamespaceScoped bool

+ Scale *ScaleHint

+ Searchable bool

+ Watchable bool

+ type ResourceDefinition struct

+ ColumnDefs []ColumnDefinition

+ IDAccessor string

+ MemoizerAccessor string

+ NamespaceAccessor string

+ type ResourceEvent struct

+ Count int32

+ FirstSeen time.Time

+ LastSeen time.Time

+ Message string

+ Reason string

+ Source string

+ Type EventSeverity

+ type ResourceGroup struct

+ Description string

+ ID string

+ Icon string

+ Name string

+ Resources map[string][]ResourceMeta

+ type ResourceHealth struct

+ Conditions []HealthCondition

+ Message string

+ Reason string

+ Since *time.Time

+ Status HealthStatus

+ type ResourceLink struct

+ DetailExtractors map[string]string

+ DisplayID bool

+ IDAccessor string

+ Key string

+ KeyAccessor string

+ KeyMap map[string]string

+ NamespaceAccessor string

+ Namespaced bool

+ type ResourceMeta struct

+ Category string

+ Description string

+ Group string

+ Icon string

+ Kind string

+ Label string

+ Version string

+ func ResourceMetaFromString(s string) ResourceMeta

+ func (r ResourceMeta) Key() string

+ func (r ResourceMeta) String() string

+ type ResourceOperationError struct

+ Code string

+ Err error

+ Message string

+ Suggestions []string

+ Title string

+ func ErrFilterInvalidOperator(field string, op FilterOperator, allowed []FilterOperator) *ResourceOperationError

+ func ErrFilterUnknownField(field string) *ResourceOperationError

+ func (e *ResourceOperationError) Error() string

+ func (e *ResourceOperationError) Unwrap() error

+ type ResourcePluginConfig struct

+ Connections ConnectionProvider[ClientT]

+ DefaultDefinition ResourceDefinition

+ Discovery DiscoveryProvider

+ ErrorClassifier ErrorClassifier

+ Groups []ResourceGroup

+ Logger logging.Logger

+ Patterns map[string]Resourcer[ClientT]

+ Resources []ResourceRegistration[ClientT]

+ func (c ResourcePluginConfig[ClientT]) Validate() error

+ type ResourceRef struct

+ ConnectionID string

+ DisplayName string

+ ID string

+ Namespace string

+ PluginID string

+ ResourceKey string

+ type ResourceRegistration struct

+ Definition *ResourceDefinition

+ Meta ResourceMeta

+ Resourcer Resourcer[ClientT]

+ type ResourceSchemaProvider interface

+ GetResourceSchema func(ctx context.Context, client *ClientT, meta ResourceMeta) (json.RawMessage, error)

+ type Resourcer interface

+ Create func(ctx context.Context, client *ClientT, meta ResourceMeta, input CreateInput) (*CreateResult, error)

+ Delete func(ctx context.Context, client *ClientT, meta ResourceMeta, input DeleteInput) (*DeleteResult, error)

+ Find func(ctx context.Context, client *ClientT, meta ResourceMeta, input FindInput) (*FindResult, error)

+ Get func(ctx context.Context, client *ClientT, meta ResourceMeta, input GetInput) (*GetResult, error)

+ List func(ctx context.Context, client *ClientT, meta ResourceMeta, input ListInput) (*ListResult, error)

+ Update func(ctx context.Context, client *ClientT, meta ResourceMeta, input UpdateInput) (*UpdateResult, error)

+ type ScaleHint struct

+ DefaultPageSize int

+ ExpectedCount int

+ Level ScaleLevel

+ type ScaleHintProvider interface

+ ScaleHint func() *ScaleHint

+ type ScaleLevel string

+ const ScaleFew

+ const ScaleMany

+ const ScaleModerate

+ type Schema struct

+ Properties map[string]SchemaProperty

+ Required []string

+ func (s *Schema) UnmarshalJSON(data []byte) error

+ func (s Schema) MarshalJSON() ([]byte, error)

+ func (s Schema) Ptr() *Schema

+ type SchemaProperty struct

+ Default any

+ Description string

+ Enum []string

+ Maximum *float64

+ Minimum *float64

+ Properties map[string]SchemaProperty

+ Required []string

+ Type SchemaType

+ type SchemaProvider interface

+ GetEditorSchemas func(ctx context.Context, client *ClientT) ([]EditorSchema, error)

+ type SchemaType string

+ const SchemaArray

+ const SchemaBoolean

+ const SchemaInteger

+ const SchemaNumber

+ const SchemaObject

+ const SchemaString

+ type ScopeMode int

+ const ScopeModeAll

+ const ScopeModeAutoDiscover

+ const ScopeModeExplicit

+ type ScopeProvider interface

+ ResolveScope func(ctx context.Context, client *ClientT) (ScopeMode, []string, error)

+ type Session struct

+ Connection *types.Connection

+ GlobalConfig *config.GlobalConfig

+ PluginConfig settings.Provider

+ RequestID string

+ RequesterID string

+ func SessionFromContext(ctx context.Context) *Session

+ type SyncPolicy int

+ const SyncNever

+ const SyncOnConnect

+ const SyncOnFirstQuery

+ type SyncPolicyDeclarer interface

+ SyncPolicy func() SyncPolicy

+ type TextSearchProvider interface

+ Search func(ctx context.Context, client *ClientT, meta ResourceMeta, query string, ...) (*FindResult, error)

+ type TypeProvider interface

+ GetFilterFields func(ctx context.Context, connectionID string, resourceKey string) ([]FilterField, error)

+ GetResourceCapabilities func(ctx context.Context, resourceKey string) (*ResourceCapabilities, error)

+ GetResourceDefinition func(ctx context.Context, id string) (ResourceDefinition, error)

+ GetResourceGroup func(ctx context.Context, id string) (ResourceGroup, error)

+ GetResourceGroups func(ctx context.Context, connectionID string) map[string]ResourceGroup

+ GetResourceSchema func(ctx context.Context, connectionID string, resourceKey string) (json.RawMessage, error)

+ GetResourceType func(ctx context.Context, id string) (*ResourceMeta, error)

+ GetResourceTypes func(ctx context.Context, connectionID string) map[string]ResourceMeta

+ HasResourceType func(ctx context.Context, id string) bool

+ type UpdateInput struct

+ ID string

+ Input json.RawMessage

+ Namespace string

+ type UpdateResult struct

+ Result json.RawMessage

+ Success bool

+ type WatchAddPayload struct

+ Connection string

+ Data json.RawMessage

+ ID string

+ Key string

+ Namespace string

+ PluginID string

+ type WatchConnectionSummary struct

+ ConnectionID string

+ ResourceCounts map[string]int

+ Resources map[string]WatchState

+ Scope *WatchScope

+ type WatchDeletePayload struct

+ Connection string

+ Data json.RawMessage

+ ID string

+ Key string

+ Namespace string

+ PluginID string

+ type WatchEventSink interface

+ OnAdd func(payload WatchAddPayload)

+ OnDelete func(payload WatchDeletePayload)

+ OnStateChange func(event WatchStateEvent)

+ OnUpdate func(payload WatchUpdatePayload)

+ type WatchProvider interface

+ EnsureResourceWatch func(ctx context.Context, connectionID string, resourceKey string) error

+ GetWatchState func(ctx context.Context, connectionID string) (*WatchConnectionSummary, error)

+ HasWatch func(ctx context.Context, connectionID string) bool

+ IsResourceWatchRunning func(ctx context.Context, connectionID string, resourceKey string) (bool, error)

+ ListenForEvents func(ctx context.Context, sink WatchEventSink) error

+ RestartResourceWatch func(ctx context.Context, connectionID string, resourceKey string) error

+ StartConnectionWatch func(ctx context.Context, connectionID string) error

+ StopConnectionWatch func(ctx context.Context, connectionID string) error

+ StopResourceWatch func(ctx context.Context, connectionID string, resourceKey string) error

+ type WatchScope struct

+ Partitions []string

+ func WatchScopeFromContext(ctx context.Context) *WatchScope

+ type WatchState int

+ const WatchStateError

+ const WatchStateFailed

+ const WatchStateForbidden

+ const WatchStateIdle

+ const WatchStateSkipped

+ const WatchStateStopped

+ const WatchStateSynced

+ const WatchStateSyncing

+ type WatchStateEvent struct

+ Connection string

+ Error error

+ ErrorCode string

+ Message string

+ PluginID string

+ ResourceCount int

+ ResourceKey string

+ State WatchState

+ type WatchUpdatePayload struct

+ Connection string

+ Data json.RawMessage

+ ID string

+ Key string

+ Namespace string

+ PluginID string

+ type Watcher interface

+ Watch func(ctx context.Context, client *ClientT, meta ResourceMeta, sink WatchEventSink) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL