Documentation ¶
Index ¶
- Constants
- type Artefact
- type ControllerKey
- type ControllerPayload
- type CronJob
- type CronJobKey
- type CronJobPayload
- type CronJobState
- type Deployment
- type DeploymentKey
- type DeploymentPayload
- type HostPortMixin
- type KeyPayload
- type KeyType
- func (d KeyType[T, TP]) Equal(other KeyType[T, TP]) bool
- func (d KeyType[T, TP]) IsZero() bool
- func (d KeyType[T, TP]) Kind() string
- func (d KeyType[T, TP]) MarshalText() ([]byte, error)
- func (d *KeyType[T, TP]) Scan(src any) error
- func (d KeyType[T, TP]) String() string
- func (d *KeyType[T, TP]) UnmarshalText(bytes []byte) error
- func (d KeyType[T, TP]) Value() (driver.Value, error)
- type Labels
- type Origin
- type RequestKey
- type RequestKeyPayload
- type RunnerKey
- type RunnerPayload
- type SubscriberKey
- type SubscriberPayload
- type Subscription
- type SubscriptionKey
- type SubscriptionPayload
- type TopicEventKey
- type TopicEventPayload
- type TopicKey
- type TopicPayload
Constants ¶
View Source
const ( CronJobStateIdle = "idle" CronJobStateExecuting = "executing" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ControllerKey ¶
type ControllerKey = KeyType[ControllerPayload, *ControllerPayload]
func NewControllerKey ¶
func NewControllerKey(hostname, port string) ControllerKey
func NewLocalControllerKey ¶ added in v0.148.0
func NewLocalControllerKey(suffix int) ControllerKey
func ParseControllerKey ¶
func ParseControllerKey(key string) (ControllerKey, error)
type ControllerPayload ¶ added in v0.165.1
type ControllerPayload struct {
HostPortMixin
}
func (*ControllerPayload) Kind ¶ added in v0.165.1
func (c *ControllerPayload) Kind() string
type CronJob ¶ added in v0.170.0
type CronJob struct { Key CronJobKey DeploymentKey DeploymentKey Verb schema.Ref Schedule string StartTime time.Time NextExecution time.Time State CronJobState }
type CronJobKey ¶ added in v0.167.0
type CronJobKey = KeyType[CronJobPayload, *CronJobPayload]
func NewCronJobKey ¶ added in v0.167.0
func NewCronJobKey(module, verb string) CronJobKey
func ParseCronJobKey ¶ added in v0.167.0
func ParseCronJobKey(key string) (CronJobKey, error)
type CronJobPayload ¶ added in v0.167.0
func (*CronJobPayload) Kind ¶ added in v0.167.0
func (d *CronJobPayload) Kind() string
func (*CronJobPayload) Parse ¶ added in v0.167.0
func (d *CronJobPayload) Parse(parts []string) error
func (*CronJobPayload) RandomBytes ¶ added in v0.167.0
func (d *CronJobPayload) RandomBytes() int
func (*CronJobPayload) String ¶ added in v0.167.0
func (d *CronJobPayload) String() string
type CronJobState ¶ added in v0.170.0
type CronJobState string
type Deployment ¶
type Deployment struct { Module string Language string Key DeploymentKey Schema *schema.Module Artefacts []*Artefact }
func (*Deployment) Close ¶
func (d *Deployment) Close() error
Close is a convenience function to close all artefacts.
type DeploymentKey ¶ added in v0.151.0
type DeploymentKey = KeyType[DeploymentPayload, *DeploymentPayload]
func NewDeploymentKey ¶ added in v0.151.0
func NewDeploymentKey(module string) DeploymentKey
func ParseDeploymentKey ¶ added in v0.151.0
func ParseDeploymentKey(key string) (DeploymentKey, error)
type DeploymentPayload ¶ added in v0.165.1
type DeploymentPayload struct {
Module string
}
func (*DeploymentPayload) Kind ¶ added in v0.165.1
func (d *DeploymentPayload) Kind() string
func (*DeploymentPayload) Parse ¶ added in v0.165.1
func (d *DeploymentPayload) Parse(parts []string) error
func (*DeploymentPayload) RandomBytes ¶ added in v0.165.1
func (d *DeploymentPayload) RandomBytes() int
func (*DeploymentPayload) String ¶ added in v0.165.1
func (d *DeploymentPayload) String() string
type HostPortMixin ¶ added in v0.165.1
HostPortMixin is a mixin for keys that have an (optional) hostname and a port.
func (*HostPortMixin) Parse ¶ added in v0.165.1
func (h *HostPortMixin) Parse(parts []string) error
func (*HostPortMixin) RandomBytes ¶ added in v0.165.1
func (h *HostPortMixin) RandomBytes() int
func (*HostPortMixin) String ¶ added in v0.165.1
func (h *HostPortMixin) String() string
type KeyPayload ¶ added in v0.165.1
type KeyPayload interface { Kind() string String() string // Parse the hyphen-separated parts of the payload Parse(parts []string) error // RandomBytes determines the number of random bytes the key should include. RandomBytes() int }
KeyPayload is an interface that all key payloads must implement.
type KeyType ¶ added in v0.165.1
KeyType is a helper type to avoid having to write a bunch of boilerplate.
func (KeyType[T, TP]) MarshalText ¶ added in v0.165.1
func (*KeyType[T, TP]) UnmarshalText ¶ added in v0.165.1
type RequestKey ¶ added in v0.165.1
type RequestKey = KeyType[RequestKeyPayload, *RequestKeyPayload]
A RequestKey represents an inbound request into the cluster.
func NewRequestKey ¶ added in v0.165.1
func NewRequestKey(origin Origin, key string) RequestKey
func ParseRequestKey ¶ added in v0.165.1
func ParseRequestKey(name string) (RequestKey, error)
type RequestKeyPayload ¶ added in v0.165.1
func (*RequestKeyPayload) Kind ¶ added in v0.165.1
func (r *RequestKeyPayload) Kind() string
func (*RequestKeyPayload) Parse ¶ added in v0.165.1
func (r *RequestKeyPayload) Parse(parts []string) error
func (*RequestKeyPayload) RandomBytes ¶ added in v0.165.1
func (r *RequestKeyPayload) RandomBytes() int
func (*RequestKeyPayload) String ¶ added in v0.165.1
func (r *RequestKeyPayload) String() string
type RunnerKey ¶
type RunnerKey = KeyType[RunnerPayload, *RunnerPayload]
func NewLocalRunnerKey ¶ added in v0.148.0
func NewRunnerKey ¶
func ParseRunnerKey ¶
type RunnerPayload ¶ added in v0.165.1
type RunnerPayload struct {
HostPortMixin
}
func (*RunnerPayload) Kind ¶ added in v0.165.1
func (r *RunnerPayload) Kind() string
type SubscriberKey ¶ added in v0.233.0
type SubscriberKey = KeyType[SubscriberPayload, *SubscriberPayload]
func NewSubscriberKey ¶ added in v0.233.0
func NewSubscriberKey(module, subscription, sink string) SubscriberKey
func ParseSubscriberKey ¶ added in v0.233.0
func ParseSubscriberKey(key string) (SubscriberKey, error)
type SubscriberPayload ¶ added in v0.233.0
func (*SubscriberPayload) Kind ¶ added in v0.233.0
func (s *SubscriberPayload) Kind() string
func (*SubscriberPayload) Parse ¶ added in v0.233.0
func (s *SubscriberPayload) Parse(parts []string) error
func (*SubscriberPayload) RandomBytes ¶ added in v0.233.0
func (s *SubscriberPayload) RandomBytes() int
func (*SubscriberPayload) String ¶ added in v0.233.0
func (s *SubscriberPayload) String() string
type Subscription ¶ added in v0.241.0
type Subscription struct { Name string Key SubscriptionKey Topic TopicKey Cursor optional.Option[TopicEventKey] }
type SubscriptionKey ¶ added in v0.233.0
type SubscriptionKey = KeyType[SubscriptionPayload, *SubscriptionPayload]
func NewSubscriptionKey ¶ added in v0.233.0
func NewSubscriptionKey(module, name string) SubscriptionKey
func ParseSubscriptionKey ¶ added in v0.233.0
func ParseSubscriptionKey(key string) (SubscriptionKey, error)
type SubscriptionPayload ¶ added in v0.233.0
func (*SubscriptionPayload) Kind ¶ added in v0.233.0
func (s *SubscriptionPayload) Kind() string
func (*SubscriptionPayload) Parse ¶ added in v0.233.0
func (s *SubscriptionPayload) Parse(parts []string) error
func (*SubscriptionPayload) RandomBytes ¶ added in v0.233.0
func (s *SubscriptionPayload) RandomBytes() int
func (*SubscriptionPayload) String ¶ added in v0.233.0
func (s *SubscriptionPayload) String() string
type TopicEventKey ¶ added in v0.239.0
type TopicEventKey = KeyType[TopicEventPayload, *TopicEventPayload]
func NewTopicEventKey ¶ added in v0.239.0
func NewTopicEventKey(module, topic string) TopicEventKey
func ParseTopicEventKey ¶ added in v0.239.0
func ParseTopicEventKey(key string) (TopicEventKey, error)
type TopicEventPayload ¶ added in v0.239.0
func (*TopicEventPayload) Kind ¶ added in v0.239.0
func (t *TopicEventPayload) Kind() string
func (*TopicEventPayload) Parse ¶ added in v0.239.0
func (t *TopicEventPayload) Parse(parts []string) error
func (*TopicEventPayload) RandomBytes ¶ added in v0.239.0
func (t *TopicEventPayload) RandomBytes() int
func (*TopicEventPayload) String ¶ added in v0.239.0
func (t *TopicEventPayload) String() string
type TopicKey ¶ added in v0.233.0
type TopicKey = KeyType[TopicPayload, *TopicPayload]
func NewTopicKey ¶ added in v0.233.0
func ParseTopicKey ¶ added in v0.233.0
type TopicPayload ¶ added in v0.233.0
func (*TopicPayload) Kind ¶ added in v0.233.0
func (t *TopicPayload) Kind() string
func (*TopicPayload) Parse ¶ added in v0.233.0
func (t *TopicPayload) Parse(parts []string) error
func (*TopicPayload) RandomBytes ¶ added in v0.233.0
func (t *TopicPayload) RandomBytes() int
func (*TopicPayload) String ¶ added in v0.233.0
func (t *TopicPayload) String() string
Click to show internal directories.
Click to hide internal directories.