sftp

Documentation

Overview

Package sftp contains commands to inspect and manipulate Fastly service SFTP logging endpoints.

Index

• type CreateCommand
  • func NewCreateCommand(parent cmd.Registerer, globals *config.Data) *CreateCommand
  • func (c *CreateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.CreateSFTPInput, error)
  • func (c *CreateCommand) Exec(in io.Reader, out io.Writer) error
• type DeleteCommand
  • func NewDeleteCommand(parent cmd.Registerer, globals *config.Data) *DeleteCommand
  • func (c *DeleteCommand) Exec(in io.Reader, out io.Writer) error
• type DescribeCommand
  • func NewDescribeCommand(parent cmd.Registerer, globals *config.Data) *DescribeCommand
  • func (c *DescribeCommand) Exec(in io.Reader, out io.Writer) error
• type ListCommand
  • func NewListCommand(parent cmd.Registerer, globals *config.Data) *ListCommand
  • func (c *ListCommand) Exec(in io.Reader, out io.Writer) error
• type RootCommand
  • func NewRootCommand(parent cmd.Registerer, globals *config.Data) *RootCommand
  • func (c *RootCommand) Exec(in io.Reader, out io.Writer) error
• type UpdateCommand
  • func NewUpdateCommand(parent cmd.Registerer, globals *config.Data) *UpdateCommand
  • func (c *UpdateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.UpdateSFTPInput, error)
  • func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) error

Types

type CreateCommand

type CreateCommand struct {
	cmd.Base
	Manifest manifest.Data

	// required
	EndpointName   string // Can't shadow cmd.Base method Name().
	Address        string
	User           string
	SSHKnownHosts  string
	ServiceVersion cmd.OptionalServiceVersion

	// optional
	AutoClone         cmd.OptionalAutoClone
	Port              cmd.OptionalUint
	Password          cmd.OptionalString
	PublicKey         cmd.OptionalString
	SecretKey         cmd.OptionalString
	Path              cmd.OptionalString
	Period            cmd.OptionalUint
	Format            cmd.OptionalString
	FormatVersion     cmd.OptionalUint
	GzipLevel         cmd.OptionalUint
	MessageType       cmd.OptionalString
	ResponseCondition cmd.OptionalString
	TimestampFormat   cmd.OptionalString
	Placement         cmd.OptionalString
	CompressionCodec  cmd.OptionalString
}

CreateCommand calls the Fastly API to create an SFTP logging endpoint.

func NewCreateCommand

func NewCreateCommand(parent cmd.Registerer, globals *config.Data) *CreateCommand

NewCreateCommand returns a usable command registered under the parent.

func (*CreateCommand) ConstructInput

func (c *CreateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.CreateSFTPInput, error)

ConstructInput transforms values parsed from CLI flags into an object to be used by the API client library.

func (*CreateCommand) Exec

func (c *CreateCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type DeleteCommand

type DeleteCommand struct {
	cmd.Base

	Input fastly.DeleteSFTPInput
	// contains filtered or unexported fields
}

DeleteCommand calls the Fastly API to delete an SFTP logging endpoint.

func NewDeleteCommand

func NewDeleteCommand(parent cmd.Registerer, globals *config.Data) *DeleteCommand

NewDeleteCommand returns a usable command registered under the parent.

func (*DeleteCommand) Exec

func (c *DeleteCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type DescribeCommand

type DescribeCommand struct {
	cmd.Base

	Input fastly.GetSFTPInput
	// contains filtered or unexported fields
}

DescribeCommand calls the Fastly API to describe an SFTP logging endpoint.

func NewDescribeCommand

func NewDescribeCommand(parent cmd.Registerer, globals *config.Data) *DescribeCommand

NewDescribeCommand returns a usable command registered under the parent.

func (*DescribeCommand) Exec

func (c *DescribeCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type ListCommand

type ListCommand struct {
	cmd.Base

	Input fastly.ListSFTPsInput
	// contains filtered or unexported fields
}

ListCommand calls the Fastly API to list SFTP logging endpoints.

func NewListCommand

func NewListCommand(parent cmd.Registerer, globals *config.Data) *ListCommand

NewListCommand returns a usable command registered under the parent.

func (*ListCommand) Exec

func (c *ListCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.

type RootCommand

type RootCommand struct {
	cmd.Base
}

RootCommand is the parent command for all subcommands in this package. It should be installed under the primary root command.

func NewRootCommand

func NewRootCommand(parent cmd.Registerer, globals *config.Data) *RootCommand

NewRootCommand returns a new command registered in the parent.

func (*RootCommand) Exec

func (c *RootCommand) Exec(in io.Reader, out io.Writer) error

Exec implements the command interface.

type UpdateCommand

type UpdateCommand struct {
	cmd.Base
	Manifest manifest.Data

	// required
	EndpointName   string
	ServiceVersion cmd.OptionalServiceVersion

	// optional
	AutoClone         cmd.OptionalAutoClone
	NewName           cmd.OptionalString
	Address           cmd.OptionalString
	Port              cmd.OptionalUint
	PublicKey         cmd.OptionalString
	SecretKey         cmd.OptionalString
	SSHKnownHosts     cmd.OptionalString
	User              cmd.OptionalString
	Password          cmd.OptionalString
	Path              cmd.OptionalString
	Period            cmd.OptionalUint
	FormatVersion     cmd.OptionalUint
	GzipLevel         cmd.OptionalUint
	Format            cmd.OptionalString
	MessageType       cmd.OptionalString
	ResponseCondition cmd.OptionalString
	TimestampFormat   cmd.OptionalString
	Placement         cmd.OptionalString
	CompressionCodec  cmd.OptionalString
}

UpdateCommand calls the Fastly API to update an SFTP logging endpoint.

func NewUpdateCommand

func NewUpdateCommand(parent cmd.Registerer, globals *config.Data) *UpdateCommand

NewUpdateCommand returns a usable command registered under the parent.

func (*UpdateCommand) ConstructInput

func (c *UpdateCommand) ConstructInput(serviceID string, serviceVersion int) (*fastly.UpdateSFTPInput, error)

ConstructInput transforms values parsed from CLI flags into an object to be used by the API client library.

func (*UpdateCommand) Exec

func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) error

Exec invokes the application logic for the command.