Skip to content

Commit 77205be

Browse files
authored
[Document Translation] Removing the word All from GetAll [Translation/Document] Statuses (Azure#23332)
1 parent bfebcf2 commit 77205be

File tree

38 files changed

+66
-66
lines changed

38 files changed

+66
-66
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ int docsCancelled = 0;
235235
int docsSucceeded = 0;
236236
int docsFailed = 0;
237237

238-
await foreach (TranslationStatus translationStatus in client.GetAllTranslationStatusesAsync())
238+
await foreach (TranslationStatus translationStatus in client.GetTranslationStatusesAsync())
239239
{
240240
if (translationStatus.Status == DocumentTranslationStatus.NotStarted ||
241241
translationStatus.Status == DocumentTranslationStatus.Running)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ public DocumentTranslationClient(System.Uri endpoint, Azure.Core.TokenCredential
4141
public DocumentTranslationClient(System.Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.Translation.Document.DocumentTranslationClientOptions options) { }
4242
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
4343
public override bool Equals(object obj) { throw null; }
44-
public virtual Azure.Pageable<Azure.AI.Translation.Document.TranslationStatus> GetAllTranslationStatuses(Azure.AI.Translation.Document.TranslationFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
45-
public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.TranslationStatus> GetAllTranslationStatusesAsync(Azure.AI.Translation.Document.TranslationFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
4644
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
4745
public override int GetHashCode() { throw null; }
4846
public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.FileFormat>> GetSupportedDocumentFormats(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
4947
public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.FileFormat>>> GetSupportedDocumentFormatsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
5048
public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.FileFormat>> GetSupportedGlossaryFormats(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
5149
public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.FileFormat>>> GetSupportedGlossaryFormatsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
50+
public virtual Azure.Pageable<Azure.AI.Translation.Document.TranslationStatus> GetTranslationStatuses(Azure.AI.Translation.Document.TranslationFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
51+
public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.TranslationStatus> GetTranslationStatusesAsync(Azure.AI.Translation.Document.TranslationFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
5252
public virtual Azure.AI.Translation.Document.DocumentTranslationOperation StartTranslation(Azure.AI.Translation.Document.DocumentTranslationInput input, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
5353
public virtual Azure.AI.Translation.Document.DocumentTranslationOperation StartTranslation(System.Collections.Generic.IEnumerable<Azure.AI.Translation.Document.DocumentTranslationInput> inputs, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
5454
public virtual System.Threading.Tasks.Task<Azure.AI.Translation.Document.DocumentTranslationOperation> StartTranslationAsync(Azure.AI.Translation.Document.DocumentTranslationInput input, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
@@ -133,10 +133,10 @@ public DocumentTranslationOperation(string translationId, Azure.AI.Translation.D
133133
public override Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatus> Value { get { throw null; } }
134134
public virtual void Cancel(System.Threading.CancellationToken cancellationToken) { }
135135
public virtual System.Threading.Tasks.Task CancelAsync(System.Threading.CancellationToken cancellationToken) { throw null; }
136-
public virtual Azure.Pageable<Azure.AI.Translation.Document.DocumentStatus> GetAllDocumentStatuses(Azure.AI.Translation.Document.DocumentFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
137-
public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatus> GetAllDocumentStatusesAsync(Azure.AI.Translation.Document.DocumentFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
138136
public virtual Azure.Response<Azure.AI.Translation.Document.DocumentStatus> GetDocumentStatus(string documentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
139137
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatus>> GetDocumentStatusAsync(string documentId, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
138+
public virtual Azure.Pageable<Azure.AI.Translation.Document.DocumentStatus> GetDocumentStatuses(Azure.AI.Translation.Document.DocumentFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
139+
public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatus> GetDocumentStatusesAsync(Azure.AI.Translation.Document.DocumentFilter filter = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
140140
public override Azure.Response GetRawResponse() { throw null; }
141141
public override Azure.Pageable<Azure.AI.Translation.Document.DocumentStatus> GetValues(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
142142
public override Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatus> GetValuesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ DocumentTranslationOperation operation = await client.StartTranslationAsync(inpu
2727

2828
TimeSpan pollingInterval = new(1000);
2929

30-
await foreach (DocumentStatus document in operation.GetAllDocumentStatusesAsync())
30+
await foreach (DocumentStatus document in operation.GetDocumentStatusesAsync())
3131
{
3232
Console.WriteLine($"Polling Status for document{document.SourceDocumentUri}");
3333

sdk/translation/Azure.AI.Translation.Document/samples/Sample3_OperationsHistory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ int docsCancelled = 0;
2626
int docsSucceeded = 0;
2727
int docsFailed = 0;
2828

29-
await foreach (TranslationStatus translationStatus in client.GetAllTranslationStatusesAsync())
29+
await foreach (TranslationStatus translationStatus in client.GetTranslationStatusesAsync())
3030
{
3131
if (translationStatus.Status == DocumentTranslationStatus.NotStarted ||
3232
translationStatus.Status == DocumentTranslationStatus.Running)

sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationClient.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -215,15 +215,15 @@ public virtual async Task<DocumentTranslationOperation> StartTranslationAsync(Do
215215
}
216216

217217
/// <summary>
218-
/// Get the status results for all submitted translation operations.
218+
/// Get the status results for submitted translation operations.
219219
/// </summary>
220220
/// <param name="filter">Options to use when filtering result.</param>
221221
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
222-
public virtual Pageable<TranslationStatus> GetAllTranslationStatuses(TranslationFilter filter = default, CancellationToken cancellationToken = default)
222+
public virtual Pageable<TranslationStatus> GetTranslationStatuses(TranslationFilter filter = default, CancellationToken cancellationToken = default)
223223
{
224224
Page<TranslationStatus> FirstPageFunc(int? pageSizeHint)
225225
{
226-
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetAllTranslationStatuses)}");
226+
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetTranslationStatuses)}");
227227
scope.Start();
228228

229229
try
@@ -246,7 +246,7 @@ Page<TranslationStatus> FirstPageFunc(int? pageSizeHint)
246246

247247
Page<TranslationStatus> NextPageFunc(string nextLink, int? pageSizeHint)
248248
{
249-
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetAllTranslationStatuses)}");
249+
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetTranslationStatuses)}");
250250
scope.Start();
251251

252252
try
@@ -265,15 +265,15 @@ Page<TranslationStatus> NextPageFunc(string nextLink, int? pageSizeHint)
265265
}
266266

267267
/// <summary>
268-
/// Get the status results for all submitted translation operations.
268+
/// Get the status results for submitted translation operations.
269269
/// </summary>
270270
/// <param name="filter">Options to use when filtering result.</param>
271271
/// <param name="cancellationToken">A <see cref="CancellationToken"/> controlling the request lifetime.</param>
272-
public virtual AsyncPageable<TranslationStatus> GetAllTranslationStatusesAsync(TranslationFilter filter = default, CancellationToken cancellationToken = default)
272+
public virtual AsyncPageable<TranslationStatus> GetTranslationStatusesAsync(TranslationFilter filter = default, CancellationToken cancellationToken = default)
273273
{
274274
async Task<Page<TranslationStatus>> FirstPageFunc(int? pageSizeHint)
275275
{
276-
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetAllTranslationStatuses)}");
276+
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetTranslationStatuses)}");
277277
scope.Start();
278278

279279
try
@@ -296,7 +296,7 @@ async Task<Page<TranslationStatus>> FirstPageFunc(int? pageSizeHint)
296296

297297
async Task<Page<TranslationStatus>> NextPageFunc(string nextLink, int? pageSizeHint)
298298
{
299-
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetAllTranslationStatuses)}");
299+
using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(DocumentTranslationClient)}.{nameof(GetTranslationStatuses)}");
300300
scope.Start();
301301

302302
try

sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationOperation.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -360,15 +360,15 @@ public virtual async Task<Response<DocumentStatus>> GetDocumentStatusAsync(strin
360360
}
361361

362362
/// <summary>
363-
/// Get the status of all documents in the translation operation.
363+
/// Get the status of documents in the translation operation.
364364
/// </summary>
365365
/// <param name="filter">Options to use when filtering result.</param>
366366
/// <param name="cancellationToken">A <see cref="CancellationToken"/> used for the service call.</param>
367-
public virtual Pageable<DocumentStatus> GetAllDocumentStatuses(DocumentFilter filter = default, CancellationToken cancellationToken = default)
367+
public virtual Pageable<DocumentStatus> GetDocumentStatuses(DocumentFilter filter = default, CancellationToken cancellationToken = default)
368368
{
369369
Page<DocumentStatus> FirstPageFunc(int? pageSizeHint)
370370
{
371-
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetAllDocumentStatuses)}");
371+
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetDocumentStatuses)}");
372372
scope.Start();
373373

374374
try
@@ -392,7 +392,7 @@ Page<DocumentStatus> FirstPageFunc(int? pageSizeHint)
392392

393393
Page<DocumentStatus> NextPageFunc(string nextLink, int? pageSizeHint)
394394
{
395-
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetAllDocumentStatuses)}");
395+
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetDocumentStatuses)}");
396396
scope.Start();
397397

398398
try
@@ -411,15 +411,15 @@ Page<DocumentStatus> NextPageFunc(string nextLink, int? pageSizeHint)
411411
}
412412

413413
/// <summary>
414-
/// Get the status of all documents in the translation operation.
414+
/// Get the status of documents in the translation operation.
415415
/// </summary>
416416
/// <param name="filter">Options to use when filtering result.</param>
417417
/// <param name="cancellationToken">A <see cref="CancellationToken"/> used for the service call.</param>
418-
public virtual AsyncPageable<DocumentStatus> GetAllDocumentStatusesAsync(DocumentFilter filter = default, CancellationToken cancellationToken = default)
418+
public virtual AsyncPageable<DocumentStatus> GetDocumentStatusesAsync(DocumentFilter filter = default, CancellationToken cancellationToken = default)
419419
{
420420
async Task<Page<DocumentStatus>> FirstPageFunc(int? pageSizeHint)
421421
{
422-
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetAllDocumentStatuses)}");
422+
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetDocumentStatuses)}");
423423
scope.Start();
424424

425425
try
@@ -443,7 +443,7 @@ async Task<Page<DocumentStatus>> FirstPageFunc(int? pageSizeHint)
443443

444444
async Task<Page<DocumentStatus>> NextPageFunc(string nextLink, int? pageSizeHint)
445445
{
446-
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetAllDocumentStatuses)}");
446+
using DiagnosticScope scope = _diagnostics.CreateScope($"{nameof(DocumentTranslationOperation)}.{nameof(GetDocumentStatuses)}");
447447
scope.Start();
448448

449449
try
@@ -513,7 +513,7 @@ public override AsyncPageable<DocumentStatus> GetValuesAsync(CancellationToken c
513513
{
514514
ValidateOperationStatus();
515515

516-
return GetAllDocumentStatusesAsync(cancellationToken: cancellationToken);
516+
return GetDocumentStatusesAsync(cancellationToken: cancellationToken);
517517
}
518518

519519
/// <summary>
@@ -526,7 +526,7 @@ public override Pageable<DocumentStatus> GetValues(CancellationToken cancellatio
526526
{
527527
ValidateOperationStatus();
528528

529-
return GetAllDocumentStatuses(cancellationToken: cancellationToken);
529+
return GetDocumentStatuses(cancellationToken: cancellationToken);
530530
}
531531

532532
private void ValidateOperationStatus()

sdk/translation/Azure.AI.Translation.Document/tests/DocumentTranslationClientLiveTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public async Task GetGlossaryFormatsTest(bool usetokenCredential)
7474
[RecordedTest]
7575
[TestCase(true)]
7676
[TestCase(false)]
77-
public async Task GetAllTranslationStatusesTest(bool usetokenCredential)
77+
public async Task GetTranslationStatusesTest(bool usetokenCredential)
7878
{
7979
Uri source = await CreateSourceContainerAsync(oneTestDocuments);
8080
Uri target = await CreateTargetContainerAsync();
@@ -84,7 +84,7 @@ public async Task GetAllTranslationStatusesTest(bool usetokenCredential)
8484
var input = new DocumentTranslationInput(source, target, "fr");
8585
await client.StartTranslationAsync(input);
8686

87-
List<TranslationStatus> translations = await client.GetAllTranslationStatusesAsync().ToEnumerableAsync();
87+
List<TranslationStatus> translations = await client.GetTranslationStatusesAsync().ToEnumerableAsync();
8888

8989
Assert.GreaterOrEqual(translations.Count, 1);
9090
TranslationStatus oneTranslation = translations[0];

sdk/translation/Azure.AI.Translation.Document/tests/GetAllDocumentsFilterTests.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ private async Task<DocumentTranslationOperation> CreateSingleTranslationJobAsync
2525
}
2626

2727
[RecordedTest]
28-
public async Task GetAllDocumentStatusesFilterByStatusTest()
28+
public async Task GetDocumentStatusesFilterByStatusTest()
2929
{
3030
// create client
3131
var client = GetClient();
@@ -39,49 +39,49 @@ public async Task GetAllDocumentStatusesFilterByStatusTest()
3939
{
4040
Statuses = {DocumentTranslationStatus.Succeeded}
4141
};
42-
var result = operation.GetAllDocumentStatuses(filter: filter);
42+
var result = operation.GetDocumentStatuses(filter: filter);
4343

4444
// assert.
4545
Assert.That(result.All(d => d.Status == DocumentTranslationStatus.Succeeded));
4646
}
4747

4848
[RecordedTest]
49-
public async Task GetAllDocumentStatusesFilterByIdsTest()
49+
public async Task GetDocumentStatusesFilterByIdsTest()
5050
{
5151
// create client
5252
var client = GetClient();
5353

5454
// create translation job
5555
var operation = await CreateSingleTranslationJobAsync(client, docsCount: 2);
5656
await operation.WaitForCompletionAsync();
57-
var testIds = operation.GetAllDocumentStatuses().Select(d => d.Id).ToList().GetRange(0, 1);
57+
var testIds = operation.GetDocumentStatuses().Select(d => d.Id).ToList().GetRange(0, 1);
5858

5959
// list docs
6060
var filter = new DocumentFilter
6161
{
6262
Ids = { testIds[0] }
6363
};
6464

65-
var result = operation.GetAllDocumentStatuses(filter: filter);
65+
var result = operation.GetDocumentStatuses(filter: filter);
6666

6767
// assert
6868
Assert.That(result.All(d => testIds.Contains(d.Id)));
6969
}
7070

7171
[Ignore("no way to test this filter")]
7272
[RecordedTest]
73-
public void GetAllDocumentStatusesFilterByCreatedAfter()
73+
public void GetDocumentStatusesFilterByCreatedAfter()
7474
{
7575
}
7676

7777
[Ignore("no way to test this filter")]
7878
[RecordedTest]
79-
public void GetAllDocumentStatusesFilterByCreatedBefore()
79+
public void GetDocumentStatusesFilterByCreatedBefore()
8080
{
8181
}
8282

8383
[RecordedTest]
84-
public async Task GetAllDocumentStatusesOrderByCreatedOn()
84+
public async Task GetDocumentStatusesOrderByCreatedOn()
8585
{
8686
// create client
8787
var client = GetClient();
@@ -96,7 +96,7 @@ public async Task GetAllDocumentStatusesOrderByCreatedOn()
9696
OrderBy = { new DocumentFilterOrder(property: DocumentFilterProperty.CreatedOn, asc: false) }
9797
};
9898

99-
var filterResults = operation.GetAllDocumentStatuses(filter: filter);
99+
var filterResults = operation.GetDocumentStatuses(filter: filter);
100100

101101
// assert
102102
var timestamp = Recording.UtcNow;

0 commit comments

Comments
 (0)