files

README

Files

The Files plugin generates a value representing a path on disk, and can copy them to a specific directory.

Components

1. Builder
2. Registry

Related Plugins

1. Exec

Documentation

Overview

Package files contains a component for validating local files.

Index

• Variables
• type Builder
  • func (b *Builder) Build(ctx context.Context, ui terminal.UI, src *component.Source) (*Files, error)
  • func (b *Builder) BuildFunc() interface{}
  • func (b *Builder) Config() (interface{}, error)
  • func (b *Builder) Documentation() (*docs.Documentation, error)
• type BuilderConfig
• type Config
• type Files
  • func (*Files) Descriptor() ([]byte, []int)
  • func (x *Files) GetPath() string
  • func (*Files) ProtoMessage()
  • func (x *Files) ProtoReflect() protoreflect.Message
  • func (x *Files) Reset()
  • func (x *Files) String() string
• type Registry
  • func (r *Registry) Config() (interface{}, error)
  • func (r *Registry) Documentation() (*docs.Documentation, error)
  • func (r *Registry) Push(ctx context.Context, files *Files, ui terminal.UI) (*Files, error)
  • func (r *Registry) PushFunc() interface{}

Variables

var File_waypoint_builtin_files_plugin_proto protoreflect.FileDescriptor

var Options = []sdk.Option{
	sdk.WithComponents(&Builder{}, &Registry{}),
}

Options are the SDK options to use for instantiation for the Files plugin.

Types

type Builder

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

Builder validates the files in a directory or in the filesystem

func (*Builder) Build

func (b *Builder) Build(
	ctx context.Context,
	ui terminal.UI,
	src *component.Source,
) (*Files, error)

Build

func (*Builder) BuildFunc

func (b *Builder) BuildFunc() interface{}

BuildFunc implements component.Builder

func (*Builder) Config

func (b *Builder) Config() (interface{}, error)

Config implements Configurable

func (*Builder) Documentation

func (b *Builder) Documentation() (*docs.Documentation, error)

type BuilderConfig

type BuilderConfig struct{}

BuilderConfig is the configuration structure for the builder.

type Config

type Config struct {
	// Path is the path that files are stored in
	Path string `hcl:"path,attr"`
}

Config is the configuration structure for the registry.

type Files

type Files struct {
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*Files) Descriptor

func (*Files) Descriptor() ([]byte, []int)

Deprecated: Use Files.ProtoReflect.Descriptor instead.

func (*Files) GetPath

func (x *Files) GetPath() string

func (*Files) ProtoMessage

func (*Files) ProtoMessage()

func (*Files) ProtoReflect

func (x *Files) ProtoReflect() protoreflect.Message

func (*Files) Reset

func (x *Files) Reset()

func (*Files) String

func (x *Files) String() string

type Registry

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

Registry represents access to a Files registry.

func (*Registry) Config

func (r *Registry) Config() (interface{}, error)

Config implements Configurable

func (*Registry) Documentation

func (r *Registry) Documentation() (*docs.Documentation, error)

func (*Registry) Push

func (r *Registry) Push(
	ctx context.Context,
	files *Files,
	ui terminal.UI,
) (*Files, error)

Push pushes an image to the registry.

func (*Registry) PushFunc

func (r *Registry) PushFunc() interface{}

PushFunc implements component.Registry