Relativity.DataExchange.Transfer.TapiBridgeParameters2

TapiBridgeParameters2

public class TapiBridgeParameters2

Represents the generic parameters to setup a Transfer API bridge.

public string Application { get; set; }

Gets or sets the optional application name for this request. When specified, this value is attached to the APM metrics and other reporting features for added insight.

public string AsperaBcpRootFolder { get; set; }

Gets or sets the Aspera BCP root folder.

public int AsperaDatagramSize { get; set; }

Gets or sets the size of the largest datagram size that will be used by Aspera.

public int AsperaDocRootLevels { get; set; }

Gets or sets the number of levels the Aspera doc root folder is relative to the file share.

public bool BadPathErrorsRetry { get; set; }

Gets or sets a value indicating whether Transfer API should retry on bad path errors.

public Guid ClientRequestId { get; set; }

Gets or sets the client request unique identifier.

public NetworkCredential Credentials { get; set; }

Gets or sets the Relativity network credentials.

public bool FileNotFoundErrorsDisabled { get; set; }

Gets or sets a value indicating whether to treat missing files as warnings or errors.

public bool FileNotFoundErrorsRetry { get; set; }

Gets or sets a value indicating whether to retry missing file errors.

public string FileShare { get; set; }

Gets or sets the file share UNC path. This value should come directly from the Workspace.

public bool ForceAsperaClient { get; set; }

Gets or sets a value indicating whether to force using the Aspera client.

public string ForceClientCandidates { get; set; }

Gets or sets the semi-colon delimited list of client candidates. Native Transfer API client identifiers must be used (IE FileShare;Aspera;Http).

public bool ForceFileShareClient { get; set; }

Gets or sets a value indicating whether to force using the file share client.

public bool ForceHttpClient { get; set; }

Gets or sets a value indicating whether to force using the HTTP client.

public int HttpErrorNumberOfRetries { get; set; }

Gets or sets the max number of http retries.

public bool LargeFileProgressEnabled { get; set; }

Gets or sets a value indicating whether large file progress is enabled.

public string LogConfigFile { get; set; }

Gets or sets the full path to the log configuration file.

public int MaxInactivitySeconds { get; set; }

Gets or sets the maximum number of seconds to wait before considering a transfer where data isn't being written inactive.

public int MaxJobParallelism { get; set; }

Gets or sets the max degree of parallelism when creating a job.

public int MaxJobRetryAttempts { get; set; }

Gets or sets the max number of job retries.

public int MinDataRateMbps { get; set; }

Gets or sets the minimum data rate in Mbps units.

public bool PermissionErrorsRetry { get; set; }

Gets or sets a value indicating whether Transfer API should retry on file permission errors.

public bool PreserveFileTimestamps { get; set; }

Gets or sets a value indicating whether to preserve import and export file timestamps.

public bool SubmitApmMetrics { get; set; }

Gets or sets a value indicating whether to submit APM metrics to Relativity once the transfer job completes. This is true by default.

public string SupportCheckPath { get; set; }

Gets or sets the support check path.

public int TargetDataRateMbps { get; set; }

Gets or sets the target data rate in Mbps units.

public string TargetPath { get; set; }

Gets or sets the target path.

public int TimeoutSeconds { get; set; }

Gets or sets the timeout in seconds.

public Credential TransferCredential { get; set; }

Gets or sets the transfer credential.

public string TransferLogDirectory { get; set; }

Gets or sets the transfer log directory.

public int WaitTimeBetweenRetryAttempts { get; set; }

Gets or sets the amount of time, in seconds, to wait wait between retry attempts.

public CookieContainer WebCookieContainer { get; set; }

Gets or sets the cookie container.

public string WebServiceUrl { get; set; }

Gets or sets the web service URL.

public int WorkspaceId { get; set; }

Gets or sets the workspace artifact identifier.

public TapiBridgeParameters2()

Initializes a new instance of the TapiBridgeParameters2 class.

public TapiBridgeParameters2(TapiBridgeParameters2 copy)

Initializes a new instance of the TapiBridgeParameters2 class.