api

type ActionResult struct {
	UnitID  uuid.UUID `description:"UUID of the Unit on which the action is performed"`
	SpaceID uuid.UUID `description:"UUID of the Space of the Unit on which the action is performed"`
	// OrganizationID comes from the worker
	// QueuedOperationID links this result back to the original operation request.
	QueuedOperationID uuid.UUID `description:"UUID of the operation corresponding to the action request"`
	ActionResultBaseMeta
	Data []byte `` /* 130-byte string literal not displayed */
	// ErrorMessages contains warning or error messages to surface to the user.
	ErrorMessages []string `json:",omitempty" description:"Warning or error messages to surface to the user"`
}

type ActionResultBaseMeta struct {
	RevisionNum  int64
	Action       ActionType       `bun:",notnull" swaggertype:"string"`
	Result       ActionResultType `bun:",notnull,default:'None'" swaggertype:"string"`
	Status       ActionStatusType `bun:",notnull,default:'None'" swaggertype:"string"`
	Message      string           `bun:"type:text"`
	StartedAt    time.Time        `json:",omitempty" bun:"type:timestamptz"`
	TerminatedAt *time.Time       `json:",omitempty" bun:"type:timestamptz"`
}

type ActionResultType string

type ActionStatusType string

type ActionType string

type EventLogEntry struct {
	// CursorID is this event's monotonic position in the log. A consumer that
	// has handled through here resumes after it.
	CursorID int64 `description:"Monotonic cursor of this event in the log."`

	// EventType is the fact's type, for example "release.published".
	EventType string `description:"The event type."`

	// SubjectEntityType is the entity type the event is about, for example
	// "Unit" or "Release".
	SubjectEntityType string `description:"Entity type the event is about."`

	// SubjectEntityID is the id of the entity the event is about.
	SubjectEntityID uuid.UUID `description:"Id of the entity the event is about."`

	// SpaceID is the event's Space scope, if any (UUID string).
	SpaceID string `json:",omitempty" description:"Space scope, if any."`

	// TargetID is the event's Target scope, if any (UUID string).
	TargetID string `json:",omitempty" description:"Target scope, if any."`

	// Payload is the event-type-specific data, opaque to the transport.
	Payload json.RawMessage `json:",omitempty" description:"Event-type-specific payload."`

	// CreatedAt is when the event was emitted.
	CreatedAt time.Time `description:"When the event was emitted."`

	// SubscriptionName is the subscription this event was delivered for.
	SubscriptionName string `description:"The subscription this event was delivered for."`
}

type EventMessage struct {
	Event string
	Data  interface{}
}

type EventSubscription struct {
	// Name is the stable per-worker subscription name. The server keys the
	// delivery cursor on it, so it must be identical across reconnects for
	// resume to work. A worker with a single subscription uses a constant.
	Name string `` /* 136-byte string literal not displayed */

	// EventTypes are the event types to receive, for example
	// "release.published". Empty means every type.
	EventTypes []string `json:",omitempty" description:"Event types to receive, e.g. \"release.published\". Empty means every type."`

	// SpaceID optionally scopes delivery to one Space (UUID string). Empty means
	// any Space.
	SpaceID string `json:",omitempty" description:"Optional Space scoping filter (UUID). Empty means any Space."`

	// TargetID optionally scopes delivery to one Target (UUID string). Empty
	// means any Target.
	TargetID string `json:",omitempty" description:"Optional Target scoping filter (UUID). Empty means any Target."`

	// FromCursor optionally overrides where delivery begins. When set, delivery
	// starts after this cursor; when unset, delivery resumes from the
	// server-stored bookmark, or from the log tail on a first-ever connect.
	FromCursor *int64 `` /* 173-byte string literal not displayed */
}

type FunctionWorkerEventRequest struct {
	// Action defines the operation the function worker should perform.
	Action ActionType `description:"Action defines the operation the function worker should perform."`

	// Payload contains the data required for the action, primarily the function invocation details.
	Payload FunctionWorkerPayload `description:"Payload contains the data required for the action, primarily the function invocation details."`
}

type FunctionWorkerInfo struct {
	ToolchainTypes     []workerapi.ToolchainType                                        `description:"Supported ToolchainTypes"`
	SupportedFunctions map[workerapi.ToolchainType]map[string]funcApi.FunctionSignature `description:"Signatures of supported functions by ToolchainType"`
}

type FunctionWorkerPayload struct {
	// QueuedOperationID is the identifier of the original queued operation request.
	QueuedOperationID uuid.UUID `description:"QueuedOperationID is the identifier of the original queued operation request."`

	// InvocationRequest encapsulates the full request for invoking one or more functions,
	// including context, configuration data, function calls, and execution options.
	// This structure is defined in the functions plugin's API package.
	InvocationRequest funcApi.FunctionInvocationRequest `` /* 175-byte string literal not displayed */
}

type ProviderType string

type ResourceInfo struct {
	ResourceName string `` /* 206-byte string literal not displayed */
	ResourceType string `` /* 214-byte string literal not displayed */
}

type WorkerEventRequest struct {
	Action  ActionType `description:"The action requested"`
	Payload WorkerPayload
}

type WorkerInfo struct {
	// IsServerWorker says that no worker process is expected to connect: the worker is an
	// identity only, and runs no functions. It is fixed when the worker is created.
	IsServerWorker     bool               `` /* 215-byte string literal not displayed */
	FunctionWorkerInfo FunctionWorkerInfo `description:"FunctionWorker capabilities"`
}

type WorkerPayload struct {
	Timestamp int64 `description:"Time the action was requested"`
}