cli

type BlockUserCmd ¶ added in v0.27.0

type BlockUserCmd struct {
	UserArgs

	Value bool `help:"Block status."`
}

func (c *BlockUserCmd) Run() error

type ClearSchedulerCmd ¶ added in v0.24.0

type ClearSchedulerCmd struct{}

ClearSchedulerCmd is a cli command for clearing the scheduled jobs queue.

func (c *ClearSchedulerCmd) Run() error

type CreateIndexCmd ¶ added in v0.87.0

type CreateIndexCmd struct {
	schema.IndicesOptions
}

func (r *CreateIndexCmd) Run(opts *CreateIndexCmd) error

type DataCmd ¶

type DataCmd struct {
	Delete DeleteCmd `cmd:"" help:"Delete objects"`
}

DataCmd defines the `data` command, which contains commands for manipulating data.

type DeleteCmd ¶

type DeleteCmd struct {
	ObjectID string `arg:"" help:"ID of object to delete"`
}

func (c *DeleteCmd) Run(opts *DeleteCmd) error

type DeleteJobSchedulerCmd ¶ added in v0.102.0

type DeleteJobSchedulerCmd struct {
	ID    string `arg:"" help:"The job ID."`
	Group string `arg:"" help:"The job group (optional)." optional:""`
}

DeleteJobSchedulerCmd is a cli command for deleting a scheduled job.

func (c *DeleteJobSchedulerCmd) Run() error

type DeleteUserCmd ¶ added in v0.27.0

type DeleteUserCmd struct {
	UserArgs
}

func (c *DeleteUserCmd) Run() error

type ElasticCmd ¶ added in v0.87.0

type ElasticCmd struct {
	Indices IndicesCmd `cmd:"" help:"Perform operations on indices."`
	ILM     ILMCmd     `cmd:"" help:"Perform ILM operations."`
}

ElasticCmd contains commands for manipulating Elasticsearch.

type FeedCmd ¶ added in v0.71.0

type FeedCmd struct {
	Fetch        FetchFeedCmd        `cmd:"" help:"fetch a feed (by either URL or ID)"`
	ResetUpdates ResetFeedUpdatesCmd `cmd:"" help:"reset the feed updates job"`
	Update       UpdateFeedCmd       `cmd:"" help:"update the feed"`
}

FeedCmd contains subcommands for interacting with feeds.

type FetchFeedCmd ¶ added in v0.71.0

type FetchFeedCmd struct {
	FeedID   models.FeedID `help:"ID of feed"`
	FeedURL  string        `help:"URL of feed"`
	Validate bool          `help:"validate the feed" default:"false"`
}

FetchFeedCmd is a command that will fetch a feed, by either URL or its Feed ID.

func (c *FetchFeedCmd) Run() error

type ILMCmd ¶ added in v0.87.0

type ILMCmd struct {
	Update UpdateILMPoliciesCmd `cmd:"update" help:"Update ILM policies."`
}

type IndicesCmd ¶ added in v0.87.0

type IndicesCmd struct {
	Update  UpdateIndexSchemaCmd `cmd:"" help:"Update schema(s)"`
	Migrate MigrateIndexCmd      `cmd:"" help:"Migrate data"`
	Create  CreateIndexCmd       `cmd:"" help:"Create indices"`
}

IndicesCmd contains commands for manipulating Elasticsearch indices.

type InitSchedulerCmd ¶ added in v0.24.0

type InitSchedulerCmd struct{}

InitSchedulerCmd is a cli command to init the scheduler backend (for a new installation), without starting the scheduler.

func (c *InitSchedulerCmd) Run() error

type ListJobsSchedulerCmd ¶ added in v0.102.0

type ListJobsSchedulerCmd struct{}

ListJobsSchedulerCmd is a cli command for listing all scheduled jobs.

func (c *ListJobsSchedulerCmd) Run() error

type ListUserCmd ¶ added in v0.165.0

type ListUserCmd struct {
	UserArgs
}

func (c *ListUserCmd) Run() error

type MigrateIndexCmd ¶ added in v0.87.0

type MigrateIndexCmd struct {
	schema.IndicesOptions
}

func (r *MigrateIndexCmd) Run(opts *MigrateIndexCmd) error

type ResetFeedUpdatesCmd ¶ added in v0.102.0

type ResetFeedUpdatesCmd struct {
	FeedID models.FeedID `help:"ID of feed"`
}

ResetFeedUpdatesCmd is a CLI command to reset the updates for a feed. It will reset the last_fetched timestamp on the feed and delete any scheduled job for feed updates.

func (c *ResetFeedUpdatesCmd) Run() error

type RunSchedulerCmd ¶

type RunSchedulerCmd struct{}

RunSchedulerCmd is a cli command for running the scheduler component.

func (c *RunSchedulerCmd) Run() error

type SchedulerCmd ¶

type SchedulerCmd struct {
	Run       RunSchedulerCmd       `cmd:"" help:"Run scheduler."`
	Clear     ClearSchedulerCmd     `cmd:"" help:"Clear all jobs."`
	Init      InitSchedulerCmd      `cmd:"" help:"Initialise the scheduler/queue."`
	ListJobs  ListJobsSchedulerCmd  `cmd:"" help:"List all jobs."`
	DeleteJob DeleteJobSchedulerCmd `cmd:"" help:"Job related commands."`
}

SchedulerCmd defines the `scheduler` command, for performing job scheduler related actions.

type ServeCmd ¶

type ServeCmd struct{}

ServeCmd defines the `server` command for running the server.

func (r *ServeCmd) Run() error

type UpdateFeedCmd ¶ added in v0.210.0

type UpdateFeedCmd struct {
	FeedID                models.FeedID `help:"ID of feed"`
	Interval              string        `help:"update the interval to the given value"`
	FetchItemDescriptions bool          `help:"always fetch item descriptions when updating"`
}

UpdateFeedCmd performs updates on a feed.

func (c *UpdateFeedCmd) Run() error

type UpdateILMPoliciesCmd ¶ added in v0.87.0

type UpdateILMPoliciesCmd struct {
	schema.ILMOptions
}

func (r *UpdateILMPoliciesCmd) Run(opts *UpdateILMPoliciesCmd) error

type UpdateIndexSchemaCmd ¶ added in v0.87.0

type UpdateIndexSchemaCmd struct {
	schema.IndicesOptions
}

func (r *UpdateIndexSchemaCmd) Run(opts *UpdateIndexSchemaCmd) error

type UserArgs ¶ added in v0.92.0

type UserArgs struct {
	UserID models.UserID `arg:"" help:"ID of object to delete"`
}

type UserCmd ¶ added in v0.27.0

type UserCmd struct {
	Delete DeleteUserCmd `cmd:"" help:"Delete user"`
	Block  BlockUserCmd  `cmd:"" help:"Block user"`
	List   ListUserCmd   `cmd:"" help:"List user details"`
}

UserCmd contains sub commands for managing users.