subscription

Documentation

Index

• Constants
• Variables
• func NewSubscription(ctx context.Context, in *dao.Entity, dispatcher dispatch.Dispatcher, ...) (stateM state.Machiner, err error)
• type Base
  • func (s *Base) Validate() error

Constants

const (
	// subscription mode enum.
	SubscriptionModeRealtime = "REALTIME"
	SubscriptionModePeriod   = "PERIOD"
	SubscriptionModeChanged  = "ONCHANGED"
	SubscriptionModeUndefine = "UNDEFINE"

	// subscription required fileds.
	SubscriptionFieldMode       = "mode"
	SubscriptionFieldFilter     = "filter"
	SubscriptionFieldTopic      = "topic"
	SubscriptionFieldPubsubName = "pubsub_name"
)

Variables

var (
	ErrSubscriptionInvalid = errors.New("params invalid")
)

Functions

func NewSubscription

func NewSubscription(
	ctx context.Context,
	in *dao.Entity,
	dispatcher dispatch.Dispatcher,
	rs types.ResourceManager) (stateM state.Machiner, err error)

NewSubscription returns a subscription.

Types

type Base

type Base struct {
	Mode       string `json:"mode" mapstructure:"mode"`
	Filter     string `json:"filter" mapstructure:"filter"`
	Topic      string `json:"topic" mapstructure:"topic"`
	PubsubName string `json:"pubsub_name" mapstructure:"pubsub_name"`
}

Base subscription basic information.

func (*Base) Validate

func (s *Base) Validate() error

checkSubscription returns subscription status.