Skip to content

Commit 3b55ba5

Browse files
maririoskristapraticojsquire
authored
[DT] Move to use ResponseError (Azure#25055)
* move to use ResponseError * update changelog * Update sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationOperation.cs Co-authored-by: Krista Pratico <krpratic@microsoft.com> * Update sdk/translation/Azure.AI.Translation.Document/src/TranslationStatusResult.cs Co-authored-by: Jesse Squire <jesse.squire@gmail.com> Co-authored-by: Krista Pratico <krpratic@microsoft.com> Co-authored-by: Jesse Squire <jesse.squire@gmail.com>
1 parent 6a2213d commit 3b55ba5

32 files changed

+259
-279
lines changed

‎sdk/translation/Azure.AI.Translation.Document/CHANGELOG.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,10 @@
22

33
## 1.0.0-beta.6 (Unreleased)
44

5-
### Features Added
6-
75
### Breaking Changes
8-
9-
### Bugs Fixed
10-
11-
### Other Changes
6+
- Removed types `DocumentTranslationError` and `DocumentTranslationErrorCode`. These affected the classes `DocumentStatusResult` and `TranslationStatusResult`. Errors in both classes are now exposed as `ResponseError`.
7+
- Renamed method `DocumentStatus` to `DocumentStatusResult` in `DocumentTranslationModelFactory`, which now takes a `BinaryData` type instead of `DocumentTranslationError`.
8+
- Renamed method `TranslationStatus` to `TranslationStatusResult` in `DocumentTranslationModelFactory`, which now takes a `BinaryData` type instead of `DocumentTranslationError`.
129

1310
## 1.0.0-beta.5 (2021-09-08)
1411

‎sdk/translation/Azure.AI.Translation.Document/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ await foreach (DocumentStatusResult document in operation.Value)
219219
}
220220
else
221221
{
222-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
222+
Console.WriteLine($" Error Code: {document.Error.Code}");
223223
Console.WriteLine($" Message: {document.Error.Message}");
224224
}
225225
}
@@ -307,7 +307,7 @@ await foreach (DocumentStatusResult document in operation.GetValuesAsync())
307307
else
308308
{
309309
Console.WriteLine($" Document source Uri: {document.SourceDocumentUri}");
310-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
310+
Console.WriteLine($" Error Code: {document.Error.Code}");
311311
Console.WriteLine($" Message: {document.Error.Message}");
312312
}
313313
}
@@ -365,7 +365,7 @@ foreach (DocumentStatusResult document in operation.GetValues())
365365
else
366366
{
367367
Console.WriteLine($" Document source Uri: {document.SourceDocumentUri}");
368-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
368+
Console.WriteLine($" Error Code: {document.Error.Code}");
369369
Console.WriteLine($" Message: {document.Error.Message}");
370370
}
371371
}

‎sdk/translation/Azure.AI.Translation.Document/api/Azure.AI.Translation.Document.netstandard2.0.cs‎

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public partial class DocumentStatusResult
1414
internal DocumentStatusResult() { }
1515
public long CharactersCharged { get { throw null; } }
1616
public System.DateTimeOffset CreatedOn { get { throw null; } }
17-
public Azure.AI.Translation.Document.DocumentTranslationError Error { get { throw null; } }
17+
public Azure.ResponseError Error { get { throw null; } }
1818
public string Id { get { throw null; } }
1919
public System.DateTimeOffset LastModified { get { throw null; } }
2020
public System.Uri SourceDocumentUri { get { throw null; } }
@@ -55,38 +55,6 @@ public enum ServiceVersion
5555
V1_0 = 1,
5656
}
5757
}
58-
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
59-
public readonly partial struct DocumentTranslationError
60-
{
61-
private readonly object _dummy;
62-
private readonly int _dummyPrimitive;
63-
public Azure.AI.Translation.Document.DocumentTranslationErrorCode ErrorCode { get { throw null; } }
64-
public string Message { get { throw null; } }
65-
public string Target { get { throw null; } }
66-
}
67-
[System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
68-
public readonly partial struct DocumentTranslationErrorCode : System.IEquatable<Azure.AI.Translation.Document.DocumentTranslationErrorCode>
69-
{
70-
private readonly object _dummy;
71-
private readonly int _dummyPrimitive;
72-
public DocumentTranslationErrorCode(string value) { throw null; }
73-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode InternalServerError { get { throw null; } }
74-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode InvalidArgument { get { throw null; } }
75-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode InvalidRequest { get { throw null; } }
76-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode RequestRateTooHigh { get { throw null; } }
77-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode ResourceNotFound { get { throw null; } }
78-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode ServiceUnavailable { get { throw null; } }
79-
public static Azure.AI.Translation.Document.DocumentTranslationErrorCode Unauthorized { get { throw null; } }
80-
public bool Equals(Azure.AI.Translation.Document.DocumentTranslationErrorCode other) { throw null; }
81-
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
82-
public override bool Equals(object obj) { throw null; }
83-
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
84-
public override int GetHashCode() { throw null; }
85-
public static bool operator ==(Azure.AI.Translation.Document.DocumentTranslationErrorCode left, Azure.AI.Translation.Document.DocumentTranslationErrorCode right) { throw null; }
86-
public static implicit operator Azure.AI.Translation.Document.DocumentTranslationErrorCode (string value) { throw null; }
87-
public static bool operator !=(Azure.AI.Translation.Document.DocumentTranslationErrorCode left, Azure.AI.Translation.Document.DocumentTranslationErrorCode right) { throw null; }
88-
public override string ToString() { throw null; }
89-
}
9058
public partial class DocumentTranslationFileFormat
9159
{
9260
internal DocumentTranslationFileFormat() { }
@@ -107,11 +75,10 @@ public void AddTarget(System.Uri targetUri, string languageCode, Azure.AI.Transl
10775
}
10876
public static partial class DocumentTranslationModelFactory
10977
{
110-
public static Azure.AI.Translation.Document.DocumentStatusResult DocumentStatus(string id, System.Uri sourceDocumentUri, Azure.AI.Translation.Document.DocumentTranslationError error, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, string translatedTo, float progress, long charactersCharged) { throw null; }
111-
public static Azure.AI.Translation.Document.DocumentStatusResult DocumentStatus(string id, System.Uri sourceDocumentUri, System.Uri translatedDocumentUri, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, string translatedTo, float progress, long charactersCharged) { throw null; }
112-
public static Azure.AI.Translation.Document.DocumentTranslationError DocumentTranslationError(Azure.AI.Translation.Document.DocumentTranslationErrorCode errorCode, string message, string target) { throw null; }
78+
public static Azure.AI.Translation.Document.DocumentStatusResult DocumentStatusResult(string id, System.Uri sourceDocumentUri, System.BinaryData error, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, string translatedTo, float progress, long charactersCharged) { throw null; }
79+
public static Azure.AI.Translation.Document.DocumentStatusResult DocumentStatusResult(string id, System.Uri sourceDocumentUri, System.Uri translatedDocumentUri, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, string translatedTo, float progress, long charactersCharged) { throw null; }
11380
public static Azure.AI.Translation.Document.DocumentTranslationFileFormat DocumentTranslationFileFormat(string format = null, System.Collections.Generic.IEnumerable<string> fileExtensions = null, System.Collections.Generic.IEnumerable<string> contentTypes = null, string defaultFormatVersion = null, System.Collections.Generic.IEnumerable<string> formatVersions = null) { throw null; }
114-
public static Azure.AI.Translation.Document.TranslationStatusResult TranslationStatus(string id, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, Azure.AI.Translation.Document.DocumentTranslationError error, int total, int failed, int success, int inProgress, int notYetStarted, int canceled, long totalCharacterCharged) { throw null; }
81+
public static Azure.AI.Translation.Document.TranslationStatusResult TranslationStatusResult(string id, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, System.BinaryData error, int total, int failed, int success, int inProgress, int notYetStarted, int canceled, long totalCharacterCharged) { throw null; }
11582
}
11683
public partial class DocumentTranslationOperation : Azure.PageableOperation<Azure.AI.Translation.Document.DocumentStatusResult>
11784
{
@@ -225,7 +192,7 @@ internal TranslationStatusResult() { }
225192
public int DocumentsNotStarted { get { throw null; } }
226193
public int DocumentsSucceeded { get { throw null; } }
227194
public int DocumentsTotal { get { throw null; } }
228-
public Azure.AI.Translation.Document.DocumentTranslationError? Error { get { throw null; } }
195+
public Azure.ResponseError Error { get { throw null; } }
229196
public string Id { get { throw null; } }
230197
public System.DateTimeOffset LastModified { get { throw null; } }
231198
public Azure.AI.Translation.Document.DocumentTranslationStatus Status { get { throw null; } }

‎sdk/translation/Azure.AI.Translation.Document/samples/Sample1_StartTranslation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ await foreach (DocumentStatusResult document in operation.Value)
5252
}
5353
else
5454
{
55-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
55+
Console.WriteLine($" Error Code: {document.Error.Code}");
5656
Console.WriteLine($" Message: {document.Error.Message}");
5757
}
5858
}

‎sdk/translation/Azure.AI.Translation.Document/samples/Sample2_PollIndividualDocuments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ await foreach (DocumentStatusResult document in operation.GetDocumentStatusesAsy
5454
else
5555
{
5656
Console.WriteLine($" Document source Uri: {document.SourceDocumentUri}");
57-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
57+
Console.WriteLine($" Error Code: {document.Error.Code}");
5858
Console.WriteLine($" Message: {document.Error.Message}");
5959
}
6060
}

‎sdk/translation/Azure.AI.Translation.Document/samples/Sample4_MultipleInputs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ await foreach (DocumentStatusResult document in operation.GetValuesAsync())
6161
else
6262
{
6363
Console.WriteLine($" Document source Uri: {document.SourceDocumentUri}");
64-
Console.WriteLine($" Error Code: {document.Error.ErrorCode}");
64+
Console.WriteLine($" Error Code: {document.Error.Code}");
6565
Console.WriteLine($" Message: {document.Error.Message}");
6666
}
6767
}

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentStatusResult.cs‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Licensed under the MIT License.
33

44
using System;
5+
using System.Text.Json;
56
using Azure.Core;
67

78
namespace Azure.AI.Translation.Document
@@ -12,6 +13,9 @@ namespace Azure.AI.Translation.Document
1213
[CodeGenModel("DocumentStatus")]
1314
public partial class DocumentStatusResult
1415
{
16+
[CodeGenMember("Error")]
17+
private readonly JsonElement _error;
18+
1519
/// <summary>
1620
/// Document Id.
1721
/// </summary>
@@ -70,7 +74,7 @@ public partial class DocumentStatusResult
7074
/// document. This property will have a value only when the document
7175
/// cannot be processed.
7276
/// </summary>
73-
public DocumentTranslationError Error { get; }
77+
public ResponseError Error => _error.ValueKind == JsonValueKind.Undefined ? null : JsonSerializer.Deserialize<ResponseError>(_error.GetRawText());
7478

7579
[CodeGenMember("Progress")]
7680
internal float Progress { get; }

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationError.cs‎

Lines changed: 0 additions & 53 deletions
This file was deleted.

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationErrorCode.cs‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationModelFactory.cs‎

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
// Licensed under the MIT License.
33

44
using System;
5-
using System.Collections.Generic;
6-
using Azure.Core;
5+
using System.Text.Json;
76
using Azure.AI.Translation.Document.Models;
7+
using Azure.Core;
88
namespace Azure.AI.Translation.Document
99
{
1010
/// <summary>
@@ -13,24 +13,6 @@ namespace Azure.AI.Translation.Document
1313
[CodeGenModel("BatchDocumentTranslationModelFactory")]
1414
public static partial class DocumentTranslationModelFactory
1515
{
16-
#region Errors
17-
/// <summary>
18-
/// Initializes a new instance of <see cref="Document.DocumentTranslationError"/> for mocking purposes.
19-
/// </summary>
20-
/// <param name="errorCode">Sets the <see cref="DocumentTranslationError.ErrorCode"/> property.</param>
21-
/// <param name="message">Sets the <see cref="DocumentTranslationError.Message"/> property.</param>
22-
/// <param name="target">Sets the <see cref="DocumentTranslationError.Target"/> property.</param>
23-
/// <returns>A new instance of <see cref="Document.DocumentTranslationError"/> for mocking purposes.</returns>
24-
public static DocumentTranslationError DocumentTranslationError(
25-
DocumentTranslationErrorCode errorCode,
26-
string message,
27-
string target
28-
)
29-
{
30-
return new DocumentTranslationError(errorCode, message, target, default);
31-
}
32-
#endregion Errors
33-
3416
#region Statuses
3517
/// <summary>
3618
/// Initializes a new instance of <see cref="Document.DocumentStatusResult"/> for mocking purposes.
@@ -45,7 +27,7 @@ string target
4527
/// <param name="progress">Sets the <see cref="DocumentStatusResult.Progress"/> property.</param>
4628
/// <param name="charactersCharged">Sets the <see cref="DocumentStatusResult.CharactersCharged"/> property.</param>
4729
/// <returns>A new instance of <see cref="Document.DocumentStatusResult"/> for mocking purposes.</returns>
48-
public static DocumentStatusResult DocumentStatus(
30+
public static DocumentStatusResult DocumentStatusResult(
4931
string id,
5032
Uri sourceDocumentUri,
5133
Uri translatedDocumentUri,
@@ -73,10 +55,10 @@ long charactersCharged
7355
/// <param name="progress">Sets the <see cref="DocumentStatusResult.Progress"/> property.</param>
7456
/// <param name="charactersCharged">Sets the <see cref="DocumentStatusResult.CharactersCharged"/> property.</param>
7557
/// <returns>A new instance of <see cref="Document.DocumentStatusResult"/> for mocking purposes.</returns>
76-
public static DocumentStatusResult DocumentStatus(
58+
public static DocumentStatusResult DocumentStatusResult(
7759
string id,
7860
Uri sourceDocumentUri,
79-
DocumentTranslationError error,
61+
BinaryData error,
8062
DateTimeOffset createdOn,
8163
DateTimeOffset lastModified,
8264
DocumentTranslationStatus status,
@@ -85,7 +67,8 @@ public static DocumentStatusResult DocumentStatus(
8567
long charactersCharged
8668
)
8769
{
88-
return new DocumentStatusResult(default, sourceDocumentUri, createdOn, lastModified, status, translatedTo, error, progress, id, charactersCharged);
70+
JsonElement errorJson = error.ToObjectFromJson<JsonElement>();
71+
return new DocumentStatusResult(default, sourceDocumentUri, createdOn, lastModified, status, translatedTo, errorJson, progress, id, charactersCharged);
8972
}
9073

9174
/// <summary>
@@ -104,12 +87,12 @@ long charactersCharged
10487
/// <param name="canceled">Sets the <see cref="StatusSummary.Cancelled"/> and the <see cref="TranslationStatusResult.DocumentsCanceled"/> properties.</param>
10588
/// <param name="totalCharacterCharged">Sets the <see cref="StatusSummary.TotalCharacterCharged"/> and the <see cref="TranslationStatusResult.TotalCharactersCharged"/> properties.</param>
10689
/// <returns>A new instance of <see cref="Document.TranslationStatusResult"/> for mocking purposes.</returns>
107-
public static TranslationStatusResult TranslationStatus(
90+
public static TranslationStatusResult TranslationStatusResult(
10891
string id,
10992
DateTimeOffset createdOn,
11093
DateTimeOffset lastModified,
11194
DocumentTranslationStatus status,
112-
DocumentTranslationError error,
95+
BinaryData error,
11396
int total,
11497
int failed,
11598
int success,
@@ -120,7 +103,8 @@ long totalCharacterCharged
120103
)
121104
{
122105
StatusSummary newSummary = new StatusSummary(total, failed, success, inProgress, notYetStarted, canceled, totalCharacterCharged);
123-
return new TranslationStatusResult(id, createdOn, lastModified, status, error, newSummary);
106+
JsonElement errorJson = error.ToObjectFromJson<JsonElement>();
107+
return new TranslationStatusResult(id, createdOn, lastModified, status, errorJson, newSummary);
124108
}
125109
#endregion Statuses
126110
}

0 commit comments

Comments
 (0)