builtin

Documentation

Overview

Package builtin contains a service type that can be used to capture data from a robot's components.

Index

• func NewBuiltIn(ctx context.Context, deps resource.Dependencies, conf resource.Config, ...) (datamanager.Service, error)
• type Config
  • func (c *Config) Validate(path string) ([]string, error)

Functions

func NewBuiltIn

func NewBuiltIn(
	ctx context.Context,
	deps resource.Dependencies,
	conf resource.Config,
	logger logging.Logger,
) (datamanager.Service, error)

NewBuiltIn returns a new data manager service for the given robot.

Types

type Config

type Config struct {
	CaptureDir                  string   `json:"capture_dir"`
	AdditionalSyncPaths         []string `json:"additional_sync_paths"`
	SyncIntervalMins            float64  `json:"sync_interval_mins"`
	CaptureDisabled             bool     `json:"capture_disabled"`
	ScheduledSyncDisabled       bool     `json:"sync_disabled"`
	Tags                        []string `json:"tags"`
	FileLastModifiedMillis      int      `json:"file_last_modified_millis"`
	SelectiveSyncerName         string   `json:"selective_syncer_name"`
	MaximumNumSyncThreads       int      `json:"maximum_num_sync_threads"`
	DeleteEveryNthWhenDiskFull  int      `json:"delete_every_nth_when_disk_full"`
	MaximumCaptureFileSizeBytes int64    `json:"maximum_capture_file_size_bytes"`
}

Config describes how to configure the service.

func (*Config) Validate

func (c *Config) Validate(path string) ([]string, error)

Validate returns components which will be depended upon weakly due to the above matcher.