IStructuredAnalyticsManager. CancelAndWaitAsync Method (Int32, Int32, CancellationToken)

 Structured Analytics API Documentation
Cancels the analysis of a structured analytics set, and uses a token to propagate a cancellation request.

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
Copy
Task<OperationResult> CancelAndWaitAsync(
	int workspaceId,
	int sasArtifactId,
	CancellationToken cancellationToken
)

Parameters

workspaceId
Type: System.Int32
The ID of the workspace for the structured analytics set
sasArtifactId
Type: System.Int32
The ID of the structured analytics set
cancellationToken
Type: System.Threading.CancellationToken
Token for cancelling the call to run full analysis

Return Value

Type: Task< OperationResult>
Result object defining the success state of the call
Remarks
CancelAndWaitAsync will return to the caller after the canceling of an analysis is complete. Use this method if you would like to make a subsequent operation request on this structured analytics set immediately after the cancel request is complete.
See Also

Reference

IStructuredAnalyticsManager Interface
CancelAndWaitAsync Overload
Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics Namespace