IStructuredAnalyticsManager Interface

Structured Analytics API Documentation
Exposes methods on the structured analytics manager service that execute the analysis of analytics sets, retrieve any errors that occurred, and cancel the analysis.

Namespace:  Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics
Assembly:  Relativity.Threads.Services.Interfaces (in Relativity.Threads.Services.Interfaces.dll) Version: 10.0.0.0 (10.0.0.0)
Syntax

public interface IStructuredAnalyticsManager : IDisposable

The IStructuredAnalyticsManager type exposes the following members.

Methods

  NameDescription
Public methodCancelAndWaitAsync(Int32, Int32)
Cancels the analysis of a structured analytics set.
Public methodCancelAndWaitAsync(Int32, Int32, IProgress<T>)
Public methodCancelAndWaitAsync(Int32, Int32, CancellationToken)
Cancels the analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodCancelAndWaitAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodCancelAsync(Int32, Int32)
Cancels the analysis of a structured analytics set.
Public methodCancelAsync(Int32, Int32, IProgress<T>)
Public methodCancelAsync(Int32, Int32, CancellationToken)
Cancels the analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodCancelAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodCancelCopyToLegacyAsync(Int32, Int32)
Cancels process to copy results from SAS Results RDO to old legacy result fields on document.
Public methodCancelCopyToLegacyAsync(Int32, Int32, IProgress<T>)
Public methodCancelCopyToLegacyAsync(Int32, Int32, CancellationToken)
Cancels process to copy results from SAS Results RDO to old legacy result fields on document.
Public methodCancelCopyToLegacyAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodGetDocumentErrorsAsync(Int32, Int32, Int32, Int32)
Retrieves document level errors for an analysis of a structured analytics set.
Public methodGetDocumentErrorsAsync(Int32, Int32, Int32, Int32, IProgress<T>)
Public methodGetDocumentErrorsAsync(Int32, Int32, Int32, Int32, CancellationToken)
Retrieves document level errors for an analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodGetDocumentErrorsAsync(Int32, Int32, Int32, Int32, CancellationToken, IProgress<T>)
Public methodGetErrorsAsync(Int32, Int32, Int32, Int32)
Retrieves the current errors for the specified structured analytics set.
Public methodGetErrorsAsync(Int32, Int32, Int32, Int32, IProgress<T>)
Public methodGetErrorsAsync(Int32, Int32, Int32, Int32, CancellationToken)
Retrieves the current errors for the specified structured analytics set, and uses a token to propagate a cancellation request.
Public methodGetErrorsAsync(Int32, Int32, Int32, Int32, CancellationToken, IProgress<T>)
Public methodGetStatusAsync(Int32, Int32)
Retrieves the status for an analysis of a structured analytics set.
Public methodGetStatusAsync(Int32, Int32, IProgress<T>)
Public methodGetStatusAsync(Int32, Int32, CancellationToken)
Retrieves the status for an analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodGetStatusAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodGetValidTasksAsync(Int32, Int32)
Retrieves the tasks that are currently valid for the structured analytics set
Public methodGetValidTasksAsync(Int32, Int32, IProgress<T>)
Public methodGetValidTasksAsync(Int32, Int32, CancellationToken)
Retrieves the tasks that are currently valid for the structured analytics set
Public methodGetValidTasksAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodRetryErrorsAsync(Int32, Int32)
Retrieves errors for an analysis of a structured analytics set.
Public methodRetryErrorsAsync(Int32, Int32, IProgress<T>)
Public methodRetryErrorsAsync(Int32, Int32, CancellationToken)
Retrieves errors for an analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodRetryErrorsAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodRunAnalysisPreparationAsync(Int32, Int32)
Executes the process to prepare the analysis for a structured analytics set.
Public methodRunAnalysisPreparationAsync(Int32, Int32, IProgress<T>)
Public methodRunAnalysisPreparationAsync(Int32, Int32, CancellationToken)
Executes the process to prepare the analysis for a structured analytics set.
Public methodRunAnalysisPreparationAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodRunAsync(Int32, Int32, AnalysisSettings)
Executes an analysis of a structured analytics set.
Public methodRunAsync(Int32, Int32, AnalysisSettings, IProgress<T>)
Public methodRunAsync(Int32, Int32, AnalysisSettings, CancellationToken)
Executes an analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodRunAsync(Int32, Int32, AnalysisSettings, CancellationToken, IProgress<T>)
Public methodRunCopyToLegacyAsync(Int32, Int32)
Executes process to copy results from SAS Results RDO to old legacy result fields on document.
Public methodRunCopyToLegacyAsync(Int32, Int32, IProgress<T>)
Public methodRunCopyToLegacyAsync(Int32, Int32, CancellationToken)
Executes process to copy results from SAS Results RDO to old legacy result fields on document.
Public methodRunCopyToLegacyAsync(Int32, Int32, CancellationToken, IProgress<T>)
Public methodRunFullAsync(Int32, Int32) Obsolete.
DEPRECATED - Executes a full analysis of a structured analytics set.
Public methodRunFullAsync(Int32, Int32, IProgress<T>) Obsolete.
Public methodRunFullAsync(Int32, Int32, CancellationToken) Obsolete.
DEPRECATED - Executes a full analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodRunFullAsync(Int32, Int32, CancellationToken, IProgress<T>) Obsolete.
Public methodRunIncrementalAsync(Int32, Int32) Obsolete.
DEPRECATED - Executes an incremental analysis of a structured analytics set.
Public methodRunIncrementalAsync(Int32, Int32, IProgress<T>) Obsolete.
Public methodRunIncrementalAsync(Int32, Int32, CancellationToken) Obsolete.
DEPRECATED - Executes an incremental analysis of a structured analytics set, and uses a token to propagate a cancellation request.
Public methodRunIncrementalAsync(Int32, Int32, CancellationToken, IProgress<T>) Obsolete.
Top
See Also

Reference