cmd

type AccountTraverser ¶ added in v10.12.2

type AccountTraverser interface {
	ResourceTraverser
	// contains filtered or unexported methods
}

type BucketToContainerNameResolver ¶

type BucketToContainerNameResolver interface {
	ResolveName(bucketName string) (string, error)
}

type CookedCopyCmdArgs ¶ added in v10.12.2

type CookedCopyCmdArgs struct {
	// from arguments
	Source      common.ResourceString
	Destination common.ResourceString
	FromTo      common.FromTo

	// new include/exclude only apply to file names
	// implemented for remove (and sync) only
	// includePathPatterns are handled like a list-of-files. Do not panic. This is not a bug that it is not present here.
	IncludePatterns     []string
	ExcludePatterns     []string
	ExcludePathPatterns []string

	IncludeFileAttributes []string
	ExcludeFileAttributes []string
	IncludeBefore         *time.Time
	IncludeAfter          *time.Time

	// list of version ids
	ListOfVersionIDs chan string
	// filters from flags
	ListOfFilesChannel chan string // Channels are nullable.
	Recursive          bool
	StripTopDir        bool
	SymlinkHandling    common.SymlinkHandlingType
	ForceWrite         common.OverwriteOption // says whether we should try to overwrite
	ForceIfReadOnly    bool                   // says whether we should _force_ any overwrites (triggered by forceWrite) to work on Azure Files objects that are set to read-only
	IsSourceDir        bool

	CheckLength bool

	// To specify whether user wants to preserve the blob index tags during service to service transfer.
	S2sPreserveBlobTags bool

	// whether to include blobs that have metadata 'hdi_isfolder = true'
	IncludeDirectoryStubs bool

	CpkOptions common.CpkOptions
	// contains filtered or unexported fields
}

represents the processed copy command input from the user

func (cca *CookedCopyCmdArgs) Cancel(lcm common.LifecycleMgr)

func (cca *CookedCopyCmdArgs) InitModularFilters() []ObjectFilter

func (cca *CookedCopyCmdArgs) MakeEscapedRelativePath(source bool, dstIsDir bool, asSubdir bool, object StoredObject) (relativePath string)

func (cca *CookedCopyCmdArgs) ReportProgressOrExit(lcm common.LifecycleMgr) (totalKnownCount uint32)

type CopyEnumerator ¶ added in v10.12.2

type CopyEnumerator struct {
	Traverser ResourceTraverser

	// general filters apply to the objects returned by the traverser
	Filters []ObjectFilter

	// receive objects from the traverser and dispatch them for transferring
	ObjectDispatcher objectProcessor

	// a finalizer that is always called if the enumeration finishes properly
	Finalize func() error
}

func NewCopyEnumerator(traverser ResourceTraverser, filters []ObjectFilter, objectDispatcher objectProcessor, finalizer func() error) *CopyEnumerator

type ErrorFileInfo ¶ added in v10.16.0

type ErrorFileInfo struct {
	FilePath string
	FileInfo os.FileInfo
	ErrorMsg error
}

ErrorFileInfo holds information about files and folders that failed enumeration.

type FilterSet ¶ added in v10.12.2

type FilterSet []ObjectFilter

func (fs FilterSet) GetEnumerationPreFilter(recursive bool) string

type GCPBucketNameToAzureResourcesResolver ¶

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

func NewGCPBucketNameToAzureResourcesResolver(gcpBucketNames []string) *GCPBucketNameToAzureResourcesResolver

func (resolver *GCPBucketNameToAzureResourcesResolver) ResolveName(bucketName string) (string, error)

type IncludeAfterDateFilter ¶ added in v10.12.2

type IncludeAfterDateFilter struct {
	Threshold time.Time
}

includeAfterDateFilter includes files with Last Modified Times >= the specified threshold Used for copy, but doesn't make conceptual sense for sync

func (f *IncludeAfterDateFilter) AppliesOnlyToFiles() bool

func (f *IncludeAfterDateFilter) DoesPass(storedObject StoredObject) bool

func (f *IncludeAfterDateFilter) DoesSupportThisOS() (msg string, supported bool)

func (_ IncludeAfterDateFilter) FormatAsUTC(t time.Time) string

func (_ IncludeAfterDateFilter) ParseISO8601(s string, chooseEarliest bool) (time.Time, error)

type IncludeBeforeDateFilter ¶ added in v10.12.2

type IncludeBeforeDateFilter struct {
	Threshold time.Time
}

IncludeBeforeDateFilter includes files with Last Modified Times <= the specified Threshold Used for copy, but doesn't make conceptual sense for sync

func (f *IncludeBeforeDateFilter) AppliesOnlyToFiles() bool

func (f *IncludeBeforeDateFilter) DoesPass(storedObject StoredObject) bool

func (f *IncludeBeforeDateFilter) DoesSupportThisOS() (msg string, supported bool)

func (_ IncludeBeforeDateFilter) FormatAsUTC(t time.Time) string

func (_ IncludeBeforeDateFilter) ParseISO8601(s string, chooseEarliest bool) (time.Time, error)

type IncludeFilter ¶ added in v10.12.2

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

design explanation: include filters are different from the exclude ones, which work together in the "AND" manner meaning and if an StoredObject is rejected by any of the exclude filters, then it is rejected by all of them as a result, the exclude filters can be in their own struct, and work correctly on the other hand, include filters work in the "OR" manner meaning that if an StoredObject is accepted by any of the include filters, then it is accepted by all of them consequently, all the include Patterns must be stored together

func (f *IncludeFilter) AppliesOnlyToFiles() bool

func (f *IncludeFilter) DoesPass(storedObject StoredObject) bool

func (f *IncludeFilter) DoesSupportThisOS() (msg string, supported bool)

type ListReq ¶

type ListReq struct {
	JobID    common.JobID
	OfStatus string
}

type ListResponse ¶

type ListResponse struct {
	ErrorMsg string
}

type LocationLevel ¶

type LocationLevel uint8

----- LOCATION LEVEL HANDLING -----

var ELocationLevel LocationLevel = 0

func DetermineLocationLevel(location string, locationType common.Location, source bool) (LocationLevel, error)

func (LocationLevel) Account() LocationLevel

func (LocationLevel) Container() LocationLevel

func (LocationLevel) Object() LocationLevel

func (LocationLevel) Service() LocationLevel

type ObjectFilter ¶ added in v10.12.2

type ObjectFilter interface {
	DoesSupportThisOS() (msg string, supported bool)
	DoesPass(storedObject StoredObject) bool
	AppliesOnlyToFiles() bool
}

given a StoredObject, verify if it satisfies the defined conditions if yes, return true

type ResourceTraverser ¶ added in v10.12.2

type ResourceTraverser interface {
	Traverse(preprocessor objectMorpher, processor objectProcessor, filters []ObjectFilter) error
	IsDirectory(isSource bool) (bool, error)
}

capable of traversing a structured resource like container or local directory pass each StoredObject to the given objectProcessor if it passes all the filters

func InitResourceTraverser(resource common.ResourceString, location common.Location, ctx *context.Context, credential *common.CredentialInfo, symlinkHandling common.SymlinkHandlingType, listOfFilesChannel chan string, recursive, getProperties, includeDirectoryStubs bool, permanentDeleteOption common.PermanentDeleteOption, incrementEnumerationCounter enumerationCounterFunc, listOfVersionIds chan string, s2sPreserveBlobTags bool, syncHashType common.SyncHashType, preservePermissions common.PreservePermissionsOption, logLevel common.LogLevel, cpkOptions common.CpkOptions, errorChannel chan ErrorFileInfo, stripTopDir bool, trailingDot common.TrailingDotOption, destination *common.Location, excludeContainerNames []string, includeVersionsList bool) (ResourceTraverser, error)

type S3BucketNameToAzureResourcesResolver ¶

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

S3BucketNameToAzureResourcesResolver resolves s3 bucket name to Azure Blob container/ADLS Gen2 filesystem/File share. For Azure, container/filesystem/share's naming follows: 1. Lower case letters, numbers and hyphen. 2. 3-63 length. 3. Name should not contain two consecutive hyphens. 4. Name should not start or end with hyphen. For S3, bucket's naming follows: 1. The bucket name can be between 3 and 63 characters long, and can contain only lower-case characters, numbers, periods, and dashes. 2. Each label in the bucket name must start with a lowercase letter or number. 3. The bucket name cannot contain underscores, end with a dash or period, have consecutive periods, or use dashes adjacent to periods. 4. The bucket name cannot be formatted as an IP address (198.51.100.24). Two common cases need be solved are: 1. bucket name with period. In this case, AzCopy try to replace period with hyphen. e.g. bucket.with.period -> bucket-with-period 2. bucket name with consecutive hyphens. In this case, AzCopy try to replace consecutive hyphen, with -[numberOfHyphens]-. e.g. bucket----hyphens -> bucket-4-hyphens The resolver checks if there are naming collision with other existing bucket names, and try to add suffix when there is any collision. e.g. There is buckets with name: bucket-name, bucket.name. Azcopy will resolve bucket.name -> bucket-name -> bucket-name-2 All the resolving should be logged and warned to user.

func NewS3BucketNameToAzureResourcesResolver(s3BucketNames []string) *S3BucketNameToAzureResourcesResolver

func (s3Resolver *S3BucketNameToAzureResourcesResolver) ResolveName(bucketName string) (string, error)

type StoredObject ¶ added in v10.12.2

type StoredObject struct {

	// container source, only included by account traversers.
	ContainerName string
	// destination container name. Included in the processor after resolving container names.
	DstContainerName string

	// metadata, included in S2S transfers
	Metadata common.Metadata
	// contains filtered or unexported fields
}

represent a local or remote resource object (ex: local file, blob, etc.) we can add more properties if needed, as this is easily extensible ** DO NOT instantiate directly, always use newStoredObject ** (to make sure its fully populated and any preprocessor method runs)

func (s *StoredObject) ToNewCopyTransfer(steWillAutoDecompress bool, Source string, Destination string, preserveBlobTier bool, folderPropertiesOption common.FolderPropertyOption, symlinkHandlingType common.SymlinkHandlingType) (transfer common.CopyTransfer, shouldSendToSte bool)

type Version ¶

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

func NewVersion(raw string) (*Version, error)

func ValidateCachedVersion(filePath string) (*Version, error)

func (v Version) CacheRemoteVersion(remoteVer Version, filePath string) error

func (v Version) EqualTo(v2 Version) bool

func (v Version) NewerThan(v2 Version) bool

func (v Version) OlderThan(v2 Version) bool