repository

Documentation

Index

• func Connect(args ConnectArgs) (*safecli.Builder, error)
• func ConnectServer(connectServerArgs ConnectServerArgs) (*safecli.Builder, error)
• func Create(createArgs CreateArgs) (*safecli.Builder, error)
• func SetParameters(args SetParametersArgs) (*safecli.Builder, error)
• func Status(args StatusArgs) (*safecli.Builder, error)
• type ConnectArgs
• type ConnectServerArgs
• type CreateArgs
• type SetParametersArgs
• type StatusArgs

Functions

func Connect

func Connect(args ConnectArgs) (*safecli.Builder, error)

Connect creates a new `kopia repository connect ...` command.

func ConnectServer

func ConnectServer(connectServerArgs ConnectServerArgs) (*safecli.Builder, error)

ConnectServer creates a new `kopia repository connect server...` command.

func Create

func Create(createArgs CreateArgs) (*safecli.Builder, error)

Create creates a new `kopia repository create ...` command.

func SetParameters

func SetParameters(args SetParametersArgs) (*safecli.Builder, error)

SetParameters creates a new `kopia repository set-parameters ...` command.

func Status

func Status(args StatusArgs) (*safecli.Builder, error)

Status creates a new `kopia repository status ...` command.

Types

type ConnectArgs

type ConnectArgs struct {
	args.Common
	args.Cache

	Hostname       string            // the hostname of the repository
	Username       string            // the username of the repository
	Location       map[string][]byte // the location of the repository
	RepoPathPrefix string            // the prefix of the repository path
	ReadOnly       bool              // connect to a repository in read-only mode
	PointInTime    strfmt.DateTime   // connect to a repository as it was at a specific point in time

	Logger log.Logger
}

ConnectArgs defines the arguments for the `kopia repository connect` command.

type ConnectServerArgs

type ConnectServerArgs struct {
	args.Common
	args.Cache

	Hostname    string // hostname of the repository
	Username    string // username of the repository
	ServerURL   string // URL of the Kopia Repository API server
	Fingerprint string // fingerprint of the server's TLS certificate
	ReadOnly    bool   // connect to a repository in read-only mode

	Logger log.Logger
}

ConnectServerArgs defines the arguments for the `kopia repository connect server` command.

type CreateArgs

type CreateArgs struct {
	args.Common // embeds common arguments
	args.Cache  // embeds cache arguments

	Hostname        string            // the hostname of the repository
	Username        string            // the username of the repository
	Location        map[string][]byte // the location of the repository
	RepoPathPrefix  string            // the prefix of the repository path
	RetentionMode   string            // retention mode for supported storage backends
	RetentionPeriod time.Duration     // retention period for supported storage backends

	Logger log.Logger
}

CreateArgs defines the arguments for the `kopia repository create` command.

type SetParametersArgs

type SetParametersArgs struct {
	args.Common

	RetentionMode   string        // retention mode for supported storage backends
	RetentionPeriod time.Duration // retention period for supported storage backends

	Logger log.Logger
}

SetParametersArgs defines the arguments for the `kopia repository set-parameters ...` command.

type StatusArgs

type StatusArgs struct {
	args.Common // embed common arguments

	JSONOutput bool // shows the output in JSON format

	Logger log.Logger
}

StatusArgs defines the arguments for the `kopia repository status ...` command.