filetransfer

Documentation

Index

• Variables
• type CompletedConfig
  • func (c CompletedConfig) New(ctx context.Context) (*FileTransfer, error)
• type Config
  • func NewConfig(options ...ConfigOption) *Config
  • func (o *Config) ApplyOptions(options ...ConfigOption) *Config
  • func (c *Config) Complete() CompletedConfig
• type ConfigOption
  • func WithViper(v *viper.Viper) ConfigOption
• type ConfigOptionFunc
• type EmptyConfigOption
• type EmptyFileTransferOption
• type FileTransfer
  • func NewFileTransfer(opts ...FileTransferOption) *FileTransfer
  • func (o *FileTransfer) ApplyOptions(options ...FileTransferOption) *FileTransfer
  • func (f *FileTransfer) Download(ctx context.Context, downloadUrl string) (data []byte, err error)
• type FileTransferOption
  • func WithDownloadTimeout(downloadTimeout time.Duration) FileTransferOption
• type FileTransferOptionFunc
• type FileTransferOptions
• type Ft
  • func (*Ft) Descriptor() ([]byte, []int)
  • func (x *Ft) GetDownloadTimeout() *duration.Duration
  • func (x *Ft) GetEnabled() bool
  • func (x *Ft) GetProxies() []*Ft_Proxy
  • func (x *Ft) GetUploadTimeout() *duration.Duration
  • func (*Ft) ProtoMessage()
  • func (x *Ft) ProtoReflect() protoreflect.Message
  • func (x *Ft) Reset()
  • func (x *Ft) String() string
• type Ft_Proxy
  • func (*Ft_Proxy) Descriptor() ([]byte, []int)
  • func (x *Ft_Proxy) GetAddr() string
  • func (*Ft_Proxy) ProtoMessage()
  • func (x *Ft_Proxy) ProtoReflect() protoreflect.Message
  • func (x *Ft_Proxy) Reset()
  • func (x *Ft_Proxy) String() string

Variables

var File_pkg_file_transfer_ft_proto protoreflect.FileDescriptor

Types

type CompletedConfig

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

func (CompletedConfig) New

func (c CompletedConfig) New(ctx context.Context) (*FileTransfer, error)

type Config

type Config struct {
	Proto Ft
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(options ...ConfigOption) *Config

func (*Config) ApplyOptions

func (o *Config) ApplyOptions(options ...ConfigOption) *Config

func (*Config) Complete

func (c *Config) Complete() CompletedConfig

Complete set default ServerRunOptions.

type ConfigOption

type ConfigOption interface {
	// contains filtered or unexported methods
}

A ConfigOption sets options.

func WithViper

func WithViper(v *viper.Viper) ConfigOption

type ConfigOptionFunc

type ConfigOptionFunc func(*Config)

ConfigOptionFunc wraps a function that modifies Client into an implementation of the ConfigOption interface.

type EmptyConfigOption

type EmptyConfigOption struct{}

EmptyConfigOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type EmptyFileTransferOption

type EmptyFileTransferOption struct{}

EmptyFileTransferUrlOption does not alter the FileTransferuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type FileTransfer

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

func NewFileTransfer

func NewFileTransfer(opts ...FileTransferOption) *FileTransfer

func (*FileTransfer) ApplyOptions

func (o *FileTransfer) ApplyOptions(options ...FileTransferOption) *FileTransfer

func (*FileTransfer) Download

func (f *FileTransfer) Download(ctx context.Context, downloadUrl string) (data []byte, err error)

type FileTransferOption

type FileTransferOption interface {
	// contains filtered or unexported methods
}

A FileTransferOption sets options.

func WithDownloadTimeout

func WithDownloadTimeout(downloadTimeout time.Duration) FileTransferOption

type FileTransferOptionFunc

type FileTransferOptionFunc func(*FileTransfer)

FileTransferOptionFunc wraps a function that modifies FileTransfer into an implementation of the FileTransferOption interface.

type FileTransferOptions

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

type Ft

type Ft struct {
	Enabled         bool               `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	DownloadTimeout *duration.Duration `protobuf:"bytes,2,opt,name=download_timeout,json=downloadTimeout,proto3" json:"download_timeout,omitempty"`
	UploadTimeout   *duration.Duration `protobuf:"bytes,3,opt,name=upload_timeout,json=uploadTimeout,proto3" json:"upload_timeout,omitempty"`
	Proxies         []*Ft_Proxy        `protobuf:"bytes,10,rep,name=proxies,proto3" json:"proxies,omitempty"`
	// contains filtered or unexported fields
}

func (*Ft) Descriptor

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

Deprecated: Use Ft.ProtoReflect.Descriptor instead.

func (*Ft) GetDownloadTimeout

func (x *Ft) GetDownloadTimeout() *duration.Duration

func (*Ft) GetEnabled

func (x *Ft) GetEnabled() bool

func (*Ft) GetProxies

func (x *Ft) GetProxies() []*Ft_Proxy

func (*Ft) GetUploadTimeout

func (x *Ft) GetUploadTimeout() *duration.Duration

func (*Ft) ProtoMessage

func (*Ft) ProtoMessage()

func (*Ft) ProtoReflect

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

func (*Ft) Reset

func (x *Ft) Reset()

func (*Ft) String

func (x *Ft) String() string

type Ft_Proxy

type Ft_Proxy struct {

	// proxy address
	Addr string `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
	// contains filtered or unexported fields
}

func (*Ft_Proxy) Descriptor

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

Deprecated: Use Ft_Proxy.ProtoReflect.Descriptor instead.

func (*Ft_Proxy) GetAddr

func (x *Ft_Proxy) GetAddr() string

func (*Ft_Proxy) ProtoMessage

func (*Ft_Proxy) ProtoMessage()

func (*Ft_Proxy) ProtoReflect

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

func (*Ft_Proxy) Reset

func (x *Ft_Proxy) Reset()

func (*Ft_Proxy) String

func (x *Ft_Proxy) String() string