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

---

API Differences between 5.0.2 and 6.2.4

93 Additions 79 Removals

Relativity.Transfer

• public class ClientConfiguration : Dictionary<string, object>
  • public const bool DefaultPreCalculateJobSize = false
  • public bool PreCalculateJobSize { get; set; }
• public static class ClientConfigurationKeys
  • public const string AscpVersion = "ascp-version"
  • public const string PreCalculateJobSize = "pre-calculate-jobsize"
  • public const string UseAscp4 = "use-ascp4"
• public sealed class ClientLimits
  • public int MaxSupportedPathLength { get; set; }
  • public int TransferFileNameLength { get; set; }
  • public int? MaxClientSupportedPathLength { get; set; }
  • public int? TransferFileNameLength { get; set; }
• public class EnumeratedPathsResult
  • public IEnumerable<ErrorPath> ErrorPaths { get; }
  • public IEnumerable<string> ErrorPaths { get; }
  • public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<ErrorPath> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
  • public EnumeratedPathsResult(IEnumerable<string> searchPaths, IEnumerable<TransferPath> paths, IEnumerable<string> errorPaths, long totalDirectories, bool localPaths, TimeSpan elapsed)
• public class ErrorPath
• public class GlobalSettings
  • public const int DefaultMaxAllowedTargetDataRateMbps = 600
  • public int MaxAllowedTargetDataRateMbps { get; set; }
• public interface IBatchSerializer
• public interface IPathValidationFactory
• public interface IPathValidationProvider : IPathValidator
• public interface IPathValidator
• public interface IRelativityServiceFactory
  • IPathValidationProvider PathValidationProvider { get; }
  • ITargetRateThrottler CreateTargetRateThrottler()
  • ITargetRateValidator CreateTargetRateValidator()
• public interface ITargetRateThrottler
• public interface ITargetRateValidator
• public interface ITransferClient : IDisposable
  • ClientLimits ClientLimits { get; }
  • IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
• public interface ITransferIssue : IEquatable<ITransferIssue>
  • bool IsRetryable { get; }
• public interface ITransferIssueBuilder
• public interface ITransferJob : IDisposable
  • 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 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)
  • PathValidationResult ValidatePath(TransferPath path)
  • void ValidatePath(TransferPath path)
• public interface ITransferJobService
  • bool IsCompleted(TransferPathStatus status)
  • bool IsRetrayable(TransferPathStatus status)
• public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
• public abstract class PathEnumeratorBase : IPathEnumerator
  • protected ClientLimits ClientLimits { get; }
  • protected PathEnumeratorBase(ITransferLog log, ClientLimits limits, IFileSystemService fileSystemService)
• public static class PathHelper
  • public static string GetTargetFilePath(string sourcePath, string targetPath, string targetFileName)
• public class PathValidationProvider : IPathValidationProvider, IPathValidator
• public class PathValidationResult
• public enum PathValidationStatus
• public sealed class SerializedPathsResult
  • public IEnumerable<ErrorPath> ErrorPaths { get; }
  • public IEnumerable<string> ErrorPaths { get; }
  • public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<ErrorPath> errorPaths, bool localPaths, TimeSpan elapsed)
  • public SerializedPathsResult(IEnumerable<string> searchPaths, IEnumerable<SerializedBatch> batches, IEnumerable<string> errorPaths, bool localPaths, TimeSpan elapsed)
• 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, 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)
  • protected TransferClientBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, IWorkspaceService workspaceService, ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownTransferClient client, string name, string displayName)
  • public IBatchSerializer CreateBatchSerializer(string batchDirectory, TransferDirection direction, PathEnumeratorContext context)
• 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 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)
  • 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)
  • protected void LogErrorPath(string path)
  • public PathValidationResult ValidatePath(TransferPath path)
  • public void ValidatePath(TransferPath path)
  • protected void ValidateSourcePathLength(TransferPath path)
  • protected virtual void ValidateTargetPathLength(TransferPath path)
• public class TransferJobService : ITransferJobService
  • public IPathStatusChecker RetryablePathChecker { get; set; }
  • 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 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 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 class TransferPathResult
  • public bool Completed { get; set; }
  • public string TargetFile { get; }

Relativity.Transfer.Aspera

• public enum AscpVersion
• 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 string ResumeSuffix { get; set; }
  • public bool UseAscp4 { get; set; }
• public static class AsperaClientConfigurationKeys
  • public const string DatagramSize = "aspera-datagram-size"
  • public const string ResumeSuffix = "aspera-resume-suffix"

Relativity.Transfer.AzureBlob

• public class AzureBlobClientConfiguration : ClientConfiguration
  • public const int DefaultDmlBlockSize = 4194304
  • public string BlobContainerName { get; set; }
  • public string BlobContainerSasUri { get; set; }
  • public int DmlBlockSize { get; set; }
  • public int DmlParallelOperations { get; set; }
  • public string StorageAccountConnectionString { get; set; }
  • public AzureBlobClientConfiguration()
  • public AzureBlobClientConfiguration(IDictionary<string, object> properties)
  • protected AzureBlobClientConfiguration(SerializationInfo info, StreamingContext context)
• public static class AzureBlobClientConfigurationKeys
  • public const string BlobContainerName = "azure-blob-container-name"
  • public const string BlobContainerSasUri = "azure-blob-sas-uri"
  • public const string DmlBlockSize = "dml-block-size"
  • public const string DmlParallelOperations = "dml-parallel-operations"
  • public const string StorageAccountConnectionString = "azure-storage-account-connection-string"
• public class AzureBlobConfigurationDetail : IConfigurationDetail
  • public AzureBlobConfigurationDetail()
  • public IEnumerable<ConfigurationDocItem> GetDocs()
• public class AzureBlobTransferClient : TransferClientBase
  • public AzureBlobTransferClient(RelativityConnectionInfo connectionInfo, ITransferLog log, ClientConfiguration configuration)
  • public AzureBlobTransferClient(RelativityConnectionInfo connectionInfo, IWorkspaceService workspaceService, ITransferLog log, ClientConfiguration configuration)
• public class AzureBlobTransferCommand : TransferPathCommandBase
  • public AzureBlobTransferCommand(ITransferLog log, ITransferRequest request, ITransferJobService jobService, IFileSystemService fileSystemService, AzureBlobClientConfiguration configuration)
• public class AzureBlobUncPathResolver : RemotePathResolverBase
  • public int DocRootLevels { get; set; }
  • public string FileShareUncPath { get; set; }
  • public bool ValidateFolderNames { get; set; }
  • public AzureBlobUncPathResolver(string fileShareUncPath)

Relativity.Transfer.AzureFiles

• public class AzureFilesClientConfiguration : ClientConfiguration
  • public const int DefaultDmlBlockSize = 4194304
  • public int DmlBlockSize { get; set; }
  • public int DmlParallelOperations { get; set; }
  • public string FileShareName { get; set; }
  • public string StorageAccountConnectionString { get; set; }
  • public AzureFilesClientConfiguration()
  • public AzureFilesClientConfiguration(IDictionary<string, object> properties)
  • protected AzureFilesClientConfiguration(SerializationInfo info, StreamingContext context)
• public static class AzureFilesClientConfigurationKeys
  • public const string DmlBlockSize = "dml-block-size"
  • public const string DmlParallelOperations = "dml-parallel-operations"
  • public const string FileShareName = "azure-files-share-name"
  • public const string StorageAccountConnectionString = "azure-storage-account-connection-string"
• public class AzureFilesConfigurationDetail : IConfigurationDetail
  • public AzureFilesConfigurationDetail()
  • public IEnumerable<ConfigurationDocItem> GetDocs()
• public class AzureFilesTransferClient : TransferClientBase
  • public AzureFilesTransferClient(RelativityConnectionInfo connectionInfo, ITransferLog log, ClientConfiguration configuration)
  • public AzureFilesTransferClient(RelativityConnectionInfo connectionInfo, IWorkspaceService workspaceService, ITransferLog log, ClientConfiguration configuration)
• public class AzureFilesTransferCommand : TransferPathCommandBase
  • public AzureFilesTransferCommand(ITransferLog log, ITransferRequest request, ITransferJobService jobService, IFileSystemService fileSystemService, AzureFilesClientConfiguration configuration)
• public class AzureFilesUncPathResolver : RemotePathResolverBase
  • public int DocRootLevels { get; set; }
  • public string FileShareUncPath { get; set; }
  • public bool ValidateFolderNames { get; set; }
  • public AzureFilesUncPathResolver(string fileShareUncPath)

Relativity.Transfer.Paths

• public interface IPathStatusChecker

Relativity.Transfer.Resources

• public class CoreStrings
  • public static string LocalDriveInformation { get; }
  • public static string MinDataRateBelowZeroExceptionMessage { get; }
  • public static string MinDataRateOverMaxAllowedValueExceptionMessage { get; }
  • public static string MinDataRateArgumentExceptionMessage { get; }
  • public static string SourcePathDoesNotContainAFilenameMessage { get; }
  • public static string TargetDataRateBelowZeroExceptionMessage { get; }
  • public static string TargetDataRateOverMaxAllowedValueExceptionMessage { get; }
  • public static string TargetDataRateArgumentExceptionMessage { get; }
  • public static string TransferJobErrorMessage { get; }
  • public static string UnsupportedFileExtensionError { get; }
  • public static string UnsupportedFileExtensionMessage { get; }
  • public static string UnsupportedValidationResult { get; }