This repository has been archived by the owner on Oct 14, 2023. It is now read-only.
/
TranslationServiceClient.java
1431 lines (1367 loc) · 60.5 KB
/
TranslationServiceClient.java
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
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.translate.v3;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.translate.v3.stub.TranslationServiceStub;
import com.google.cloud.translate.v3.stub.TranslationServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Provides natural language translation operations.
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
* <pre>
* <code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String targetLanguageCode = "";
* List<String> contents = new ArrayList<>();
* TranslateTextResponse response = translationServiceClient.translateText(parent, targetLanguageCode, contents);
* }
* </code>
* </pre>
*
* <p>Note: close() needs to be called on the translationServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
* <p>This class can be customized by passing in a custom instance of TranslationServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>
* <code>
* TranslationServiceSettings translationServiceSettings =
* TranslationServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* TranslationServiceClient translationServiceClient =
* TranslationServiceClient.create(translationServiceSettings);
* </code>
* </pre>
*
* To customize the endpoint:
*
* <pre>
* <code>
* TranslationServiceSettings translationServiceSettings =
* TranslationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* TranslationServiceClient translationServiceClient =
* TranslationServiceClient.create(translationServiceSettings);
* </code>
* </pre>
*/
@Generated("by gapic-generator")
@BetaApi
public class TranslationServiceClient implements BackgroundResource {
private final TranslationServiceSettings settings;
private final TranslationServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of TranslationServiceClient with default settings. */
public static final TranslationServiceClient create() throws IOException {
return create(TranslationServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of TranslationServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final TranslationServiceClient create(TranslationServiceSettings settings)
throws IOException {
return new TranslationServiceClient(settings);
}
/**
* Constructs an instance of TranslationServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer to use TranslationServiceSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final TranslationServiceClient create(TranslationServiceStub stub) {
return new TranslationServiceClient(stub);
}
/**
* Constructs an instance of TranslationServiceClient, using the given settings. This is protected
* so that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected TranslationServiceClient(TranslationServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((TranslationServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected TranslationServiceClient(TranslationServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final TranslationServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public TranslationServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns
* NOT_FOUND, if the glossary doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]");
* DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(name).get();
* }
* </code></pre>
*
* @param name Required. The name of the glossary to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> deleteGlossaryAsync(
GlossaryName name) {
DeleteGlossaryRequest request =
DeleteGlossaryRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteGlossaryAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns
* NOT_FOUND, if the glossary doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]");
* DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(name.toString()).get();
* }
* </code></pre>
*
* @param name Required. The name of the glossary to delete.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> deleteGlossaryAsync(
String name) {
DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder().setName(name).build();
return deleteGlossaryAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns
* NOT_FOUND, if the glossary doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]");
* DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder()
* .setName(name.toString())
* .build();
* DeleteGlossaryResponse response = translationServiceClient.deleteGlossaryAsync(request).get();
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> deleteGlossaryAsync(
DeleteGlossaryRequest request) {
return deleteGlossaryOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns
* NOT_FOUND, if the glossary doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]");
* DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder()
* .setName(name.toString())
* .build();
* OperationFuture<DeleteGlossaryResponse, DeleteGlossaryMetadata> future = translationServiceClient.deleteGlossaryOperationCallable().futureCall(request);
* // Do something
* DeleteGlossaryResponse response = future.get();
* }
* </code></pre>
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<
DeleteGlossaryRequest, DeleteGlossaryResponse, DeleteGlossaryMetadata>
deleteGlossaryOperationCallable() {
return stub.deleteGlossaryOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns
* NOT_FOUND, if the glossary doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* GlossaryName name = GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]");
* DeleteGlossaryRequest request = DeleteGlossaryRequest.newBuilder()
* .setName(name.toString())
* .build();
* ApiFuture<Operation> future = translationServiceClient.deleteGlossaryCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<DeleteGlossaryRequest, Operation> deleteGlossaryCallable() {
return stub.deleteGlossaryCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String targetLanguageCode = "";
* List<String> contents = new ArrayList<>();
* TranslateTextResponse response = translationServiceClient.translateText(parent, targetLanguageCode, contents);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for requests using AutoML models or custom glossaries.
* <p>Models and glossaries must be within the same region (have same location-id), otherwise
* an INVALID_ARGUMENT (400) error is returned.
* @param targetLanguageCode Required. The BCP-47 language code to use for translation of the
* input text, set to one of the language codes listed in Language Support.
* @param contents Required. The content of the input in string format. We recommend the total
* content be less than 30k codepoints. Use BatchTranslateText for larger text.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TranslateTextResponse translateText(
LocationName parent, String targetLanguageCode, List<String> contents) {
TranslateTextRequest request =
TranslateTextRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTargetLanguageCode(targetLanguageCode)
.addAllContents(contents)
.build();
return translateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String targetLanguageCode = "";
* List<String> contents = new ArrayList<>();
* TranslateTextResponse response = translationServiceClient.translateText(parent.toString(), targetLanguageCode, contents);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for requests using AutoML models or custom glossaries.
* <p>Models and glossaries must be within the same region (have same location-id), otherwise
* an INVALID_ARGUMENT (400) error is returned.
* @param targetLanguageCode Required. The BCP-47 language code to use for translation of the
* input text, set to one of the language codes listed in Language Support.
* @param contents Required. The content of the input in string format. We recommend the total
* content be less than 30k codepoints. Use BatchTranslateText for larger text.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TranslateTextResponse translateText(
String parent, String targetLanguageCode, List<String> contents) {
TranslateTextRequest request =
TranslateTextRequest.newBuilder()
.setParent(parent)
.setTargetLanguageCode(targetLanguageCode)
.addAllContents(contents)
.build();
return translateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String mimeType = "";
* String sourceLanguageCode = "";
* String targetLanguageCode = "";
* List<String> contents = new ArrayList<>();
* TranslateTextResponse response = translationServiceClient.translateText(parent, model, mimeType, sourceLanguageCode, targetLanguageCode, contents);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for requests using AutoML models or custom glossaries.
* <p>Models and glossaries must be within the same region (have same location-id), otherwise
* an INVALID_ARGUMENT (400) error is returned.
* @param model Optional. The `model` type requested for this translation.
* <p>The format depends on model type:
* <p>- AutoML Translation models:
* `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
* <p>- General (built-in) models:
* `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
* `projects/{project-number-or-id}/locations/{location-id}/models/general/base`
* <p>For global (non-regionalized) requests, use `location-id` `global`. For example,
* `projects/{project-number-or-id}/locations/global/models/general/nmt`.
* <p>If missing, the system decides which google base model to use.
* @param mimeType Optional. The format of the source text, for example, "text/html",
* "text/plain". If left blank, the MIME type defaults to "text/html".
* @param sourceLanguageCode Optional. The BCP-47 language code of the input text if known, for
* example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If
* the source language isn't specified, the API attempts to identify the source language
* automatically and returns the source language within the response.
* @param targetLanguageCode Required. The BCP-47 language code to use for translation of the
* input text, set to one of the language codes listed in Language Support.
* @param contents Required. The content of the input in string format. We recommend the total
* content be less than 30k codepoints. Use BatchTranslateText for larger text.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TranslateTextResponse translateText(
LocationName parent,
String model,
String mimeType,
String sourceLanguageCode,
String targetLanguageCode,
List<String> contents) {
TranslateTextRequest request =
TranslateTextRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setModel(model)
.setMimeType(mimeType)
.setSourceLanguageCode(sourceLanguageCode)
.setTargetLanguageCode(targetLanguageCode)
.addAllContents(contents)
.build();
return translateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String mimeType = "";
* String sourceLanguageCode = "";
* String targetLanguageCode = "";
* List<String> contents = new ArrayList<>();
* TranslateTextResponse response = translationServiceClient.translateText(parent.toString(), model, mimeType, sourceLanguageCode, targetLanguageCode, contents);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for requests using AutoML models or custom glossaries.
* <p>Models and glossaries must be within the same region (have same location-id), otherwise
* an INVALID_ARGUMENT (400) error is returned.
* @param model Optional. The `model` type requested for this translation.
* <p>The format depends on model type:
* <p>- AutoML Translation models:
* `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
* <p>- General (built-in) models:
* `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
* `projects/{project-number-or-id}/locations/{location-id}/models/general/base`
* <p>For global (non-regionalized) requests, use `location-id` `global`. For example,
* `projects/{project-number-or-id}/locations/global/models/general/nmt`.
* <p>If missing, the system decides which google base model to use.
* @param mimeType Optional. The format of the source text, for example, "text/html",
* "text/plain". If left blank, the MIME type defaults to "text/html".
* @param sourceLanguageCode Optional. The BCP-47 language code of the input text if known, for
* example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If
* the source language isn't specified, the API attempts to identify the source language
* automatically and returns the source language within the response.
* @param targetLanguageCode Required. The BCP-47 language code to use for translation of the
* input text, set to one of the language codes listed in Language Support.
* @param contents Required. The content of the input in string format. We recommend the total
* content be less than 30k codepoints. Use BatchTranslateText for larger text.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TranslateTextResponse translateText(
String parent,
String model,
String mimeType,
String sourceLanguageCode,
String targetLanguageCode,
List<String> contents) {
TranslateTextRequest request =
TranslateTextRequest.newBuilder()
.setParent(parent)
.setModel(model)
.setMimeType(mimeType)
.setSourceLanguageCode(sourceLanguageCode)
.setTargetLanguageCode(targetLanguageCode)
.addAllContents(contents)
.build();
return translateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* List<String> contents = new ArrayList<>();
* String targetLanguageCode = "";
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* TranslateTextRequest request = TranslateTextRequest.newBuilder()
* .addAllContents(contents)
* .setTargetLanguageCode(targetLanguageCode)
* .setParent(parent.toString())
* .build();
* TranslateTextResponse response = translationServiceClient.translateText(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TranslateTextResponse translateText(TranslateTextRequest request) {
return translateTextCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates input text and returns translated text.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* List<String> contents = new ArrayList<>();
* String targetLanguageCode = "";
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* TranslateTextRequest request = TranslateTextRequest.newBuilder()
* .addAllContents(contents)
* .setTargetLanguageCode(targetLanguageCode)
* .setParent(parent.toString())
* .build();
* ApiFuture<TranslateTextResponse> future = translationServiceClient.translateTextCallable().futureCall(request);
* // Do something
* TranslateTextResponse response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<TranslateTextRequest, TranslateTextResponse> translateTextCallable() {
return stub.translateTextCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Detects the language of text within a request.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String mimeType = "";
* String content = "";
* DetectLanguageResponse response = translationServiceClient.detectLanguage(parent, model, mimeType, content);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}/locations/{location-id}` or
* `projects/{project-number-or-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Only models within the same region (has same location-id) can be used. Otherwise an
* INVALID_ARGUMENT (400) error is returned.
* @param model Optional. The language detection model to be used.
* <p>Format:
* `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`
* <p>Only one language detection model is currently supported:
* `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`.
* <p>If not specified, the default model is used.
* @param mimeType Optional. The format of the source text, for example, "text/html",
* "text/plain". If left blank, the MIME type defaults to "text/html".
* @param content The content of the input stored as a string.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DetectLanguageResponse detectLanguage(
LocationName parent, String model, String mimeType, String content) {
DetectLanguageRequest request =
DetectLanguageRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setModel(model)
.setMimeType(mimeType)
.setContent(content)
.build();
return detectLanguage(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Detects the language of text within a request.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String mimeType = "";
* String content = "";
* DetectLanguageResponse response = translationServiceClient.detectLanguage(parent.toString(), model, mimeType, content);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}/locations/{location-id}` or
* `projects/{project-number-or-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Only models within the same region (has same location-id) can be used. Otherwise an
* INVALID_ARGUMENT (400) error is returned.
* @param model Optional. The language detection model to be used.
* <p>Format:
* `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}`
* <p>Only one language detection model is currently supported:
* `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`.
* <p>If not specified, the default model is used.
* @param mimeType Optional. The format of the source text, for example, "text/html",
* "text/plain". If left blank, the MIME type defaults to "text/html".
* @param content The content of the input stored as a string.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DetectLanguageResponse detectLanguage(
String parent, String model, String mimeType, String content) {
DetectLanguageRequest request =
DetectLanguageRequest.newBuilder()
.setParent(parent)
.setModel(model)
.setMimeType(mimeType)
.setContent(content)
.build();
return detectLanguage(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Detects the language of text within a request.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* DetectLanguageRequest request = DetectLanguageRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* DetectLanguageResponse response = translationServiceClient.detectLanguage(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DetectLanguageResponse detectLanguage(DetectLanguageRequest request) {
return detectLanguageCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Detects the language of text within a request.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* DetectLanguageRequest request = DetectLanguageRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* ApiFuture<DetectLanguageResponse> future = translationServiceClient.detectLanguageCallable().futureCall(request);
* // Do something
* DetectLanguageResponse response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<DetectLanguageRequest, DetectLanguageResponse>
detectLanguageCallable() {
return stub.detectLanguageCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns a list of supported languages for translation.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String displayLanguageCode = "";
* SupportedLanguages response = translationServiceClient.getSupportedLanguages(parent, model, displayLanguageCode);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for AutoML models.
* <p>Only models within the same region (have same location-id) can be used, otherwise an
* INVALID_ARGUMENT (400) error is returned.
* @param model Optional. Get supported languages of this model.
* <p>The format depends on model type:
* <p>- AutoML Translation models:
* `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
* <p>- General (built-in) models:
* `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
* `projects/{project-number-or-id}/locations/{location-id}/models/general/base`
* <p>Returns languages supported by the specified model. If missing, we get supported
* languages of Google general base (PBMT) model.
* @param displayLanguageCode Optional. The language to use to return localized, human readable
* names of supported languages. If missing, then display names are not returned in a
* response.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SupportedLanguages getSupportedLanguages(
LocationName parent, String model, String displayLanguageCode) {
GetSupportedLanguagesRequest request =
GetSupportedLanguagesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setModel(model)
.setDisplayLanguageCode(displayLanguageCode)
.build();
return getSupportedLanguages(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns a list of supported languages for translation.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String model = "";
* String displayLanguageCode = "";
* SupportedLanguages response = translationServiceClient.getSupportedLanguages(parent.toString(), model, displayLanguageCode);
* }
* </code></pre>
*
* @param parent Required. Project or location to make a call. Must refer to a caller's project.
* <p>Format: `projects/{project-number-or-id}` or
* `projects/{project-number-or-id}/locations/{location-id}`.
* <p>For global calls, use `projects/{project-number-or-id}/locations/global` or
* `projects/{project-number-or-id}`.
* <p>Non-global location is required for AutoML models.
* <p>Only models within the same region (have same location-id) can be used, otherwise an
* INVALID_ARGUMENT (400) error is returned.
* @param model Optional. Get supported languages of this model.
* <p>The format depends on model type:
* <p>- AutoML Translation models:
* `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}`
* <p>- General (built-in) models:
* `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`,
* `projects/{project-number-or-id}/locations/{location-id}/models/general/base`
* <p>Returns languages supported by the specified model. If missing, we get supported
* languages of Google general base (PBMT) model.
* @param displayLanguageCode Optional. The language to use to return localized, human readable
* names of supported languages. If missing, then display names are not returned in a
* response.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SupportedLanguages getSupportedLanguages(
String parent, String model, String displayLanguageCode) {
GetSupportedLanguagesRequest request =
GetSupportedLanguagesRequest.newBuilder()
.setParent(parent)
.setModel(model)
.setDisplayLanguageCode(displayLanguageCode)
.build();
return getSupportedLanguages(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns a list of supported languages for translation.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* GetSupportedLanguagesRequest request = GetSupportedLanguagesRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* SupportedLanguages response = translationServiceClient.getSupportedLanguages(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SupportedLanguages getSupportedLanguages(GetSupportedLanguagesRequest request) {
return getSupportedLanguagesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns a list of supported languages for translation.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* GetSupportedLanguagesRequest request = GetSupportedLanguagesRequest.newBuilder()
* .setParent(parent.toString())
* .build();
* ApiFuture<SupportedLanguages> future = translationServiceClient.getSupportedLanguagesCallable().futureCall(request);
* // Do something
* SupportedLanguages response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<GetSupportedLanguagesRequest, SupportedLanguages>
getSupportedLanguagesCallable() {
return stub.getSupportedLanguagesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates a large volume of text in asynchronous batch mode. This function provides real-time
* output as the inputs are being processed. If caller cancels a request, the partial results (for
* an input file, it's all or nothing) may still be available on the specified output location.
*
* <p>This call returns immediately and you can use google.longrunning.Operation.name to poll the
* status of the call.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String sourceLanguageCode = "";
* List<String> targetLanguageCodes = new ArrayList<>();
* List<InputConfig> inputConfigs = new ArrayList<>();
* OutputConfig outputConfig = OutputConfig.newBuilder().build();
* BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder()
* .setParent(parent.toString())
* .setSourceLanguageCode(sourceLanguageCode)
* .addAllTargetLanguageCodes(targetLanguageCodes)
* .addAllInputConfigs(inputConfigs)
* .setOutputConfig(outputConfig)
* .build();
* BatchTranslateResponse response = translationServiceClient.batchTranslateTextAsync(request).get();
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<BatchTranslateResponse, BatchTranslateMetadata>
batchTranslateTextAsync(BatchTranslateTextRequest request) {
return batchTranslateTextOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates a large volume of text in asynchronous batch mode. This function provides real-time
* output as the inputs are being processed. If caller cancels a request, the partial results (for
* an input file, it's all or nothing) may still be available on the specified output location.
*
* <p>This call returns immediately and you can use google.longrunning.Operation.name to poll the
* status of the call.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String sourceLanguageCode = "";
* List<String> targetLanguageCodes = new ArrayList<>();
* List<InputConfig> inputConfigs = new ArrayList<>();
* OutputConfig outputConfig = OutputConfig.newBuilder().build();
* BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder()
* .setParent(parent.toString())
* .setSourceLanguageCode(sourceLanguageCode)
* .addAllTargetLanguageCodes(targetLanguageCodes)
* .addAllInputConfigs(inputConfigs)
* .setOutputConfig(outputConfig)
* .build();
* OperationFuture<BatchTranslateResponse, BatchTranslateMetadata> future = translationServiceClient.batchTranslateTextOperationCallable().futureCall(request);
* // Do something
* BatchTranslateResponse response = future.get();
* }
* </code></pre>
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<
BatchTranslateTextRequest, BatchTranslateResponse, BatchTranslateMetadata>
batchTranslateTextOperationCallable() {
return stub.batchTranslateTextOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Translates a large volume of text in asynchronous batch mode. This function provides real-time
* output as the inputs are being processed. If caller cancels a request, the partial results (for
* an input file, it's all or nothing) may still be available on the specified output location.
*
* <p>This call returns immediately and you can use google.longrunning.Operation.name to poll the
* status of the call.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* String sourceLanguageCode = "";
* List<String> targetLanguageCodes = new ArrayList<>();
* List<InputConfig> inputConfigs = new ArrayList<>();
* OutputConfig outputConfig = OutputConfig.newBuilder().build();
* BatchTranslateTextRequest request = BatchTranslateTextRequest.newBuilder()
* .setParent(parent.toString())
* .setSourceLanguageCode(sourceLanguageCode)
* .addAllTargetLanguageCodes(targetLanguageCodes)
* .addAllInputConfigs(inputConfigs)
* .setOutputConfig(outputConfig)
* .build();
* ApiFuture<Operation> future = translationServiceClient.batchTranslateTextCallable().futureCall(request);
* // Do something
* Operation response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<BatchTranslateTextRequest, Operation> batchTranslateTextCallable() {
return stub.batchTranslateTextCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project
* doesn't exist.
*
* <p>Sample code:
*
* <pre><code>
* try (TranslationServiceClient translationServiceClient = TranslationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Glossary glossary = Glossary.newBuilder().build();
* Glossary response = translationServiceClient.createGlossaryAsync(parent, glossary).get();
* }
* </code></pre>
*
* @param parent Required. The project name.
* @param glossary Required. The glossary to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Glossary, CreateGlossaryMetadata> createGlossaryAsync(
LocationName parent, Glossary glossary) {
CreateGlossaryRequest request =
CreateGlossaryRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setGlossary(glossary)
.build();
return createGlossaryAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project
* doesn't exist.
*
* <p>Sample code:
*
* <pre><code>