ingest

Documentation

Index

• type APIResponse
• type Bulletin
• type BulletinBoard
• type BulletinProcessor
• type Ingest
  • func (ingest *Ingest) GetDescription() string
  • func (ingest *Ingest) GetFlagSet() *flag.FlagSet
  • func (ingest *Ingest) GetHelpFlag() *bool
  • func (ingest *Ingest) GetName() string
  • func (ingest *Ingest) GetSubCommands() []cli.Command
  • func (ingest *Ingest) Init(helpFlagName string, helpFlagDescription string)
  • func (ingest *Ingest) Process()

Types

type APIResponse

type APIResponse struct {
	BulletinBoard BulletinBoard `json:"bulletinBoard"`
}

APIResponse is the root JSON object in the bulletin board response from NiFi

type Bulletin

type Bulletin struct {
	ID         int64  `json:"id"`
	Category   string `json:"category"`
	SourceName string `json:"sourceName"`
	Level      string `json:"level"`
	Message    string `json:"message"`
	Timestamp  string `json:"timestamp"`
}

Bulletin does is part of the JSON gotten from the bulletin board respones from NiFi and is considered the "inner" object for a single bulletin. It contains extra info not contained in the bulletin's root object

type BulletinBoard

type BulletinBoard struct {
	Bulletins []BulletinProcessor `json:"bulletins"`
	Generated string              `json:"generated"`
}

BulletinBoard is part of the JSON gotten from the bulletin board respones from NiFi and contains a list of bulletins and a time for when the list was generated

type BulletinProcessor

type BulletinProcessor struct {
	ID       int64    `json:"id"`
	GroupID  string   `json:"groupId"`
	SourceID string   `json:"sourceId"`
	CanRead  bool     `json:"canRead"`
	Bulletin Bulletin `json:"bulletin"`
}

BulletinProcessor is part of the JSON gotten from the bulletin board respones from NiFi and is considered the root object for a single bulletin

type Ingest

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

Ingest holds data for the NiFi flow ingest sub-command

func (*Ingest) GetDescription

func (ingest *Ingest) GetDescription() string

GetDescription returns the description for the ingest sub-command

func (*Ingest) GetFlagSet

func (ingest *Ingest) GetFlagSet() *flag.FlagSet

GetFlagSet returns the flag.FlagSet associated with the ingest sub-command

func (*Ingest) GetHelpFlag

func (ingest *Ingest) GetHelpFlag() *bool

GetHelpFlag returns the value for the help flag in the ingest sub-command. TRUE means the user provided the flag and wants to print the sub-command's help message

func (*Ingest) GetName

func (ingest *Ingest) GetName() string

GetName returns the name associated with this sub-command

func (*Ingest) GetSubCommands

func (ingest *Ingest) GetSubCommands() []cli.Command

GetSubCommands returns a list of sub-commands under the ingest sub-command

func (*Ingest) Init

func (ingest *Ingest) Init(helpFlagName string, helpFlagDescription string)

Init initializes items in an Ingest struct

func (*Ingest) Process

func (ingest *Ingest) Process()

Process initializes ingesting bulletins from the flow bulletin board endpoint