-
Notifications
You must be signed in to change notification settings - Fork 255
/
DocumentTranslationClient.xml
2127 lines (2043 loc) · 189 KB
/
DocumentTranslationClient.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="DocumentTranslationClient" FullName="Azure.AI.Translation.Document.DocumentTranslationClient">
<TypeSignature Language="C#" Value="public class DocumentTranslationClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DocumentTranslationClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.Translation.Document.DocumentTranslationClient" />
<TypeSignature Language="VB.NET" Value="Public Class DocumentTranslationClient" />
<TypeSignature Language="F#" Value="type DocumentTranslationClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The DocumentTranslation service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DocumentTranslationClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Protected constructor to allow mocking.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentTranslationClient (Uri endpoint, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.#ctor(System.Uri,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.DocumentTranslationClient : Uri * Azure.AzureKeyCredential -> Azure.AI.Translation.Document.DocumentTranslationClient" Usage="new Azure.AI.Translation.Document.DocumentTranslationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint">A <see cref="T:System.Uri" /> to the service the client
sends requests to.</param>
<param name="credential">The API key used to access
the service. This will allow you to update the API key
without creating a new client.</param>
<summary>
Initializes a new instance of <see cref="T:Azure.AI.Translation.Document.DocumentTranslationClient" /> class for the specified service instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentTranslationClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.DocumentTranslationClient : Uri * Azure.Core.TokenCredential -> Azure.AI.Translation.Document.DocumentTranslationClient" Usage="new Azure.AI.Translation.Document.DocumentTranslationClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint">A <see cref="T:System.Uri" /> to the service the client
sends requests to. Endpoint can be found in the Azure portal.</param>
<param name="credential">A <see cref="T:Azure.Core.TokenCredential" /> used to
authenticate requests to the service, such as DefaultAzureCredential.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.Translation.Document.DocumentTranslationClient" />
class for the specified service instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentTranslationClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.Translation.Document.DocumentTranslationClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.Translation.Document.DocumentTranslationClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.Translation.Document.DocumentTranslationClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As DocumentTranslationClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.DocumentTranslationClient : Uri * Azure.AzureKeyCredential * Azure.AI.Translation.Document.DocumentTranslationClientOptions -> Azure.AI.Translation.Document.DocumentTranslationClient" Usage="new Azure.AI.Translation.Document.DocumentTranslationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of DocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentTranslationClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.Translation.Document.DocumentTranslationClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.Translation.Document.DocumentTranslationClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.Translation.Document.DocumentTranslationClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As DocumentTranslationClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Translation.Document.DocumentTranslationClient : Uri * Azure.Core.TokenCredential * Azure.AI.Translation.Document.DocumentTranslationClientOptions -> Azure.AI.Translation.Document.DocumentTranslationClient" Usage="new Azure.AI.Translation.Document.DocumentTranslationClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.AI.Translation.Document.DocumentTranslationClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of DocumentTranslationClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CancelTranslation">
<MemberSignature Language="C#" Value="public virtual Azure.Response CancelTranslation (Guid id, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CancelTranslation(valuetype System.Guid id, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslation(System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTranslation (id As Guid, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member CancelTranslation : Guid * Azure.RequestContext -> Azure.Response
override this.CancelTranslation : Guid * Azure.RequestContext -> Azure.Response" Usage="documentTranslationClient.CancelTranslation (id, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation-id. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a currently processing or queued translation
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslation(System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="CancelTranslation">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult> CancelTranslation (Guid id, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Translation.Document.TranslationStatusResult> CancelTranslation(valuetype System.Guid id, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslation(System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTranslation (id As Guid, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TranslationStatusResult)" />
<MemberSignature Language="F#" Value="abstract member CancelTranslation : Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>
override this.CancelTranslation : Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>" Usage="documentTranslationClient.CancelTranslation (id, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation-id. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Cancel a currently processing or queued translation. </summary>
<returns>To be added.</returns>
<remarks>
Cancel a currently processing or queued translation.
A translation will not be
cancelled if it is already completed or failed or cancelling. A bad request
will be returned.
All documents that have completed translation will not be
cancelled and will be charged.
All pending documents will be cancelled if
possible.
</remarks>
</Docs>
</Member>
<Member MemberName="CancelTranslationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CancelTranslationAsync (Guid id, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CancelTranslationAsync(valuetype System.Guid id, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslationAsync(System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTranslationAsync (id As Guid, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member CancelTranslationAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelTranslationAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentTranslationClient.CancelTranslationAsync (id, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation-id. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a currently processing or queued translation
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslationAsync(System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="CancelTranslationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>> CancelTranslationAsync (Guid id, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Translation.Document.TranslationStatusResult>> CancelTranslationAsync(valuetype System.Guid id, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.CancelTranslationAsync(System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTranslationAsync (id As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TranslationStatusResult))" />
<MemberSignature Language="F#" Value="abstract member CancelTranslationAsync : Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>>
override this.CancelTranslationAsync : Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>>" Usage="documentTranslationClient.CancelTranslationAsync (id, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.TranslationStatusResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation-id. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Cancel a currently processing or queued translation. </summary>
<returns>To be added.</returns>
<remarks>
Cancel a currently processing or queued translation.
A translation will not be
cancelled if it is already completed or failed or cancelling. A bad request
will be returned.
All documents that have completed translation will not be
cancelled and will be charged.
All pending documents will be cancelled if
possible.
</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="documentTranslationClient.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="obj">The instance to compare to.</param>
<summary>
Check if two TextAnalyticsClient instances are equal.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetDocumentsStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDocumentsStatus (Guid id, int? maxCount, int? skip, int? maxpagesize, System.Collections.Generic.IEnumerable<Guid> ids, System.Collections.Generic.IEnumerable<string> statuses, DateTimeOffset? createdDateTimeUtcStart, DateTimeOffset? createdDateTimeUtcEnd, System.Collections.Generic.IEnumerable<string> orderby, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDocumentsStatus(valuetype System.Guid id, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> ids, class System.Collections.Generic.IEnumerable`1<string> statuses, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcStart, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcEnd, class System.Collections.Generic.IEnumerable`1<string> orderby, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatus(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentsStatus (id As Guid, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), ids As IEnumerable(Of Guid), statuses As IEnumerable(Of String), createdDateTimeUtcStart As Nullable(Of DateTimeOffset), createdDateTimeUtcEnd As Nullable(Of DateTimeOffset), orderby As IEnumerable(Of String), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="documentTranslationClient.GetDocumentsStatus (id, maxCount, skip, maxpagesize, ids, statuses, createdDateTimeUtcStart, createdDateTimeUtcEnd, orderby, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="3" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="ids" Type="System.Collections.Generic.IEnumerable<System.Guid>" Index="4" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="statuses" Type="System.Collections.Generic.IEnumerable<System.String>" Index="5" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcStart" Type="System.Nullable<System.DateTimeOffset>" Index="6" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcEnd" Type="System.Nullable<System.DateTimeOffset>" Index="7" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="orderby" Type="System.Collections.Generic.IEnumerable<System.String>" Index="8" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="9" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation id. </param>
<param name="maxCount">
top indicates the total number of records the user wants to be returned across
all pages.
Clients MAY use top and skip query parameters to
specify a number of results to return and an offset into the collection.
When
both top and skip are given by a client, the server SHOULD first apply skip
and then top on the collection.
Note: If the server can't honor
top and/or skip, the server MUST return an error to the client informing
about it instead of just ignoring the query options.
</param>
<param name="skip">
skip indicates the number of records to skip from the list of records held by
the server based on the sorting method specified. By default, we sort by
descending start time.
Clients MAY use top and skip query
parameters to specify a number of results to return and an offset into the
collection.
When both top and skip are given by a client, the server SHOULD
first apply skip and then top on the collection.
Note: If the
server can't honor top and/or skip, the server MUST return an error to the
client informing about it instead of just ignoring the query options.
</param>
<param name="maxpagesize">
maxpagesize is the maximum items returned in a page. If more items are
requested via top (or top is not specified and there are more items to be
returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by
specifying a maxpagesize preference. The server SHOULD honor this preference
if the specified page size is smaller than the server's default page size.
</param>
<param name="ids"> Ids to use in filtering. </param>
<param name="statuses"> Statuses to use in filtering. </param>
<param name="createdDateTimeUtcStart"> the start datetime to get items after. </param>
<param name="createdDateTimeUtcEnd"> the end datetime to get items before. </param>
<param name="orderby"> the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Returns the status for all documents in a batch document translation request
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatus(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="GetDocumentsStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatus (Guid id, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Collections.Generic.IEnumerable<Guid> ids = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? createdDateTimeUtcStart = default, DateTimeOffset? createdDateTimeUtcEnd = default, System.Collections.Generic.IEnumerable<string> orderby = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatus(valuetype System.Guid id, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> ids, class System.Collections.Generic.IEnumerable`1<string> statuses, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcStart, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcEnd, class System.Collections.Generic.IEnumerable`1<string> orderby, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatus(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentsStatus (id As Guid, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional ids As IEnumerable(Of Guid) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional createdDateTimeUtcStart As Nullable(Of DateTimeOffset) = Nothing, Optional createdDateTimeUtcEnd As Nullable(Of DateTimeOffset) = Nothing, Optional orderby As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DocumentStatusResult)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentsStatus : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult>" Usage="documentTranslationClient.GetDocumentsStatus (id, maxCount, skip, maxpagesize, ids, statuses, createdDateTimeUtcStart, createdDateTimeUtcEnd, orderby, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.AI.Translation.Document.DocumentStatusResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="3" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="ids" Type="System.Collections.Generic.IEnumerable<System.Guid>" Index="4" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="statuses" Type="System.Collections.Generic.IEnumerable<System.String>" Index="5" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcStart" Type="System.Nullable<System.DateTimeOffset>" Index="6" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcEnd" Type="System.Nullable<System.DateTimeOffset>" Index="7" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="orderby" Type="System.Collections.Generic.IEnumerable<System.String>" Index="8" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="9" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation id. </param>
<param name="maxCount">
top indicates the total number of records the user wants to be returned across
all pages.
Clients MAY use top and skip query parameters to
specify a number of results to return and an offset into the collection.
When
both top and skip are given by a client, the server SHOULD first apply skip
and then top on the collection.
Note: If the server can't honor
top and/or skip, the server MUST return an error to the client informing
about it instead of just ignoring the query options.
</param>
<param name="skip">
skip indicates the number of records to skip from the list of records held by
the server based on the sorting method specified. By default, we sort by
descending start time.
Clients MAY use top and skip query
parameters to specify a number of results to return and an offset into the
collection.
When both top and skip are given by a client, the server SHOULD
first apply skip and then top on the collection.
Note: If the
server can't honor top and/or skip, the server MUST return an error to the
client informing about it instead of just ignoring the query options.
</param>
<param name="maxpagesize">
maxpagesize is the maximum items returned in a page. If more items are
requested via top (or top is not specified and there are more items to be
returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by
specifying a maxpagesize preference. The server SHOULD honor this preference
if the specified page size is smaller than the server's default page size.
</param>
<param name="ids"> Ids to use in filtering. </param>
<param name="statuses"> Statuses to use in filtering. </param>
<param name="createdDateTimeUtcStart"> the start datetime to get items after. </param>
<param name="createdDateTimeUtcEnd"> the end datetime to get items before. </param>
<param name="orderby"> the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Returns the status for all documents in a batch document translation request. </summary>
<returns>To be added.</returns>
<remarks>
Returns the status for all documents in a batch document translation request.
If the number of documents in the response exceeds our paging limit,
server-side paging is used.
Paginated responses indicate a partial result and
include a continuation token in the response. The absence of a continuation
token means that no additional pages are available.
top, skip
and maxpagesize query parameters can be used to specify a number of results to
return and an offset for the collection.
top indicates the total
number of records the user wants to be returned across all pages.
skip
indicates the number of records to skip from the list of document status held
by the server based on the sorting method specified. By default, we sort by
descending start time.
maxpagesize is the maximum items returned in a page.
If more items are requested via top (or top is not specified and there are
more items to be returned), @nextLink will contain the link to the next page.
orderby query parameter can be used to sort the returned list (ex
"orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
desc").
The default sorting is descending by createdDateTimeUtc.
Some query
parameters can be used to filter the returned list (ex:
"status=Succeeded,Cancelled") will only return succeeded and cancelled
documents.
createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
combined or separately to specify a range of datetime to filter the returned
list by.
The supported filtering query parameters are (status, ids,
createdDateTimeUtcStart, createdDateTimeUtcEnd).
When both top
and skip are included, the server should first apply skip and then top on
the collection.
Note: If the server can't honor top and/or skip, the server
must return an error to the client informing about it instead of just ignoring
the query options.
This reduces the risk of the client making assumptions about
the data returned.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDocumentsStatusAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDocumentsStatusAsync (Guid id, int? maxCount, int? skip, int? maxpagesize, System.Collections.Generic.IEnumerable<Guid> ids, System.Collections.Generic.IEnumerable<string> statuses, DateTimeOffset? createdDateTimeUtcStart, DateTimeOffset? createdDateTimeUtcEnd, System.Collections.Generic.IEnumerable<string> orderby, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDocumentsStatusAsync(valuetype System.Guid id, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> ids, class System.Collections.Generic.IEnumerable`1<string> statuses, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcStart, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcEnd, class System.Collections.Generic.IEnumerable`1<string> orderby, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatusAsync(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentsStatusAsync (id As Guid, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), ids As IEnumerable(Of Guid), statuses As IEnumerable(Of String), createdDateTimeUtcStart As Nullable(Of DateTimeOffset), createdDateTimeUtcEnd As Nullable(Of DateTimeOffset), orderby As IEnumerable(Of String), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentsStatusAsync : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDocumentsStatusAsync : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="documentTranslationClient.GetDocumentsStatusAsync (id, maxCount, skip, maxpagesize, ids, statuses, createdDateTimeUtcStart, createdDateTimeUtcEnd, orderby, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="3" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="ids" Type="System.Collections.Generic.IEnumerable<System.Guid>" Index="4" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="statuses" Type="System.Collections.Generic.IEnumerable<System.String>" Index="5" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcStart" Type="System.Nullable<System.DateTimeOffset>" Index="6" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcEnd" Type="System.Nullable<System.DateTimeOffset>" Index="7" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="orderby" Type="System.Collections.Generic.IEnumerable<System.String>" Index="8" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="9" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation id. </param>
<param name="maxCount">
top indicates the total number of records the user wants to be returned across
all pages.
Clients MAY use top and skip query parameters to
specify a number of results to return and an offset into the collection.
When
both top and skip are given by a client, the server SHOULD first apply skip
and then top on the collection.
Note: If the server can't honor
top and/or skip, the server MUST return an error to the client informing
about it instead of just ignoring the query options.
</param>
<param name="skip">
skip indicates the number of records to skip from the list of records held by
the server based on the sorting method specified. By default, we sort by
descending start time.
Clients MAY use top and skip query
parameters to specify a number of results to return and an offset into the
collection.
When both top and skip are given by a client, the server SHOULD
first apply skip and then top on the collection.
Note: If the
server can't honor top and/or skip, the server MUST return an error to the
client informing about it instead of just ignoring the query options.
</param>
<param name="maxpagesize">
maxpagesize is the maximum items returned in a page. If more items are
requested via top (or top is not specified and there are more items to be
returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by
specifying a maxpagesize preference. The server SHOULD honor this preference
if the specified page size is smaller than the server's default page size.
</param>
<param name="ids"> Ids to use in filtering. </param>
<param name="statuses"> Statuses to use in filtering. </param>
<param name="createdDateTimeUtcStart"> the start datetime to get items after. </param>
<param name="createdDateTimeUtcEnd"> the end datetime to get items before. </param>
<param name="orderby"> the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Returns the status for all documents in a batch document translation request
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatusAsync(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="GetDocumentsStatusAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatusAsync (Guid id, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Collections.Generic.IEnumerable<Guid> ids = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? createdDateTimeUtcStart = default, DateTimeOffset? createdDateTimeUtcEnd = default, System.Collections.Generic.IEnumerable<string> orderby = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentsStatusAsync(valuetype System.Guid id, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class System.Collections.Generic.IEnumerable`1<valuetype System.Guid> ids, class System.Collections.Generic.IEnumerable`1<string> statuses, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcStart, valuetype System.Nullable`1<valuetype System.DateTimeOffset> createdDateTimeUtcEnd, class System.Collections.Generic.IEnumerable`1<string> orderby, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentsStatusAsync(System.Guid,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Guid},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentsStatusAsync (id As Guid, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional ids As IEnumerable(Of Guid) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional createdDateTimeUtcStart As Nullable(Of DateTimeOffset) = Nothing, Optional createdDateTimeUtcEnd As Nullable(Of DateTimeOffset) = Nothing, Optional orderby As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DocumentStatusResult)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentsStatusAsync : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentsStatusAsync : Guid * Nullable<int> * Nullable<int> * Nullable<int> * seq<Guid> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<string> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatusResult>" Usage="documentTranslationClient.GetDocumentsStatusAsync (id, maxCount, skip, maxpagesize, ids, statuses, createdDateTimeUtcStart, createdDateTimeUtcEnd, orderby, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.AI.Translation.Document.DocumentStatusResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="3" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="ids" Type="System.Collections.Generic.IEnumerable<System.Guid>" Index="4" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="statuses" Type="System.Collections.Generic.IEnumerable<System.String>" Index="5" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcStart" Type="System.Nullable<System.DateTimeOffset>" Index="6" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="createdDateTimeUtcEnd" Type="System.Nullable<System.DateTimeOffset>" Index="7" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="orderby" Type="System.Collections.Generic.IEnumerable<System.String>" Index="8" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="9" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The operation id. </param>
<param name="maxCount">
top indicates the total number of records the user wants to be returned across
all pages.
Clients MAY use top and skip query parameters to
specify a number of results to return and an offset into the collection.
When
both top and skip are given by a client, the server SHOULD first apply skip
and then top on the collection.
Note: If the server can't honor
top and/or skip, the server MUST return an error to the client informing
about it instead of just ignoring the query options.
</param>
<param name="skip">
skip indicates the number of records to skip from the list of records held by
the server based on the sorting method specified. By default, we sort by
descending start time.
Clients MAY use top and skip query
parameters to specify a number of results to return and an offset into the
collection.
When both top and skip are given by a client, the server SHOULD
first apply skip and then top on the collection.
Note: If the
server can't honor top and/or skip, the server MUST return an error to the
client informing about it instead of just ignoring the query options.
</param>
<param name="maxpagesize">
maxpagesize is the maximum items returned in a page. If more items are
requested via top (or top is not specified and there are more items to be
returned), @nextLink will contain the link to the next page.
Clients MAY request server-driven paging with a specific page size by
specifying a maxpagesize preference. The server SHOULD honor this preference
if the specified page size is smaller than the server's default page size.
</param>
<param name="ids"> Ids to use in filtering. </param>
<param name="statuses"> Statuses to use in filtering. </param>
<param name="createdDateTimeUtcStart"> the start datetime to get items after. </param>
<param name="createdDateTimeUtcEnd"> the end datetime to get items before. </param>
<param name="orderby"> the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc'). </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Returns the status for all documents in a batch document translation request. </summary>
<returns>To be added.</returns>
<remarks>
Returns the status for all documents in a batch document translation request.
If the number of documents in the response exceeds our paging limit,
server-side paging is used.
Paginated responses indicate a partial result and
include a continuation token in the response. The absence of a continuation
token means that no additional pages are available.
top, skip
and maxpagesize query parameters can be used to specify a number of results to
return and an offset for the collection.
top indicates the total
number of records the user wants to be returned across all pages.
skip
indicates the number of records to skip from the list of document status held
by the server based on the sorting method specified. By default, we sort by
descending start time.
maxpagesize is the maximum items returned in a page.
If more items are requested via top (or top is not specified and there are
more items to be returned), @nextLink will contain the link to the next page.
orderby query parameter can be used to sort the returned list (ex
"orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
desc").
The default sorting is descending by createdDateTimeUtc.
Some query
parameters can be used to filter the returned list (ex:
"status=Succeeded,Cancelled") will only return succeeded and cancelled
documents.
createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
combined or separately to specify a range of datetime to filter the returned
list by.
The supported filtering query parameters are (status, ids,
createdDateTimeUtcStart, createdDateTimeUtcEnd).
When both top
and skip are included, the server should first apply skip and then top on
the collection.
Note: If the server can't honor top and/or skip, the server
must return an error to the client informing about it instead of just ignoring
the query options.
This reduces the risk of the client making assumptions about
the data returned.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDocumentStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetDocumentStatus (Guid id, Guid documentId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDocumentStatus(valuetype System.Guid id, valuetype System.Guid documentId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatus(System.Guid,System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentStatus (id As Guid, documentId As Guid, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetDocumentStatus : Guid * Guid * Azure.RequestContext -> Azure.Response
override this.GetDocumentStatus : Guid * Guid * Azure.RequestContext -> Azure.Response" Usage="documentTranslationClient.GetDocumentStatus (id, documentId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="documentId" Type="System.Guid" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The batch id. </param>
<param name="documentId"> Format - uuid. The document id. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Returns the status for a specific document
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatus(System.Guid,System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="GetDocumentStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentStatus (Guid id, Guid documentId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Translation.Document.DocumentStatusResult> GetDocumentStatus(valuetype System.Guid id, valuetype System.Guid documentId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatus(System.Guid,System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentStatus (id As Guid, documentId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentStatusResult)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentStatus : Guid * Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>
override this.GetDocumentStatus : Guid * Guid * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>" Usage="documentTranslationClient.GetDocumentStatus (id, documentId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="documentId" Type="System.Guid" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The batch id. </param>
<param name="documentId"> Format - uuid. The document id. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Returns the status for a specific document. </summary>
<returns>To be added.</returns>
<remarks>
Returns the translation status for a specific document based on the request Id
and document Id.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDocumentStatusAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDocumentStatusAsync (Guid id, Guid documentId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDocumentStatusAsync(valuetype System.Guid id, valuetype System.Guid documentId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatusAsync(System.Guid,System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentStatusAsync (id As Guid, documentId As Guid, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDocumentStatusAsync : Guid * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="documentTranslationClient.GetDocumentStatusAsync (id, documentId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="documentId" Type="System.Guid" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The batch id. </param>
<param name="documentId"> Format - uuid. The document id. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Returns the status for a specific document
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatusAsync(System.Guid,System.Guid,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="GetDocumentStatusAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>> GetDocumentStatusAsync (Guid id, Guid documentId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.Translation.Document.DocumentStatusResult>> GetDocumentStatusAsync(valuetype System.Guid id, valuetype System.Guid documentId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentStatusAsync(System.Guid,System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentStatusAsync (id As Guid, documentId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentStatusResult))" />
<MemberSignature Language="F#" Value="abstract member GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>
override this.GetDocumentStatusAsync : Guid * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>>" Usage="documentTranslationClient.GetDocumentStatusAsync (id, documentId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Translation.Document.DocumentStatusResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="id" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="documentId" Type="System.Guid" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="id"> Format - uuid. The batch id. </param>
<param name="documentId"> Format - uuid. The document id. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Returns the status for a specific document. </summary>
<returns>To be added.</returns>
<remarks>
Returns the translation status for a specific document based on the request Id
and document Id.
</remarks>
</Docs>
</Member>
<Member MemberName="GetDocumentTranslationClient">
<MemberSignature Language="C#" Value="public virtual Azure.AI.Translation.Document.DocumentTranslationClient GetDocumentTranslationClient (string apiVersion = "2024-05-01");" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.Translation.Document.DocumentTranslationClient GetDocumentTranslationClient(string apiVersion) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetDocumentTranslationClient(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetDocumentTranslationClient (Optional apiVersion As String = "2024-05-01") As DocumentTranslationClient" />
<MemberSignature Language="F#" Value="abstract member GetDocumentTranslationClient : string -> Azure.AI.Translation.Document.DocumentTranslationClient
override this.GetDocumentTranslationClient : string -> Azure.AI.Translation.Document.DocumentTranslationClient" Usage="documentTranslationClient.GetDocumentTranslationClient apiVersion" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.Translation.Document.DocumentTranslationClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="apiVersion" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="apiVersion"> The API version to use for this operation. </param>
<summary> Initializes a new instance of DocumentTranslation. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="apiVersion" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="documentTranslationClient.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get a hash code for the TextAnalyticsClient.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSupportedDocumentFormats">
<MemberSignature Language="C#" Value="public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>> GetSupportedDocumentFormats (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Translation.Document.DocumentTranslationFileFormat>> GetSupportedDocumentFormats(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetSupportedDocumentFormats(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedDocumentFormats (Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of DocumentTranslationFileFormat))" />
<MemberSignature Language="F#" Value="abstract member GetSupportedDocumentFormats : System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>
override this.GetSupportedDocumentFormats : System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>" Usage="documentTranslationClient.GetSupportedDocumentFormats cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Get the list of the document formats supported by the Document Translation service.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSupportedDocumentFormatsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>> GetSupportedDocumentFormatsAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.Translation.Document.DocumentTranslationFileFormat>>> GetSupportedDocumentFormatsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetSupportedDocumentFormatsAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedDocumentFormatsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of DocumentTranslationFileFormat)))" />
<MemberSignature Language="F#" Value="abstract member GetSupportedDocumentFormatsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>>
override this.GetSupportedDocumentFormatsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>>" Usage="documentTranslationClient.GetSupportedDocumentFormatsAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.AI.Translation.Document.DocumentTranslationFileFormat>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Get the list of the document formats supported by the Document Translation service.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSupportedFormats">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats> GetSupportedFormats (Azure.AI.Translation.Document.FileFormatType? type = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Translation.Document.SupportedFileFormats> GetSupportedFormats(valuetype System.Nullable`1<valuetype Azure.AI.Translation.Document.FileFormatType> type, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Translation.Document.DocumentTranslationClient.GetSupportedFormats(System.Nullable{Azure.AI.Translation.Document.FileFormatType},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedFormats (Optional type As Nullable(Of FileFormatType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SupportedFileFormats)" />
<MemberSignature Language="F#" Value="abstract member GetSupportedFormats : Nullable<Azure.AI.Translation.Document.FileFormatType> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats>
override this.GetSupportedFormats : Nullable<Azure.AI.Translation.Document.FileFormatType> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats>" Usage="documentTranslationClient.GetSupportedFormats (type, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Translation.Document</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Translation.Document.SupportedFileFormats></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Nullable<Azure.AI.Translation.Document.FileFormatType>" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="type"> the type of format like document or glossary. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Returns a list of supported document formats. </summary>
<returns>To be added.</returns>
<remarks>