op

Documentation

Overview

Package op defines types of operations and their accepted options.

Index

• type Operation
  • func (o Operation) Describe(l opt.OptionList) string
  • func (o Operation) GetAcceptedOpts() *opt.OptionList
  • func (o Operation) IsBatch() bool
  • func (o Operation) IsInternal() bool
  • func (o Operation) String() string

Types

type Operation

type Operation int

Operation is a type of our operations.

const (
	Abort             Operation = iota // Abort program
	Download                           // Download from S3 to local
	BatchDownload                      // Batch download from S3 to local
	Upload                             // Upload from local to S3
	BatchUpload                        // Batch upload from local to S3
	Copy                               // Copy from S3 to S3
	BatchCopy                          // Batch copy from S3 to S3
	Delete                             // Delete from S3
	Size                               // List S3 and get object sizes
	BatchDelete                        // "ls" and submit batched multi-delete operations
	BatchDeleteActual                  // AWS deleteObjects call
	List                               // List S3 objects
	ListBuckets                        // List S3 buckets
	LocalCopy                          // Copy from local to local
	BatchLocalCopy                     // Batch copy from local to local
	LocalDelete                        // Delete local file
	ShellExec                          // Execute shell command
	AliasGet                           // Alias for Download
	AliasBatchGet                      // Alias for BatchDownload
	ShowHelp                           // Show help for command
)

List of Operations

func (Operation) Describe

func (o Operation) Describe(l opt.OptionList) string

Describe returns string description of the Operation given a specific OptionList

func (Operation) GetAcceptedOpts

func (o Operation) GetAcceptedOpts() *opt.OptionList

GetAcceptedOpts returns an opt.OptionList of optional parameters for a specific Operation

func (Operation) IsBatch

func (o Operation) IsBatch() bool

IsBatch returns true if this operation creates sub-jobs

func (Operation) IsInternal

func (o Operation) IsInternal() bool

IsInternal returns true if this operation is considered internal. Internal operations are not shown in +OK messages

func (Operation) String

func (o Operation) String() string