<PackageReference Include="Relativity.Transfer.Client" Version="7.3.10" />

---

API Differences between 7.3.10 and 5.0.2

498 Additions 104 Removals

Relativity.DataTransfer.Nodes

• public class DirectoryNode : Node, IDirectory, INode
  • public DateTime Modified { get; }
  • public long? TotalFiles { get; }
  • public long? TotalFolders { get; }
  • public long? TotalSize { get; }
  • public DirectoryNode(string name, INode parentNode, DateTime modified)
  • public void SetTotalFiles(long totalFiles)
  • public void SetTotalFolders(long totalFolders)
  • public void SetTotalSize(long totalSize)
• public class FileNode : Node, IFile, INode
  • public string Extension { get; }
  • public DateTime Modified { get; }
  • public long Size { get; }
  • public FileNode(string name, INode parentNode, DateTime modified, long size)
• public interface IDirectory : INode
  • DateTime Modified { get; }
  • long? TotalFiles { get; }
  • long? TotalFolders { get; }
  • long? TotalSize { get; }
  • void SetTotalFiles(long totalFiles)
  • void SetTotalFolders(long totalFolders)
  • void SetTotalSize(long totalSize)
• public interface IDrive : INode
• public interface IFile : INode
  • string Extension { get; }
  • DateTime Modified { get; }
  • long Size { get; }
• public interface INode
  • string AbsolutePath { get; }
  • INodeContext Context { get; }
  • string HashedAbsolutePath { get; }
  • string HashedName { get; }
  • string Name { get; }
  • INode Parent { get; }
• public interface INodeContext : IEquatable<INodeContext>
  • int ArtifactId { get; }
  • string FileshareName { get; }
  • string FilesharePath { get; }
• public interface IRoot : INode
• public sealed class LinuxDrive : Node, IDrive, INode
  • public LinuxDrive()
• public sealed class LocalDrive : Node, IDrive, INode
  • public LocalDrive(string name)
• public sealed class LocalRoot : Root
  • public static IRoot Instance { get; }
• public abstract class Node : INode, IEquatable<Node>
  • public virtual string AbsolutePath { get; }
  • public INodeContext Context { get; }
  • public string HashedAbsolutePath { get; }
  • public string HashedName { get; }
  • public string Name { get; }
  • public INode Parent { get; }
  • protected Node(string name, INode parentNode)
  • protected Node(string name, IRoot rootNode, INodeContext context)
  • public static bool op_Equality(Node left, Node right)
  • public static bool op_Inequality(Node left, Node right)
  • public bool Equals(Node other)
• public sealed class NodeContext : NodeContextBase
  • public NodeContext(string fileshareName, int artifactId, string filesharePath)
• public abstract class NodeContextBase : INodeContext, IEquatable<INodeContext>
  • public int ArtifactId { get; }
  • public string FileshareName { get; }
  • public string FilesharePath { get; }
  • protected NodeContextBase(string fileshareName, int artifactId, string filesharePath)
  • public bool Equals(INodeContext other)
• public static class NodeExtensions
  • public static int CompareTo(this INode thisNode, INode otherNode)
  • public static bool IsDirectory(this INode node)
  • public static bool IsDrive(this INode node)
  • public static bool IsFile(this INode node)
  • public static bool IsRoot(this INode node)
• public sealed class NullNodeContext : NodeContextBase
  • public static INodeContext Instance { get; }
• public static class PathConstants
  • public static readonly char DirectorySeparatorAsChar
  • public static string DevicePathSpecifier { get; }
  • public static string DirectorySeparatorAsString { get; }
  • public static string UncPathLongPrefix { get; }
  • public static string UncPathShortPrefix { get; }
  • public static string UnixDirectorySeparator { get; }
  • public static char UnixSingleCharDirectorySeparator { get; }
  • public static char WindowsSingleCharDirectorySeparator { get; }
• public sealed class RemoteDrive : Node, IDrive, INode
  • public RemoteDrive(INodeContext context)
• public sealed class RemoteRoot : Root
  • public static IRoot Instance { get; }
• public class UncDrive : Node, IDrive, INode
  • public UncDrive(string name)

Relativity.DataTransfer.Nodes.Internal

• public abstract class Root : IRoot, INode, IEquatable<Root>
  • public string AbsolutePath { get; }
  • public INodeContext Context { get; }
  • public string HashedAbsolutePath { get; }
  • public string HashedName { get; }
  • public string Name { get; }
  • public INode Parent { get; }
  • protected Root(string name)
  • public static bool op_Equality(Root left, Root right)
  • public static bool op_Inequality(Root left, Root right)
  • public bool Equals(Root other)

Relativity.DataTransfer.Nodes.PathConversion

• public abstract class CanonicalFormConverterBase : ICanonicalFormConverter
  • protected CanonicalFormConverterBase()
  • public string Convert(string rawPath)
  • protected abstract string FixSlashes(string path)
  • protected abstract string RemoveAdditionalSlashes(string path)
• public class CanonicalFormConverterFactory : ICanonicalFormConverterFactory
  • public CanonicalFormConverterFactory()
  • public ICanonicalFormConverter Create(string path)
• public interface ICanonicalFormConverter
  • string Convert(string rawPath)
• public interface ICanonicalFormConverterFactory
  • ICanonicalFormConverter Create(string path)
• public interface IContextHolder
  • IPathHolder WithContext(INodeContext context)
• public interface INodeBuilder
  • IPathHolder WithContext(INodeContext context)
• public interface INodeParser
  • T Parse<T>() where T : INode
  • bool TryParse<T>(out T node) where T : INode
• public class InvalidPathCharacterException : Exception
  • public InvalidPathCharacterException()
  • public InvalidPathCharacterException(string message)
  • public InvalidPathCharacterException(string message, Exception innerException)
  • protected InvalidPathCharacterException(SerializationInfo info, StreamingContext context)
• public class InvalidPathException : Exception
  • public InvalidPathException()
  • public InvalidPathException(string message)
  • public InvalidPathException(string message, Exception innerException)
  • protected InvalidPathException(SerializationInfo info, StreamingContext context)
• public class InvalidWindowsCharacterException : InvalidPathCharacterException
  • public InvalidWindowsCharacterException()
• public interface IPathHolder
  • INodeParser WithPath(string path)
• public class LocalCanonicalFormConverter : CanonicalFormConverterBase
  • public LocalCanonicalFormConverter()
• public class NodeParser : INodeBuilder, INodeParser, IPathHolder, IContextHolder
  • public static INodeBuilder Node()
  • public T Parse<T>() where T : INode
  • public IFile ParseFile()
  • public bool TryParse<T>(out T node) where T : INode
  • public IPathHolder WithContext(INodeContext context)
  • public INodeParser WithPath(string path)
• public class PathConversionPipelineException : Exception
  • public PathConversionPipelineException()
  • public PathConversionPipelineException(string message)
  • public PathConversionPipelineException(string message, Exception innerException)
  • protected PathConversionPipelineException(SerializationInfo info, StreamingContext context)
• public class RemoteCanonicalFormConverter : CanonicalFormConverterBase
  • public RemoteCanonicalFormConverter()

Relativity.Transfer

• public class HttpClientConfiguration
  • public const int DefaultChunkSize = 1048576
  • public const int DefaultMaxRetryAttempts = 5
  • public const double DefaultRetryTimeoutSeconds = 15
  • public const double DefaultTimeoutSeconds = 300
  • public int ChunkSize { get; set; }
  • public CookieContainer CookieContainer { get; set; }
  • public int MaxRetryAttempts { get; set; }
  • public double RetryTimeoutSeconds { get; set; }
  • public double TimeoutSeconds { get; set; }
  • public HttpClientConfiguration()
• public sealed class AsperaCredential : IEquatable<AsperaCredential>
  • public const string AsperaNodeCredentialType = "AsperaNode"
• public sealed class AsperaCredentials
• public class AsperaNodeException : Exception
• public class BasicAuthenticationCredential : IHttpCredential
  • public void RefreshCredentials()
• public class BearerTokenCredential : IHttpCredential
  • public BearerTokenCredential()
  • public BearerTokenCredential(string token, IAuthenticationTokenProvider authTokenProvider)
  • public void RefreshCredentials()
• public class ClientConfiguration : Dictionary<string, object>
  • public const bool DefaultPreCalculateJobSize = false
  • public bool PreCalculateJobSize { get; set; }
  • public bool SavingMemoryMode { get; set; }
• public static class ClientConfigurationKeys
  • public const string AscpVersion = "ascp-version"
  • public const string PreCalculateJobSize = "pre-calculate-jobsize"
  • public const string SavingMemoryMode = "saving-memory-mode"
  • public const string UseAscp4 = "use-ascp4"
• public class ClientLimits
  • public int? MaxClientSupportedPathLength { get; set; }
  • public int? TransferFileNameLength { get; set; }
  • public int MaxSupportedPathLength { get; set; }
  • public int TransferFileNameLength { get; set; }
• public abstract class ConnectionServiceBase : IDisposable
  • protected virtual Task RunPostTestsAsync(CancellationToken token)
  • protected virtual Task RunPortsTestAsync(CancellationToken token)
• public class EnumeratedPathsResult
  • public IEnumerable<string> ErrorPaths { get; }
  • public IEnumerable<ErrorPath> ErrorPaths { get; }
  • public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<string> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
  • public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<ErrorPath> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
• public class ErrorPath
  • public string Path { get; set; }
  • public string Reason { get; set; }
  • public ErrorPath(string path, string reason)
• public sealed class FileShareResourceServer
  • public AsperaCredentials AsperaCredentials { get; }
  • public AsperaCredential AsperaCredential { get; }
  • public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
  • public FileShareResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
  • public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance)
  • public FileShareResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string uncPath, bool cloudInstance, ResourcePool pool)
• public class GlobalSettings : IGlobalSettings
  • public const bool DefaultApmFireAndForgetEnabled = true
  • public const bool DefaultLogPackageSourceFiles = true
  • public const int DefaultMaxAllowedTargetDataRateMbps = 600
  • public const long DefaultMaxFilesPerBatch = 50000
  • public const int DefaultMaxFilesPerBatch = 50000
  • public bool ApmFireAndForgetEnabled { get; set; }
  • public bool LogPackageSourceFiles { get; set; }
  • public int MaxAllowedTargetDataRateMbps { get; set; }
  • public long MaxFilesPerBatch { get; set; }
  • public int MaxFilesPerBatch { get; set; }
  • public int NodePageSize { get; set; }
• public interface IAuthenticationTokenProvider
  • string GenerateToken()
• public interface IBatchSerializer
  • void AddTransferPath(TransferPath path)
  • Task<SerializedPathsResult> CreateBatchAsync()
• public interface ICredentialService
  • Task<AsperaCredentials> GetResourceServerAsperaCredentialsAsync(int resourceServerArtifactId, CancellationToken token)
  • Task<AsperaCredential> GetResourceServerAsperaCredentialAsync(int resourceServerArtifactId, CancellationToken token)
• public interface IFileShareService
  • Task<BrowseDirectoryResponseDto> BrowseDirectoryAsync(string path, int page, int pageSize, int enumerateMax, CancellationToken token)
  • Task DeleteDirectoriesAsync(IEnumerable<string> paths, CancellationToken token)
  • Task DeleteFilesAsync(IEnumerable<string> paths, CancellationToken token)
  • Task<bool> DirectoryEmptyAsync(string path, CancellationToken token)
  • Task<FileShareItem> GetFileShareItemAsync(string path, CancellationToken token)
  • Task<IEnumerable<FileShareItem>> GetFileShareItemsAsync(IEnumerable<string> directories, IEnumerable<string> files, CancellationToken token)
  • Task<QueryPropertiesResponseDto> GetItemAttributesAsync(string path, CancellationToken token)
  • Task<bool> ItemExistsAsync(string path, CancellationToken token)
  • Task<bool> ItemsExistAsync(IEnumerable<string> paths, CancellationToken token)
• public interface IHttpCredential
  • void RefreshCredentials()
• public class IntegratedSecurityCredential : IHttpCredential
  • public void RefreshCredentials()
• public interface IPackageLibrary : IDisposable
• public interface IPackageLibraryMetadata
• public interface IPackageResult
• public interface IPackageTransferResult : ITransferResult, IPackageResult
• public interface IPathValidationFactory
  • IPathValidationProvider CreatePathValidationProvider()
• public interface IPathValidationProvider : IPathValidator
  • void Register(IPathValidator pathValidator)
• public interface IPathValidator
  • PathValidationResult Validate(TransferPath transferPath)
  • void Validate(IEnumerable<string> searchPaths, string targetPath)
• public interface IRelativityServiceFactory
  • IPathValidationProvider PathValidationProvider { get; }
  • IFileShareService CreateFileShareService(int fileShareId)
  • ITargetRateThrottler CreateTargetRateThrottler()
  • ITargetRateValidator CreateTargetRateValidator()
• public interface ITargetRateThrottler
  • void ThrottleToMaxAllowedValue(ClientConfiguration configuration)
  • int ThrottleToMaxAllowedValue(int targetRateMbps)
• public interface ITargetRateValidator
  • void Validate(int minRateMbps, int targetRateMbps)
  • void Validate(ClientConfiguration configuration)
• public interface ITransferClient : IDisposable
  • ClientLimits ClientLimits { get; }
  • IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
  • Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
  • Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
  • Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
• public interface ITransferIssue : IEquatable<ITransferIssue>
  • bool IsRetryable { get; }
• public interface ITransferIssueBuilder
  • ITransferIssue Build()
  • ITransferIssueBuilder FromJobPath(JobTransferPath jobPath)
  • ITransferIssueBuilder FromPath(TransferPath jobPath)
  • ITransferIssueBuilder WithAttributes(IssueAttributes attributes)
  • ITransferIssueBuilder WithIndex(int index)
  • ITransferIssueBuilder WithMaxRetryAttempts(int maxRetryAttempts)
  • ITransferIssueBuilder WithMessage(string message)
  • ITransferIssueBuilder WithRetryable(bool retrayable)
  • ITransferIssueBuilder WithRetryAttempt(int retryAttempt)
• public interface ITransferJob : IDisposable
  • void ChangeDataRate(int minRateMbps, int targetRateMbps)
  • void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
  • Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
  • Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
  • int ChangeDataRate(int minRateMbps, int targetRateMbps)
  • int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
  • Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
  • Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
  • void ValidatePath(TransferPath path)
  • PathValidationResult ValidatePath(TransferPath path)
• public interface ITransferJobService
  • void Initialize()
  • bool IsCompleted(TransferPathStatus status)
  • bool IsRetrayable(TransferPathStatus status)
• public interface ITransferResult
  • int Attempts { get; }
  • List<long> TotalRequestedBytesPerAttempt { get; }
  • List<long> TotalRequestedFilesPerAttempt { get; }
• public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
  • public double LargeFileProgressRateSeconds { get; }
  • public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds, JobTransferPath jobTransferPath)
  • public LargeFileProgress(Action<LargeFileProgressEventArgs> handler, double largeFileProgressRateSeconds)
  • public void Report(LargeFileProgressEventArgs value)
• public static class LogExtensions
  • public static void LogTransferDebug(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferDebug(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferError(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferError(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferFatal(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferFatal(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferInformation(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferInformation(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferStatistics(this ITransferLog log, ITransferRequest request, ITransferStatistics statistics)
  • public static void LogTransferWarning(this ITransferLog log, ITransferRequest request, string messageTemplate, object[] propertyValues)
  • public static void LogTransferWarning(this ITransferLog log, Exception exception, ITransferRequest request, string messageTemplate, object[] propertyValues)
• public sealed class PackageConfiguration : Dictionary<string, object>
• public sealed class PackageContext
• public class PackageEventArgs : EventArgs
• public class PackageFileMetadata
• public abstract class PackageLibraryBase : IPackageLibrary, IDisposable
• public sealed class PackageLibraryMetadataAttribute : ExportAttribute, IPackageLibraryMetadata
• public class PackageProgressEventArgs : EventArgs
• public class PackageQueuedEventArgs : EventArgs
• public sealed class PackageResult : IPackageResult
• public sealed class PackageTransferResult : IPackageTransferResult, ITransferResult, IPackageResult
• public class PackagingFileMetadataEventArgs : EventArgs
• public abstract class PathEnumeratorBase : IPathEnumerator
  • protected ClientLimits ClientLimits { get; }
  • protected PathEnumeratorBase(ITransferLog log, ClientLimits limits, IFileSystemService fileSystemService)
  • protected abstract Task OnInitializeAsync(PathEnumeratorContext context, CancellationToken token)
  • protected virtual void OnInitialize(PathEnumeratorContext context, CancellationToken token)
• public static class PathHelper
  • public static string GetTargetFilePath(string sourcePath, string targetPath, string targetFileName)
• public class PathValidationProvider : IPathValidationProvider, IPathValidator
  • public PathValidationProvider()
  • public void Register(IPathValidator pathValidator)
  • public PathValidationResult Validate(TransferPath transferPath)
  • public void Validate(IEnumerable<string> searchPaths, string targetPath)
• public class PathValidationResult
  • public string ErrorMessage { get; }
  • public bool IsOk { get; }
  • public PathValidationStatus Status { get; }
  • public TransferPath ValidatedPath { get; }
  • public static PathValidationResult Error(TransferPath validatedPath, PathValidationStatus status, string errorMessage)
  • public static PathValidationResult Ok(TransferPath transferPath)
  • public ErrorPath CreatesErrorPath()
• public enum PathValidationStatus
  • Ok = 0
  • SourcePathTooLong = 1
  • TargetPathToLong = 2
  • WrongFileType = 3
• public sealed class RelativityFileShare : RelativityFileShareBase
  • public RelativityFileShare(int artifactId, string name, string path, AsperaCredentials credentials, bool cloudInstance)
  • public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredentials credentials, bool cloudInstance)
  • public RelativityFileShare(int artifactId, string name, string path, AsperaCredential credentials, bool cloudInstance)
  • public RelativityFileShare(int artifactId, string name, string path, ResourceServerType resourceServerType, AsperaCredential credential, bool cloudInstance)
• public abstract class RelativityFileShareBase : FileStorageBase
  • public AsperaCredentials AsperaCredentials { get; protected set; }
  • public AsperaCredential AsperaCredential { get; protected set; }
  • public AsperaCredential NodeCredential { get; }
  • public AsperaCredential TransferCredential { get; }
• public abstract class RemotePathResolverBase : IRemotePathResolver
  • protected ITransferLog transferLog
  • protected RemotePathResolverBase()
  • protected RemotePathResolverBase(ITransferLog transferLog)
• public sealed class SerializedPathsResult
  • public IEnumerable<string> ErrorPaths { get; }
  • public IEnumerable<ErrorPath> ErrorPaths { get; }
  • public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<string> errorPaths, bool localPaths, TimeSpan elapsed)
  • public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<ErrorPath> errorPaths, bool localPaths, TimeSpan elapsed)
• public sealed class SqlResourceServer
  • public AsperaCredentials AsperaCredentials { get; }
  • public AsperaCredential AsperaCredential { get; }
  • public SqlResourceServer(int artifactId, AsperaCredentials credentials, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
  • public SqlResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
• public abstract class TransferClientBase : ITransferClient, IDisposable
  • public ClientLimits ClientLimits { get; set; }
  • protected IPathValidationProvider PathValidationProvider { get; }
  • protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName)
  • protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
  • protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName, IPathValidationFactory pathValidationFactory)
  • public IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
  • public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context)
  • public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, PackageContext context, CancellationToken token)
  • public Task<IPackageTransferResult> PackageTransferAsync(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
• public static class TransferClientConstants
  • public const string AzureBlobClientDisplayName = "Azure Blob"
  • public const string AzureBlobClientId = "962EE9FF-6E12-4EBF-A0C3-F2BB5B1547C4"
  • public const string AzureBlobClientName = "Azure Blob"
  • public const string AzureFilesClientDisplayName = "Azure Files"
  • public const string AzureFilesClientId = "302B33BB-1CC5-4901-B1CD-78D755986E7A"
  • public const string AzureFilesClientName = "Azure Files"
  • public const string HttpClientDiplayName = "Web"
  • public const string HttpClientDisplayName = "Web"
• public sealed class TransferContext
  • public event EventHandler<TransferPathIssueEventArgs> TransferJobIssue
  • public void PublishTransferJobIssue(ITransferRequest request, ITransferIssue issue)
• public class TransferIssue : ITransferIssue, IEquatable<ITransferIssue>
  • public bool IsRetryable { get; set; }
• public abstract class TransferJobBase : ITransferJob, IDisposable
  • public int? ClientMaxSupportedPathLength { get; set; }
  • public int? ClientTransferFileNameLength { get; set; }
  • public void ChangeDataRate(int minRateMbps, int targetRateMbps)
  • public void ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
  • public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
  • public Task ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
  • public int ChangeDataRate(int minRateMbps, int targetRateMbps)
  • public int ChangeDataRate(int minRateMbps, int targetRateMbps, CancellationToken token)
  • public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps)
  • public Task<int> ChangeDataRateAsync(int minRateMbps, int targetRateMbps, CancellationToken token)
  • protected void LogErrorPath(string path)
  • public void ValidatePath(TransferPath path)
  • protected void ValidateSourcePathLength(TransferPath path)
  • public PathValidationResult ValidatePath(TransferPath path)
  • protected virtual void ValidateTargetPathLength(TransferPath path)
• public class TransferJobService : ITransferJobService
  • public IPathStatusChecker RetryablePathChecker { get; set; }
  • public void Initialize()
  • public bool IsCompleted(TransferPathStatus status)
  • public bool IsRetrayable(TransferPathStatus status)
• public abstract class TransferPathCommandBase : ITransferPathCommand
  • protected void PublishTransferJobIssue(ITransferIssue issue)
  • protected bool ShouldPublishLargeFileProgress(int chunkNumber, int totalChunks, DateTime timestamp)
• public class TransferPathIssueEventArgs : EventArgs
  • public bool IsRetryable { get; }
• public class TransferPathProgressEventArgs : EventArgs
  • public bool Completed { get; }
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status)
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred)
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, TransferPathStatus status, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
  • public string TargetFile { get; }
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed)
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred)
  • public TransferPathProgressEventArgs(ITransferRequest request, TransferPath path, string targetFile, TransferPathStatus status, bool completed, DateTime? startTime, DateTime? endTime, long bytesTransferred, string checksum)
• public class TransferPathResult
  • public bool Completed { get; set; }
  • public string TargetFile { get; }
• public sealed class TransferResult : ITransferResult
  • public int Attempts { get; }
  • public List<long> TotalRequestedBytesPerAttempt { get; set; }
  • public List<long> TotalRequestedFilesPerAttempt { get; set; }
• public static class UncPathToDocRootConverter
  • public static string Convert(string uncPath, bool validateConvention = true)
  • public static void ValidateNamingConvention(string uncPath)
• public enum WellKnownPackageLibrary
• public enum WellKnownTransferClient
  • AzureBlob = 1
  • AzureFiles = 2

Relativity.Transfer.Aspera

• public enum AscpVersion
  • Experimental = 2
  • Stable = 1
• public class AsperaClientConfiguration : ClientConfiguration
  • public const AscpVersion DefaultAscpVersion = 1
  • public const int DefaultDatagramSize = 0
  • public const string DefaultResumeSuffix = ".aspx"
  • public const bool DefaultUseAscp4 = false
  • public AscpVersion AscpClientVersion { get; set; }
  • public int DatagramSize { get; set; }
  • public bool LegacyPortCheck { get; set; }
  • public string NodeAccountPassword { get; set; }
  • public string NodeAccountUserName { get; set; }
  • public Uri NodeHost { get; set; }
  • public bool ReportNotOverriddenFiles { get; set; }
  • public string ResumeSuffix { get; set; }
  • public bool UseAscp4 { get; set; }
• public static class AsperaClientConfigurationKeys
  • public const string DatagramSize = "aspera-datagram-size"
  • public const string LegacyPortCheck = "aspera-legacy-port-check"
  • public const string NodeAccountPassword = "node-aspera-account-password"
  • public const string NodeAccountUserName = "node-aspera-account-username"
  • public const string NodeHost = "node-aspera-host"
  • public const string ReportNotOverriddenFiles = "aspera-report-skipped-files"
  • public const string ResumeSuffix = "aspera-resume-suffix"
• public class AsperaUncBcpPathResolver : RemotePathResolverBase
  • public AsperaUncBcpPathResolver()
  • public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder)
  • public AsperaUncBcpPathResolver(ITransferLog transferLog)
  • public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder, ITransferLog transferLog)
• public class AsperaUncPathResolver : RemotePathResolverBase
  • public AsperaUncPathResolver()
  • public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels)
  • public AsperaUncPathResolver(ITransferLog transferLog)
  • public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels, ITransferLog transferLog)
• public static class XferParamsExtensions
  • public static string Dump(this XferParams xferParams)

Relativity.Transfer.Aspera.Enumeration.Filters

• public class AspxExtensionFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public AspxExtensionFilter()
  • public bool IsMet(INode node)
• public class PathLengthFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public PathLengthFilter()
  • public bool IsMet(INode node)

Relativity.Transfer.Aspera.Issues

• public static class IssuesDumper
  • public static string Dump(IReadOnlyCollection<ITransferIssue> issues)

Relativity.Transfer.Dto

• public class BrowseDirectoryResponseDto : FileShareResponseBaseDto
  • public FileShareItem[] Items { get; set; }
  • public int TotalCount { get; set; }
  • public BrowseDirectoryResponseDto()
• public class FileShareItem
  • public DateTime Modified { get; set; }
  • public string Name { get; set; }
  • public string Path { get; set; }
  • public string PathType { get; set; }
  • public long Size { get; set; }
  • public FileShareItem()
  • public bool IsFile()
• public enum FileShareOperationErrorCode
  • AccessDenied = 8
  • DirectoryMissingDuringProcessing = 18
  • DirectoryNotEmpty = 12
  • FailedToProcessItem = 19
  • HostBreakDown = 15
  • HostDisabled = 14
  • InvalidName = 6
  • InvalidPageNumber = 10
  • InvalidPageSizeNumber = 11
  • InvalidPath = 4
  • NameDuplicated = 17
  • NoSourcePaths = 1
  • NotEnoughSpaceOnDisk = 3
  • OperationNotFound = 16
  • PathAlreadyExists = 7
  • PathDoesNotExist = 2
  • PathIsNotDirectory = 5
  • PathNotFound = 9
  • QueryItemsLimitExceeded = 13
  • Unknown = 0
• public enum FileShareOperationState
  • Calculating = 1
  • Canceled = 3
  • Deleted = 9
  • Failed = 4
  • Finished = 5
  • FinishedWithErrors = 6
  • Indeterminate = 7
  • InProgress = 2
  • New = 0
  • Pending = 8
• public class FileShareResponseBaseDto
  • public string Error { get; set; }
  • public FileShareOperationErrorCode ErrorCode { get; set; }
  • public FileShareOperationState State { get; set; }
  • public FileShareResponseBaseDto()
• public class GetItemRequestDto
  • public int FileshareId { get; set; }
  • public string Path { get; set; }
  • public GetItemRequestDto()
• public class GetItemResponseDto : FileShareResponseBaseDto
  • public FileShareItem Item { get; set; }
  • public GetItemResponseDto()
• public class GetItemsRequestDto
  • public string[] DirectoriesPaths { get; set; }
  • public int FileshareId { get; set; }
  • public string[] FilesPaths { get; set; }
  • public GetItemsRequestDto()
• public class GetItemsResponseDto : FileShareResponseBaseDto
  • public FileShareItem[] Items { get; set; }
  • public GetItemsResponseDto()
• public class ItemExistsRequestDto
  • public int FileshareId { get; set; }
  • public string Path { get; set; }
  • public ItemExistsRequestDto()
• public class ItemExistsResponseDto : FileShareResponseBaseDto
  • public bool Exist { get; set; }
  • public ItemExistsResponseDto()
• public class ItemsExistRequestDto
  • public int FileshareId { get; set; }
  • public string[] Paths { get; set; }
  • public ItemsExistRequestDto()
• public class ItemsExistResponseDto : FileShareResponseBaseDto
  • public bool Exist { get; set; }
  • public ItemsExistResponseDto()
• public class QueryPropertiesResponseDto : FileShareResponseBaseDto
  • public long TotalFiles { get; set; }
  • public long TotalFolders { get; set; }
  • public long TotalSize { get; set; }
  • public QueryPropertiesResponseDto()

Relativity.Transfer.Enumeration

• public sealed class EnumerationBuilder : IEnumerationFinalActionsBuilder, IEnumerationNecessaryActionsBuilder
  • public static IEnumerationNecessaryActionsBuilder ForDownload(IEnumeratorProvider enumerator, ITransferLog logger, Guid correlationId)
  • public static IEnumerationNecessaryActionsBuilder ForUpload(ITransferLog logger, Guid correlationId)
  • public static IEnumerationNecessaryActionsBuilder ForUpload(IEnumeratorProvider enumerator, ITransferLog logger, Guid correlationId)
  • public IEnumerationOrchestrator Create()
  • public IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesOfSameParent)
  • public IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesUnderRootNode, INode rootNode)
  • public IEnumerationFinalActionsBuilder WithBatching(INode destinationNode, IDirectory batchSerializationDirectory, IEnumerationHandler<SerializedBatch> batchCreatedHandler)
  • public IEnumerationFinalActionsBuilder WithFilters(IEnumerable<INodeFilter> filters, IEnumerationHandler<EnumerationIssue> skippedItemHandler)
  • public IEnumerationFinalActionsBuilder WithStatistics(IEnumerationHandler<EnumerationStatistic> statisticsHandler)
• public class EnumerationException : Exception
  • public int Error { get; }
  • public EnumerationException(int error)
  • public EnumerationException(int error, string message)
  • public EnumerationException(string message, Exception innerException)
• public class EnumerationIssue
  • public string ErrorMessage { get; }
  • public string Path { get; }
  • public EnumerationIssue(string path, string errorMessage)
• public class EnumerationOrchestrator : IEnumerationOrchestrator
  • public void ExecuteEnumerate(CancellationToken token)
  • public IEnumerable<INode> LazyEnumerate(CancellationToken token)
• public class EnumerationStatistic
  • public long TotalBytes { get; }
  • public long TotalEmptyDirectories { get; }
  • public long TotalFiles { get; }
• public class PathDoesNotExistException : EnumerationException
  • public PathDoesNotExistException()
  • public PathDoesNotExistException(string message, Exception innerException)
• public class SynchronousHandler<T> : IEnumerationHandler<T>
  • public SynchronousHandler(Action<T> action)
  • public void Report(T value)

Relativity.Transfer.Enumeration.Filters

• public interface IFilter<T>
  • string Message { get; }
  • bool IsMet(T item)
• public interface INodeFilter : IFilter<INode>
• public class NoReadAccessFileNodeFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public NoReadAccessFileNodeFilter()
  • public bool IsMet(INode item)
• public class R1PathSizeFilter : INodeFilter, IFilter<INode>
  • public string Message { get; }
  • public R1PathSizeFilter(IEnumerable<INode> transferredNodes, IDirectory targetDirectory)
  • public bool IsMet(INode item)

Relativity.Transfer.Enumeration.Interfaces

• public interface IBatchAggregator
  • void AddToBatch(INode node)
  • void CreateBatch()
• public interface IEnumerationFinalActionsBuilder
  • IEnumerationOrchestrator Create()
  • IEnumerationFinalActionsBuilder WithBatching(INode destinationNode, IDirectory batchSerializationDirectory, IEnumerationHandler<SerializedBatch> batchCreatedHandler)
  • IEnumerationFinalActionsBuilder WithFilters(IEnumerable<INodeFilter> filters, IEnumerationHandler<EnumerationIssue> skippedItemHandler)
  • IEnumerationFinalActionsBuilder WithStatistics(IEnumerationHandler<EnumerationStatistic> statisticsHandler)
• public interface IEnumerationHandler<T>
  • void Report(T item)
• public interface IEnumerationNecessaryActionsBuilder
  • IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesOfSameParent)
  • IEnumerationFinalActionsBuilder StartFrom(IEnumerable<INode> nodesUnderRootNode, INode rootNode)
• public interface IEnumerationOrchestrator
  • void ExecuteEnumerate(CancellationToken token)
  • IEnumerable<INode> LazyEnumerate(CancellationToken token)
• public interface IEnumeratorProvider
  • IEnumerator<INode> GetEnumerator(IEnumerable<INode> nodes, CancellationToken token)

Relativity.Transfer.Exceptions

• public class FileshareConfigurationException : Exception
  • public string Details { get; }

Relativity.Transfer.Paths

• public interface IPathStatusChecker
  • bool IsCompleted(TransferPathStatus status)
  • bool IsRetrayable(TransferPathStatus status)
• public static class NodeExtensions
  • public static string FindRelativePath(this INode rootNode, INode node)

Relativity.Transfer.Resources

• public class CoreStrings