Add more information about continuation tokens (Azure#30995)

Relates to Azure#28355
azure-sdk · Sep 8, 2022 · 6f51d58 · 6f51d58
1 parent e811f01
commit 6f51d58
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 1 deletion.
diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsOperation.cs
@@ -111,6 +111,8 @@ public class AnalyzeActionsOperation : PageableOperation<AnalyzeActionsResult>,
         /// </summary>
         /// <param name="operationId">The ID of this operation.</param>
         /// <param name="client">The client used to check for completion.</param>
+        /// <exception cref="ArgumentException"><paramref name="operationId"/> is an empty string or does not represent a valid continuation token from the <see cref="Id"/> property returned on the original operation.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="operationId"/> or <paramref name="client"/> is null.</exception>
         public AnalyzeActionsOperation(string operationId, TextAnalyticsClient client)
         {
             Argument.AssertNotNullOrEmpty(operationId, nameof(operationId));

diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeHealthcareEntitiesOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeHealthcareEntitiesOperation.cs
@@ -87,6 +87,8 @@ public class AnalyzeHealthcareEntitiesOperation : PageableOperation<AnalyzeHealt
         /// </summary>
         /// <param name="operationId">The ID of this operation.</param>
         /// <param name="client">The client used to check for completion.</param>
+        /// <exception cref="ArgumentException"><paramref name="operationId"/> is an empty string or does not represent a valid continuation token from the <see cref="Id"/> property returned on the original operation.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="operationId"/> or <paramref name="client"/> is null.</exception>
         public AnalyzeHealthcareEntitiesOperation(string operationId, TextAnalyticsClient client)
         {
             Argument.AssertNotNullOrEmpty(operationId, nameof(operationId));

diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ClassifyDocumentOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ClassifyDocumentOperation.cs
@@ -87,6 +87,8 @@ public class ClassifyDocumentOperation : PageableOperation<ClassifyDocumentResul
         /// </summary>
         /// <param name="operationId">The ID of this operation.</param>
         /// <param name="client">The client used to check for completion.</param>
+        /// <exception cref="ArgumentException"><paramref name="operationId"/> is an empty string or does not represent a valid continuation token from the <see cref="Id"/> property returned on the original operation.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="operationId"/> or <paramref name="client"/> is null.</exception>
         public ClassifyDocumentOperation(string operationId, TextAnalyticsClient client)
         {
             Argument.AssertNotNullOrEmpty(operationId, nameof(operationId));

diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/OperationContinuationToken.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/OperationContinuationToken.cs
@@ -13,8 +13,8 @@ namespace Azure.AI.TextAnalytics
 {
     internal class OperationContinuationToken
     {
+        // This represents the version of the token, not the service API version. The value itself is actually arbitrary.
         private const ServiceVersion LatestTokenVersion = ServiceVersion.V3_1;
-
         private static readonly string s_latestTokenVersion = TextAnalyticsClientOptions.GetVersionString(LatestTokenVersion);
 
         private static readonly JsonSerializerOptions s_jsonOptions = new JsonSerializerOptions()

diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeCustomEntitiesOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/RecognizeCustomEntitiesOperation.cs
@@ -87,6 +87,8 @@ public class RecognizeCustomEntitiesOperation : PageableOperation<RecognizeCusto
         /// </summary>
         /// <param name="operationId">The ID of this operation.</param>
         /// <param name="client">The client used to check for completion.</param>
+        /// <exception cref="ArgumentException"><paramref name="operationId"/> is an empty string or does not represent a valid continuation token from the <see cref="Id"/> property returned on the original operation.</exception>
+        /// <exception cref="ArgumentNullException"><paramref name="operationId"/> or <paramref name="client"/> is null.</exception>
         public RecognizeCustomEntitiesOperation(string operationId, TextAnalyticsClient client)
         {
             Argument.AssertNotNullOrEmpty(operationId, nameof(operationId));