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

---

API Differences between 5.0.2 and 7.4.5

432 Additions 188 Removals

Relativity.Transfer

• public class HttpClientConfiguration
• public interface IRelativityTransferHost : IDisposable
  • IFileStorageSearch CreateFileStorageSearch(ClientConfiguration configuration)
  • Task<Workspace> GetWorkspaceAsync(int workspaceArtifactId, ClientConfiguration configuration, CancellationToken token)
  • Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration)
  • Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration, CancellationToken token)
  • Task VersionCheckAsync(ClientConfiguration configuration)
  • Task VersionCheckAsync(ClientConfiguration configuration, CancellationToken token)
• public class RelativityTransferHost : IRelativityTransferHost, IDisposable
  • public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration)
  • public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, CancellationToken token)
  • public static Task VersionCheckAsync(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log, CancellationToken token)
  • public IFileStorageSearch CreateFileStorageSearch(ClientConfiguration configuration)
  • public Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration)
  • public Task<Workspace> GetWorkspaceAsync(ClientConfiguration configuration, CancellationToken token)
  • public Task<Workspace> GetWorkspaceAsync(int workspaceArtifactId, ClientConfiguration configuration, CancellationToken token)
  • public Task VersionCheckAsync(ClientConfiguration configuration)
  • public Task VersionCheckAsync(ClientConfiguration configuration, CancellationToken token)
• public sealed class AsperaCredential : IEquatable<AsperaCredential>
  • public const string AsperaNodeCredentialType = "AsperaNode"
• public sealed class AsperaCredentials
  • public AsperaCredential NodeCredential { get; }
  • public AsperaCredential TransferCredential { get; }
  • public AsperaCredentials(AsperaCredential transfer, AsperaCredential node)
• public class AsperaNodeException : Exception
  • public AsperaNodeException()
  • public AsperaNodeException(string message)
  • public AsperaNodeException(string message, Exception innerException)
  • protected AsperaNodeException(SerializationInfo info, StreamingContext context)
• public class BasicAuthenticationCredential : IHttpCredential
  • public Credentials CreateRelativityCredentials()
  • public void RefreshCredentials()
• public class BearerTokenCredential : IHttpCredential
  • public BearerTokenCredential()
  • public BearerTokenCredential(string token, IAuthenticationTokenProvider authTokenProvider)
  • public Credentials CreateRelativityCredentials()
  • public void RefreshCredentials()
• public class ClientConfiguration : Dictionary<string, object>
  • public const bool DefaultPreCalculateJobSize = false
  • public const bool DefaultUseLegacyWebApi = false
  • public bool PreCalculateJobSize { get; set; }
  • public bool SavingMemoryMode { get; set; }
  • public bool UseLegacyWebApi { 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 const string UseLegacyWebApi = "use-legacy-webapi"
• 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 abstract class ConnectionServiceBase : IDisposable
  • protected virtual Task RunPortsTestAsync(CancellationToken token)
  • protected virtual Task RunPostTestsAsync(CancellationToken token)
• public class DiagnosticsConfiguration
  • public bool UseLegacyWebApi { 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 sealed class FileShareResourceServer
  • public AsperaCredential AsperaCredential { get; }
  • public AsperaCredentials AsperaCredentials { get; }
  • 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 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 class GlobalSettings
  • public const bool DefaultApmFireAndForgetEnabled = true
  • public const bool DefaultLogPackageSourceFiles = true
  • public const int DefaultMaxAllowedTargetDataRateMbps = 600
  • public const int DefaultMaxFilesPerBatch = 50000
  • public const long DefaultMaxFilesPerBatch = 50000
  • public bool ApmFireAndForgetEnabled { get; set; }
  • public bool LogPackageSourceFiles { get; set; }
  • public int MaxAllowedTargetDataRateMbps { get; set; }
  • public int MaxFilesPerBatch { get; set; }
  • public long MaxFilesPerBatch { get; set; }
  • public int NodePageSize { get; set; }
• public interface IAuthenticationTokenProvider
• public interface IBatchSerializer
• public interface ICredentialService
  • Task<AsperaCredential> GetResourceServerAsperaCredentialAsync(int resourceServerArtifactId, CancellationToken token)
  • Task<AsperaCredentials> GetResourceServerAsperaCredentialsAsync(int resourceServerArtifactId, CancellationToken token)
• public interface IFileShareService
• public interface IHttpCredential
  • Credentials CreateRelativityCredentials()
  • void RefreshCredentials()
• public class IntegratedSecurityCredential : IHttpCredential
  • public Credentials CreateRelativityCredentials()
  • public void RefreshCredentials()
• public interface IPackageLibrary : IDisposable
  • string DisplayName { get; }
  • Guid Id { get; }
  • string Name { get; }
  • WellKnownPackageLibrary PackageLibrary { get; }
  • event EventHandler<PackageQueuedEventArgs> QueuePackageFile
  • IPackageResult PackageFiles(ITransferRequest request, PackageContext context, CancellationToken token)
  • IPackageResult PackageFiles(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
• public interface IPackageLibraryMetadata
  • string Description { get; }
  • string DisplayName { get; }
  • string Id { get; }
  • string Name { get; }
  • WellKnownPackageLibrary PackageLibrary { get; }
  • string Version { get; }
• public interface IPackageResult
  • long PackagedSourceFiles { get; }
  • IList<string> PackageFileNames { get; }
  • TimeSpan PackageTime { get; }
• public interface IPackageTransferResult : ITransferResult, IPackageResult
• public interface IPathValidationFactory
• public interface IPathValidationProvider : IPathValidator
• public interface IPathValidator
• public interface IRelativityManagerService : IDisposable
  • Task<string> GetBcpSharePathAsync(int workspaceId, CancellationToken token)
• public interface IRelativityServiceFactory
  • IPathValidationProvider PathValidationProvider { get; }
  • IFileShareService CreateFileShareService(int fileShareId)
  • IInstanceSettingService CreateInstanceSettingService()
  • IRelativityManagerService CreateRelativityManagerService(IUserManagerService service)
  • ITargetRateThrottler CreateTargetRateThrottler()
  • ITargetRateValidator CreateTargetRateValidator()
  • IUserManagerService CreateUserManagerService()
• public interface ITargetRateThrottler
• public interface ITargetRateValidator
• 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
• 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)
  • void Initialize()
• public interface ITransferResult
  • int Attempts { get; }
  • List<long> TotalRequestedBytesPerAttempt { get; }
  • List<long> TotalRequestedFilesPerAttempt { get; }
• public class LargeFileProgress : IProgress<LargeFileProgressEventArgs>
• 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 const bool DefaultCompression = false
  • public const bool DefaultDeletePackageFiles = true
  • public const string DefaultFileName = "tapi-package"
  • public const long DefaultMultiFileMaxBytes = 1073741824
  • public bool Compression { get; set; }
  • public bool DeletePackageFiles { get; set; }
  • public string FileName { get; set; }
  • public long MultiFileMaxBytes { get; set; }
  • public string Name { get; set; }
  • public WellKnownPackageLibrary PackageLibrary { get; set; }
  • public Guid PackageLibraryId { get; set; }
  • public string Password { get; set; }
  • public PackageConfiguration()
  • public PackageConfiguration(IDictionary<string, object> dictionary)
  • public void Copy(IDictionary<string, object> properties)
  • public void Copy(IDictionary<string, object> properties, bool overwrite)
• public sealed class PackageContext
  • public PackageConfiguration Configuration { get; }
  • public IDictionary<string, object> Metadata { get; }
  • public event EventHandler<PackageEventArgs> PackageCreated
  • public event EventHandler<PackageProgressEventArgs> PackageProgress
  • public event EventHandler<PackagingFileMetadataEventArgs> PackagingFile
  • public PackageContext(PackageConfiguration configuration)
  • public PackageContext(PackageConfiguration configuration, IDictionary<string, object> metadata)
  • public void PublishPackageCreated(ITransferRequest request, string file)
  • public void PublishPackageProgress(ITransferRequest request, long packagedSourceFiles, long sourceFiles)
  • public void PublishPackagingFile(ITransferRequest request, PackageFileMetadata sourceMetadata, string targetPackageFile)
• public class PackageEventArgs : EventArgs
  • public string File { get; }
  • public ITransferRequest Request { get; }
  • public PackageEventArgs(ITransferRequest request, string file)
• public class PackageFileMetadata
  • public DateTime? CreationTime { get; set; }
  • public string ExtractDirectory { get; set; }
  • public string File { get; set; }
  • public string FileName { get; set; }
  • public DateTime? LastAccessTime { get; set; }
  • public DateTime? LastWriteTime { get; set; }
  • public PackageFileMetadata(string file, string fileName)
• public abstract class PackageLibraryBase : IPackageLibrary, IDisposable
  • public string DisplayName { get; }
  • protected IFileSystemService FileSystemService { get; }
  • public Guid Id { get; }
  • public string Name { get; }
  • public WellKnownPackageLibrary PackageLibrary { get; }
  • protected IList<string> QueuedPackageFiles { get; }
  • protected string TempDirectory { get; }
  • public event EventHandler<PackageQueuedEventArgs> QueuePackageFile
  • protected PackageLibraryBase(ITransferLog log, IFileSystemService fileSystemService, Guid id, WellKnownPackageLibrary library, string name, string displayName)
  • public void Dispose()
  • protected virtual void Dispose(bool disposing)
  • protected string GetTempFilePath(string fileName)
  • protected abstract void OnEndPackaging(ITransferRequest request)
  • protected abstract void OnPackageSourceFile(PackageFileMetadata metadata, CancellationToken token)
  • protected abstract void OnStartPackaging(ITransferRequest request, PackageConfiguration configuration, IDictionary<string, object> metadata, CancellationToken token)
  • protected void PackageCreated(ITransferRequest request, string file)
  • public IPackageResult PackageFiles(ITransferRequest request, PackageContext context, CancellationToken token)
  • public IPackageResult PackageFiles(ITransferRequest request, IEnumerable<SerializedBatch> batches, PackageContext context, CancellationToken token)
  • protected void PublishQueuePackageFile(ITransferRequest request, string file)
  • protected void PublishQueuePackageFile(ITransferRequest request, IEnumerable<string> files)
• public sealed class PackageLibraryMetadataAttribute : ExportAttribute, IPackageLibraryMetadata
  • public string Description { get; set; }
  • public string DisplayName { get; set; }
  • public string Id { get; set; }
  • public string Name { get; set; }
  • public WellKnownPackageLibrary PackageLibrary { get; set; }
  • public string Version { get; set; }
  • public PackageLibraryMetadataAttribute()
• public class PackageProgressEventArgs : EventArgs
  • public long PackagedSourceFiles { get; }
  • public double Progress { get; }
  • public ITransferRequest Request { get; }
  • public long SourceFiles { get; }
  • public PackageProgressEventArgs(ITransferRequest request, long packagedSourceFiles, long sourceFiles)
• public class PackageQueuedEventArgs : EventArgs
  • public IEnumerable<string> Files { get; }
  • public ITransferRequest Request { get; }
  • public PackageQueuedEventArgs(ITransferRequest request, IEnumerable<string> files)
• public sealed class PackageResult : IPackageResult
  • public long PackagedSourceFiles { get; set; }
  • public IList<string> PackageFileNames { get; }
  • public TimeSpan PackageTime { get; set; }
  • public PackageResult()
  • public void AddPackageFileName(string file)
• public sealed class PackageTransferResult : IPackageTransferResult, ITransferResult, IPackageResult
  • public ClientConfiguration Configuration { get; }
  • public TimeSpan Elapsed { get; }
  • public DateTime? EndTime { get; }
  • public IReadOnlyList<ITransferIssue> Issues { get; }
  • public int MinDataRateMbps { get; }
  • public long PackagedSourceFiles { get; }
  • public IList<string> PackageFileNames { get; }
  • public TimeSpan PackageTime { get; }
  • public ITransferRequest Request { get; }
  • public int RetryCount { get; }
  • public DateTime? StartTime { get; }
  • public IReadOnlyList<ITransferStatistics> Statistics { get; }
  • public TransferStatus Status { get; }
  • public int TargetDataRateMbps { get; }
  • public long TotalBadPathErrors { get; }
  • public long TotalFailedFiles { get; }
  • public long TotalFatalErrors { get; }
  • public long TotalFilePermissionErrors { get; }
  • public long TotalFilesNotFound { get; }
  • public long TotalSkippedFiles { get; }
  • public long TotalTransferredBytes { get; }
  • public long TotalTransferredFiles { get; }
  • public ITransferIssue TransferError { get; }
  • public double TransferRateMbps { get; }
  • public PackageTransferResult(ITransferResult result, IPackageResult packageResult)
• public class PackagingFileMetadataEventArgs : EventArgs
  • public ITransferRequest Request { get; }
  • public PackageFileMetadata SourceFileMetadata { get; }
  • public string TargetPackageFile { get; }
  • public PackagingFileMetadataEventArgs(ITransferRequest request, PackageFileMetadata sourceFileMetadata, string targetPackageFile)
• public abstract class PathEnumeratorBase : IPathEnumerator
  • protected ClientLimits ClientLimits { get; }
  • protected PathEnumeratorBase(ITransferLog log, ClientLimits limits, IFileSystemService fileSystemService)
  • protected virtual void OnInitialize(PathEnumeratorContext context, CancellationToken token)
  • protected abstract Task OnInitializeAsync(PathEnumeratorContext context, CancellationToken token)
• 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 RelativityFileShare : RelativityFileShareBase
  • 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 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 abstract class RelativityFileShareBase : FileStorageBase
  • public AsperaCredential AsperaCredential { get; protected set; }
  • public AsperaCredentials AsperaCredentials { get; protected set; }
  • public AsperaCredential NodeCredential { get; }
  • public AsperaCredential TransferCredential { get; }
• public abstract class RemotePathResolverBase : IRemotePathResolver
  • protected ITransferLog transferLog
  • protected RemotePathResolverBase(ITransferLog transferLog)
  • protected RemotePathResolverBase()
• public abstract class RestServiceBase
  • protected RestServiceBase(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log)
• 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 sealed class SqlResourceServer
  • public AsperaCredential AsperaCredential { get; }
  • public AsperaCredentials AsperaCredentials { get; }
  • public SqlResourceServer(int artifactId, AsperaCredential credential, string name, ResourceServerType serverType, string bcpPath, bool cloudInstance)
  • public SqlResourceServer(int artifactId, AsperaCredentials credentials, 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, 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 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 HttpClientDisplayName = "Web"
  • public const string HttpClientDiplayName = "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 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 void Initialize()
• 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; }
• 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 enum WellKnownPackageLibrary
  • Rcc = 1
  • ThirdParty = 2
  • Unassigned = 0
• public enum WellKnownTransferClient
  • AzureBlob = 1
  • AzureFiles = 2
• public class WorkspaceService : RestServiceBase, IWorkspaceService
  • public WorkspaceService(RelativityConnectionInfo connectionInfo, ClientConfiguration configuration, ITransferLog log)

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 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(ITransferLog transferLog)
  • public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder, ITransferLog transferLog)
  • public AsperaUncBcpPathResolver()
  • public AsperaUncBcpPathResolver(string bcpUncPath, string rootFolder)
• public class AsperaUncPathResolver : RemotePathResolverBase
  • public AsperaUncPathResolver(ITransferLog transferLog)
  • public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels, ITransferLog transferLog)
  • public AsperaUncPathResolver()
  • public AsperaUncPathResolver(string fileShareUncPath, int docRootLevels)
• public static class XferParamsExtensions

Relativity.Transfer.Aspera.Enumeration.Filters

• public class AspxExtensionFilter : INodeFilter, IFilter<INode>
• public class PathLengthFilter : INodeFilter, IFilter<INode>

Relativity.Transfer.Aspera.Issues

• public static class IssuesDumper

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.Dto

• public class BrowseDirectoryResponseDto : FileShareResponseBaseDto
• public class FileShareItem
• public enum FileShareOperationErrorCode
• public enum FileShareOperationState
• public class FileShareResponseBaseDto
• public class GetItemRequestDto
• public class GetItemResponseDto : FileShareResponseBaseDto
• public class GetItemsRequestDto
• public class GetItemsResponseDto : FileShareResponseBaseDto
• public class ItemExistsRequestDto
• public class ItemExistsResponseDto : FileShareResponseBaseDto
• public class ItemsExistRequestDto
• public class ItemsExistResponseDto : FileShareResponseBaseDto
• public class QueryPropertiesResponseDto : FileShareResponseBaseDto

Relativity.Transfer.Enumeration

• public sealed class EnumerationBuilder : IEnumerationFinalActionsBuilder, IEnumerationNecessaryActionsBuilder
• public class EnumerationException : Exception
• public class EnumerationIssue
• public class EnumerationOrchestrator : IEnumerationOrchestrator
• public class EnumerationStatistic
• public class PathDoesNotExistException : EnumerationException
• public class SynchronousHandler<T> : IEnumerationHandler<T>

Relativity.Transfer.Enumeration.Filters

• public interface IFilter<T>
• public interface INodeFilter : IFilter<INode>
• public class NoReadAccessFileNodeFilter : INodeFilter, IFilter<INode>
• public class R1PathSizeFilter : INodeFilter, IFilter<INode>

Relativity.Transfer.Enumeration.Interfaces

• public interface IBatchAggregator
• public interface IEnumerationFinalActionsBuilder
• public interface IEnumerationHandler<T>
• public interface IEnumerationNecessaryActionsBuilder
• public interface IEnumerationOrchestrator
• public interface IEnumeratorProvider

Relativity.Transfer.Exceptions

• public class FileshareConfigurationException : Exception

Relativity.Transfer.Paths

• public interface IPathStatusChecker
• public static class NodeExtensions

Relativity.Transfer.Resources

• public class CoreStrings
  • public static string ArtifactOutOfRangeExceptionMessage { get; }
  • public static string AsperaAccountCredentialTypeArgumentExceptionMessage { get; }
  • public static string AsperaAccountHostArgumentExceptionMessage { get; }
  • public static string AsperaAccountHostNotWellFormedExceptionMessage { get; }
  • public static string AsperaAccountPasswordArgumentExceptionMessage { get; }
  • public static string AsperaAccountUserNameArgumentExceptionMessage { get; }
  • public static string AsperaNodeBrowseFilesActionMessage { get; }
  • public static string AsperaNodeDetailExceptionMessage { get; }
  • public static string AsperaNodeExceptionMessage { get; }
  • public static string AsperaNodeServiceFileNotFoundExceptionMessage { get; }
  • public static string AsperaNodeServiceFilesInfoActionMessage { get; }
  • public static string AsperaNodeServicePathIsNotAFileExceptionMessage { get; }
  • public static string AutoCorrectPagingSizeMessage { get; }
  • public static string ChangeTransferRateNotSupported { get; }
  • public static string ClientIdArgumentExceptionMessage { get; }
  • public static string ConnectionCheckCancellationRequestMessage { get; }
  • public static string ConnectionCheckDeletedTempFileMessage { get; }
  • public static string ConnectionCheckDownloadFailedMessage { get; }
  • public static string ConnectionCheckDownloadMessage { get; }
  • public static string ConnectionCheckDownloadSuccessMessage { get; }
  • public static string ConnectionCheckExceptionMessage { get; }
  • public static string ConnectionCheckFailedMessage { get; }
  • public static string ConnectionCheckGetWorkspaceMessage { get; }
  • public static string ConnectionCheckGetWorkspaceSuccessMessage { get; }
  • public static string ConnectionCheckPassedMessage { get; }
  • public static string ConnectionCheckStartMessage { get; }
  • public static string ConnectionCheckUploadFailedMessage { get; }
  • public static string ConnectionCheckUploadMessage { get; }
  • public static string ConnectionCheckUploadSuccessMessage { get; }
  • public static string ConnectionCheckUsingFileShare { get; }
  • public static string CredentialHttpPostExceptionMessage { get; }
  • public static string CredentialTypeExceptionMessage { get; }
  • public static string CsvFileNotOpenedExceptionMessage { get; }
  • public static string CsvRequiredHeaderMissingExceptionMessage { get; }
  • public static CultureInfo Culture { get; set; }
  • public static string DistributedLoginFailedMessage { get; }
  • public static string DistributedTokenInvalidMessage { get; }
  • public static string EngineJobFailedExceptionMessage { get; }
  • public static string FileInfoInvalidExceptionMessage { get; }
  • public static string FileShareNodeAndTransferCredentialDoesNotExistErrorMessage { get; }
  • public static string FileShareNodeCredentialDoesNotExistErrorMessage { get; }
  • public static string FileShareNodeSystemInfoDoesNotExistErrorMessage { get; }
  • public static string FileShareNullExceptionMessage { get; }
  • public static string FileShareNumberNotFoundExceptionMessage { get; }
  • public static string FileShareResourceServerHttpPostExceptionMessage { get; }
  • public static string FileShareTransferCredentialDoesNotExistErrorMessage { get; }
  • public static string FileStorageNoResourcePoolExceptionMessage { get; }
  • public static string HttpBadRequestFatalMessage { get; }
  • public static string HttpCredentialNotSupportedExceptionMessage { get; }
  • public static string HttpCredentialNotSupportedMessage { get; }
  • public static string HttpExceptionMessage { get; }
  • public static string HttpForbiddenFatalMessage { get; }
  • public static string HttpNoStatusExceptionMessage { get; }
  • public static string HttpNotFoundFatalMessage { get; }
  • public static string HttpTimeoutExceptionMessage { get; }
  • public static string HttpUnauthorizedFatalMessage { get; }
  • public static string InitializeUnexpectedStateMessage { get; }
  • public static string InstanceSettingHttpPostExceptionMessage { get; }
  • public static string LogCountHttpPostExceptionMessage { get; }
  • public static string MappedDriveArgumentExceptionMessage { get; }
  • public static string MappedDriveNotFoundExceptionMessage { get; }
  • public static string MaxBytesPerBatchExceptionMessage { get; }
  • public static string MaxFilesPerBatchExceptionMessage { get; }
  • public static string MinDataRateArgumentExceptionMessage { get; }
  • public static string NodeAvailableSpaceHttpPostExceptionMessage { get; }
  • public static string NodeDeleteFileHttpPostExceptionMessage { get; }
  • public static string NodeFileInfoHttpPostExceptionMessage { get; }
  • public static string NodeFilesInfoHttpPostExceptionMessage { get; }
  • public static string NodeSystemInfoHttpPostExceptionMessage { get; }
  • public static string NoEndpointProvided { get; }
  • public static string NoMessageProvided { get; }
  • public static string ObjectDisposedExceptionMessage { get; }
  • public static string PackageLibrarytNotFoundExceptionMessage { get; }
  • public static string QueryResultErrorMessage { get; }
  • public static string RelativityConnectionCredentialsArgumentExceptionMessage { get; }
  • public static string RelativityConnectionHostArgumentExceptionMessage { get; }
  • public static string RelativityConnectionWorkspaceArgumentExceptionMessage { get; }
  • public static string RelativityFileShareValueOutOfRangeExceptionMessage { get; }
  • public static string RelativityVersionHttpPostExceptionMessage { get; }
  • public static string RemoteEnumerationAsperaNodeExceptionMessage { get; }
  • public static string RemoteEnumerationFileSkipTakeMessage { get; }
  • public static string RemoteEnumerationFolderSkipTakeMessage { get; }
  • public static string RemotePathEnumeratorNotSupported { get; }
  • public static ResourceManager ResourceManager { get; }
  • public static string ResourcePoolHttpPostExceptionMessage { get; }
  • public static string ResourceServerHttpPostExceptionMessage { get; }
  • public static string RetrieveAsperaCredentialsHttpPostExceptionMessage { get; }
  • public static string ServiceNotRegisteredExceptionMessage { get; }
  • public static string SourcePathArgumentExceptionMessage { get; }
  • public static string SourcePathNotFoundArgumentExceptionMessage { get; }
  • public static string SqlResourceAsperaCredentialDoesNotExistErrorMessage { get; }
  • public static string SqlResourceNodeCredentialDoesNotExistErrorMessage { get; }
  • public static string SqlResourceTransferCredentialDoesNotExistErrorMessage { get; }
  • public static string StartAlreadyCompletedMessage { get; }
  • public static string TargetDataRateArgumentExceptionMessage { get; }
  • public static string TargetPathArgumentExceptionMessage { get; }
  • public static string TenantIdNotFoundExceptionMessage { get; }
  • public static string TheFileDoesNotExistExceptionMessage { get; }
  • public static string TransferCancelledMessage { get; }
  • public static string TransferCommandCancellationRequestMessage { get; }
  • public static string TransferFileEngineAlreadyStartedExceptionMessage { get; }
  • public static string TransferFileEngineNotInitializedExceptionMessage { get; }
  • public static string TransferJobBaseAddPathsFailureMessage { get; }
  • public static string TransferJobBaseCompleteAsyncFailureMessage { get; }
  • public static string TransferJobCancelMessage { get; }
  • public static string TransferJobChangeDataRateFailureLogMessage { get; }
  • public static string TransferJobCompleteFailedExceptionMessage { get; }
  • public static string TransferJobFailedRetryErrorMessage { get; }
  • public static string TransferJobFailedWaitingErrorMessage { get; }
  • public static string TransferJobFatalErrorErrorMessage { get; }
  • public static string TransferJobSuccessMessage { get; }
  • public static string TransferPathCannotBeFileAndDirectoryExceptionMessage { get; }
  • public static string TransferPathEmptyFileExceptionMessage { get; }
  • public static string TransferPathFoundTooLongExceptionMessage { get; }
  • public static string TransferPathMustBeFileOrDirectoryExceptionMessage { get; }
  • public static string TransferPathProvidedTooLongExceptionMessage { get; }
  • public static string TransferPathReaderSourcePathExceptionMessage { get; }
  • public static string TransferPathSearchArgumentDoesNotExistExceptionMessage { get; }
  • public static string TransferPathSearchCountArgumentExceptionMessage { get; }
  • public static string TransferRequestNoTransferPathsArgumentExceptionMessage { get; }
  • public static string UnableToDetermineWindowsPathRootExceptionMessage { get; }
  • public static string ValidateTotalFileCountExceptionMessage { get; }
  • public static string WaitAlreadyCompletedMessage { get; }
  • public static string WaitAlreadyFailedMessage { get; }
  • public static string WaitNotStartedMessage { get; }
  • public static string WaitUnexpectedStateMessage { get; }
  • public static string WebExceptionMessage { get; }
  • public static string WebExceptionTrustFailureMessage { get; }
  • public static string WorkspaceAdminName { get; }
  • public static string WorkspaceConditionHttpGetExceptionMessage { get; }
  • public static string WorkspaceCredentialHttpPostExceptionMessage { get; }
  • public static string WorkspaceDefaultFileShareNotFoundExceptionMessage { get; }
  • public static string WorkspaceFileShareResourceServersHttpGetExceptionMessage { get; }
  • public static string WorkspaceHttpGetExceptionMessage { get; }
  • public static string WorkspaceNodeCredentialDoesNotExistErrorMessage { get; }
  • public static string WorkspaceNoDefaultFileShareExceptionMessage { get; }
  • public static string WorkspaceNoDefaultFileShareUncPathExceptionMessage { get; }
  • public static string WorkspaceNoFileShareResourceServersExceptionMessage { get; }
  • public static string WorkspaceNoSqlServerResourceServersExceptionMessage { get; }
  • public static string WorkspaceNotFoundExceptionMessage { get; }
  • public static string WorkspaceSqlResourceServersHttpGetExceptionMessage { get; }