asyncapi

Documentation

Index

• Constants
• type Annotation
• type AssetPayload
• type AssetType
• type EventStreamClient
• type LevelLogger
  • func (l LevelLogger) Debugf(s string, params ...any)
  • func (l LevelLogger) Errorf(s string, params ...any)
  • func (l LevelLogger) Infof(s string, params ...any)
• type Logger
• type NullVulcan
  • func (v *NullVulcan) DeleteAsset(asset AssetPayload) error
  • func (v *NullVulcan) PushAsset(asset AssetPayload) error
• type Team
• type Vulcan
  • func NewVulcan(client EventStreamClient, log Logger) *Vulcan
  • func (v *Vulcan) DeleteAsset(asset AssetPayload) error
  • func (v *Vulcan) PushAsset(asset AssetPayload) error

Constants

const (
	AssetTypeIp            AssetType = "IP"
	AssetTypeDomainName              = "DomainName"
	AssetTypeHostname                = "Hostname"
	AssetTypeAwsAccount              = "AWSAccount"
	AssetTypeIpRange                 = "IPRange"
	AssetTypeDockerImage             = "DockerImage"
	AssetTypeWebAddress              = "WebAddress"
	AssetTypeGitRepository           = "GitRepository"
)

const AssetsEntityName = "assets"

AssetsEntityName defines the key for the assets entity used by an EventStreamClient to determine the topic where the assets are send.

Types

type Annotation

type Annotation struct {
	Key   string
	Value string
}

Annotation represents a Annotation model.

type AssetPayload

type AssetPayload struct {
	Id          string
	Team        *Team
	Alias       string
	Rolfp       string
	Scannable   bool
	AssetType   *AssetType
	Identifier  string
	Annotations []*Annotation
}

AssetPayload represents a AssetPayload model.

type AssetType

type AssetType string

AssetType represents an enum of string.

type EventStreamClient

type EventStreamClient interface {
	Push(entity string, id string, payload []byte) error
}

EventStreamClient represent a client of an event stream system, like Kafka or AWS FIFO SQS queues.

type LevelLogger

type LevelLogger struct {
	gokitlog.Logger
}

LevelLogger implements the logger used by the Vulcan async API using an underlaying go-kit logger.

func (LevelLogger) Debugf

func (l LevelLogger) Debugf(s string, params ...any)

Debugf logs a debug message.

func (LevelLogger) Errorf

func (l LevelLogger) Errorf(s string, params ...any)

Errorf logs an error message.

func (LevelLogger) Infof

func (l LevelLogger) Infof(s string, params ...any)

Infof logs an information message.

type Logger

type Logger interface {
	Errorf(string, ...any)
	Infof(string, ...any)
	Debugf(string, ...any)
}

Logger defines the required methods to log info by the Vulcan async server.

type NullVulcan

type NullVulcan struct {
}

NullVulcan implements an Async Vulcan API interface that does not send the events to any EventStreamClient. It's intended to be used when the async API is disabled but other components still need to fullfill a dependency with the Vulcan Async Server.

func (*NullVulcan) DeleteAsset

func (v *NullVulcan) DeleteAsset(asset AssetPayload) error

DeleteAsset acepts an event indicating that an asset has been deleted and just ignores it.

func (*NullVulcan) PushAsset

func (v *NullVulcan) PushAsset(asset AssetPayload) error

PushAsset acepts an event indicating that an asset has been modified or created and just ignores it.

type Team

type Team struct {
	Id          string
	Name        string
	Description string
	Tag         string
}

Team represents a Team model.

type Vulcan

type Vulcan struct {
	// contains filtered or unexported fields
}

Vulcan implements the asynchorus API of Vulcan.

func NewVulcan

func NewVulcan(client EventStreamClient, log Logger) *Vulcan

NewVulcan returns a Vulcan async server that uses the given EventStreamClient and Logger.

func (*Vulcan) DeleteAsset

func (v *Vulcan) DeleteAsset(asset AssetPayload) error

DeleteAsset publishes an event to the underlying EventStreamClient indicating that an asset has been deleted.

func (*Vulcan) PushAsset

func (v *Vulcan) PushAsset(asset AssetPayload) error

PushAsset publishes the state of an asset in the current point of time to the underlying EventStreamClient.