45
45
46
46
// AUTO-GENERATED DOCUMENTATION AND CLASS.
47
47
/**
48
- * Service Description: Service to call Cloud DocumentAI to process documents according to the
48
+ * Service Description: Service to call Document AI to process documents according to the
49
49
* processor's definition. Processors are built using state-of-the-art Google AI such as natural
50
50
* language, computer vision, and translation to extract structured information from unstructured or
51
51
* semi-structured documents.
@@ -525,8 +525,9 @@ public final UnaryCallable<BatchProcessRequest, Operation> batchProcessDocuments
525
525
526
526
// AUTO-GENERATED DOCUMENTATION AND METHOD.
527
527
/**
528
- * Fetches processor types. Note that we do not use ListProcessorTypes here because it is not
529
- * paginated.
528
+ * Fetches processor types. Note that we don't use
529
+ * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
530
+ * here, because it isn't paginated.
530
531
*
531
532
* <p>Sample code:
532
533
*
@@ -544,9 +545,8 @@ public final UnaryCallable<BatchProcessRequest, Operation> batchProcessDocuments
544
545
* }
545
546
* }</pre>
546
547
*
547
- * @param parent Required. The project of processor type to list. The available processor types
548
- * may depend on the allow-listing on projects. Format:
549
- * `projects/{project}/locations/{location}`
548
+ * @param parent Required. The location of processor types to list. Format:
549
+ * `projects/{project}/locations/{location}`.
550
550
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
551
551
*/
552
552
public final FetchProcessorTypesResponse fetchProcessorTypes (LocationName parent ) {
@@ -559,8 +559,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent
559
559
560
560
// AUTO-GENERATED DOCUMENTATION AND METHOD.
561
561
/**
562
- * Fetches processor types. Note that we do not use ListProcessorTypes here because it is not
563
- * paginated.
562
+ * Fetches processor types. Note that we don't use
563
+ * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
564
+ * here, because it isn't paginated.
564
565
*
565
566
* <p>Sample code:
566
567
*
@@ -578,9 +579,8 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent
578
579
* }
579
580
* }</pre>
580
581
*
581
- * @param parent Required. The project of processor type to list. The available processor types
582
- * may depend on the allow-listing on projects. Format:
583
- * `projects/{project}/locations/{location}`
582
+ * @param parent Required. The location of processor types to list. Format:
583
+ * `projects/{project}/locations/{location}`.
584
584
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
585
585
*/
586
586
public final FetchProcessorTypesResponse fetchProcessorTypes (String parent ) {
@@ -591,8 +591,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(String parent) {
591
591
592
592
// AUTO-GENERATED DOCUMENTATION AND METHOD.
593
593
/**
594
- * Fetches processor types. Note that we do not use ListProcessorTypes here because it is not
595
- * paginated.
594
+ * Fetches processor types. Note that we don't use
595
+ * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
596
+ * here, because it isn't paginated.
596
597
*
597
598
* <p>Sample code:
598
599
*
@@ -622,8 +623,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypes
622
623
623
624
// AUTO-GENERATED DOCUMENTATION AND METHOD.
624
625
/**
625
- * Fetches processor types. Note that we do not use ListProcessorTypes here because it is not
626
- * paginated.
626
+ * Fetches processor types. Note that we don't use
627
+ * [ListProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypes]
628
+ * here, because it isn't paginated.
627
629
*
628
630
* <p>Sample code:
629
631
*
@@ -673,9 +675,8 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypes
673
675
* }
674
676
* }</pre>
675
677
*
676
- * @param parent Required. The location of processor type to list. The available processor types
677
- * may depend on the allow-listing on projects. Format:
678
- * `projects/{project}/locations/{location}`
678
+ * @param parent Required. The location of processor types to list. Format:
679
+ * `projects/{project}/locations/{location}`.
679
680
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
680
681
*/
681
682
public final ListProcessorTypesPagedResponse listProcessorTypes (LocationName parent ) {
@@ -708,9 +709,8 @@ public final ListProcessorTypesPagedResponse listProcessorTypes(LocationName par
708
709
* }
709
710
* }</pre>
710
711
*
711
- * @param parent Required. The location of processor type to list. The available processor types
712
- * may depend on the allow-listing on projects. Format:
713
- * `projects/{project}/locations/{location}`
712
+ * @param parent Required. The location of processor types to list. Format:
713
+ * `projects/{project}/locations/{location}`.
714
714
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
715
715
*/
716
716
public final ListProcessorTypesPagedResponse listProcessorTypes (String parent ) {
@@ -1232,7 +1232,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
1232
1232
// AUTO-GENERATED DOCUMENTATION AND METHOD.
1233
1233
/**
1234
1234
* Trains a new processor version. Operation metadata is returned as
1235
- * cloud_documentai_core. TrainProcessorVersionMetadata.
1235
+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
1236
1236
*
1237
1237
* <p>Sample code:
1238
1238
*
@@ -1269,7 +1269,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
1269
1269
// AUTO-GENERATED DOCUMENTATION AND METHOD.
1270
1270
/**
1271
1271
* Trains a new processor version. Operation metadata is returned as
1272
- * cloud_documentai_core. TrainProcessorVersionMetadata.
1272
+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
1273
1273
*
1274
1274
* <p>Sample code:
1275
1275
*
@@ -1306,7 +1306,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
1306
1306
// AUTO-GENERATED DOCUMENTATION AND METHOD.
1307
1307
/**
1308
1308
* Trains a new processor version. Operation metadata is returned as
1309
- * cloud_documentai_core. TrainProcessorVersionMetadata.
1309
+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
1310
1310
*
1311
1311
* <p>Sample code:
1312
1312
*
@@ -1342,7 +1342,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
1342
1342
// AUTO-GENERATED DOCUMENTATION AND METHOD.
1343
1343
/**
1344
1344
* Trains a new processor version. Operation metadata is returned as
1345
- * cloud_documentai_core. TrainProcessorVersionMetadata.
1345
+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
1346
1346
*
1347
1347
* <p>Sample code:
1348
1348
*
@@ -1382,7 +1382,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
1382
1382
// AUTO-GENERATED DOCUMENTATION AND METHOD.
1383
1383
/**
1384
1384
* Trains a new processor version. Operation metadata is returned as
1385
- * cloud_documentai_core. TrainProcessorVersionMetadata.
1385
+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
1386
1386
*
1387
1387
* <p>Sample code:
1388
1388
*
@@ -2223,8 +2223,8 @@ public final OperationFuture<Empty, DeleteProcessorVersionMetadata> deleteProces
2223
2223
2224
2224
// AUTO-GENERATED DOCUMENTATION AND METHOD.
2225
2225
/**
2226
- * Creates a processor from the type processor that the user chose. The processor will be at
2227
- * " ENABLED" state by default after its creation.
2226
+ * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType]
2227
+ * provided. The processor will be at ` ENABLED` state by default after its creation.
2228
2228
*
2229
2229
* <p>Sample code:
2230
2230
*
@@ -2244,8 +2244,11 @@ public final OperationFuture<Empty, DeleteProcessorVersionMetadata> deleteProces
2244
2244
*
2245
2245
* @param parent Required. The parent (project and location) under which to create the processor.
2246
2246
* Format: `projects/{project}/locations/{location}`
2247
- * @param processor Required. The processor to be created, requires [processor_type] and
2248
- * [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set.
2247
+ * @param processor Required. The processor to be created, requires
2248
+ * [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][]
2249
+ * to be set. Also, the
2250
+ * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be
2251
+ * set if the processor is under CMEK.
2249
2252
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
2250
2253
*/
2251
2254
public final Processor createProcessor (LocationName parent , Processor processor ) {
@@ -2259,8 +2262,8 @@ public final Processor createProcessor(LocationName parent, Processor processor)
2259
2262
2260
2263
// AUTO-GENERATED DOCUMENTATION AND METHOD.
2261
2264
/**
2262
- * Creates a processor from the type processor that the user chose. The processor will be at
2263
- * " ENABLED" state by default after its creation.
2265
+ * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType]
2266
+ * provided. The processor will be at ` ENABLED` state by default after its creation.
2264
2267
*
2265
2268
* <p>Sample code:
2266
2269
*
@@ -2280,8 +2283,11 @@ public final Processor createProcessor(LocationName parent, Processor processor)
2280
2283
*
2281
2284
* @param parent Required. The parent (project and location) under which to create the processor.
2282
2285
* Format: `projects/{project}/locations/{location}`
2283
- * @param processor Required. The processor to be created, requires [processor_type] and
2284
- * [display_name] to be set. Also, the processor is under CMEK if CMEK fields are set.
2286
+ * @param processor Required. The processor to be created, requires
2287
+ * [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][]
2288
+ * to be set. Also, the
2289
+ * [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be
2290
+ * set if the processor is under CMEK.
2285
2291
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
2286
2292
*/
2287
2293
public final Processor createProcessor (String parent , Processor processor ) {
@@ -2292,8 +2298,8 @@ public final Processor createProcessor(String parent, Processor processor) {
2292
2298
2293
2299
// AUTO-GENERATED DOCUMENTATION AND METHOD.
2294
2300
/**
2295
- * Creates a processor from the type processor that the user chose. The processor will be at
2296
- * " ENABLED" state by default after its creation.
2301
+ * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType]
2302
+ * provided. The processor will be at ` ENABLED` state by default after its creation.
2297
2303
*
2298
2304
* <p>Sample code:
2299
2305
*
@@ -2323,8 +2329,8 @@ public final Processor createProcessor(CreateProcessorRequest request) {
2323
2329
2324
2330
// AUTO-GENERATED DOCUMENTATION AND METHOD.
2325
2331
/**
2326
- * Creates a processor from the type processor that the user chose. The processor will be at
2327
- * " ENABLED" state by default after its creation.
2332
+ * Creates a processor from the [ProcessorType][google.cloud.documentai.v1.ProcessorType]
2333
+ * provided. The processor will be at ` ENABLED` state by default after its creation.
2328
2334
*
2329
2335
* <p>Sample code:
2330
2336
*
@@ -2825,8 +2831,9 @@ public final UnaryCallable<DisableProcessorRequest, Operation> disableProcessorC
2825
2831
* }
2826
2832
* }</pre>
2827
2833
*
2828
- * @param humanReviewConfig Required. The resource name of the HumanReviewConfig that the document
2829
- * will be reviewed with.
2834
+ * @param humanReviewConfig Required. The resource name of the
2835
+ * [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be
2836
+ * reviewed with.
2830
2837
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
2831
2838
*/
2832
2839
public final OperationFuture <ReviewDocumentResponse , ReviewDocumentOperationMetadata >
@@ -2860,8 +2867,9 @@ public final UnaryCallable<DisableProcessorRequest, Operation> disableProcessorC
2860
2867
* }
2861
2868
* }</pre>
2862
2869
*
2863
- * @param humanReviewConfig Required. The resource name of the HumanReviewConfig that the document
2864
- * will be reviewed with.
2870
+ * @param humanReviewConfig Required. The resource name of the
2871
+ * [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be
2872
+ * reviewed with.
2865
2873
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
2866
2874
*/
2867
2875
public final OperationFuture <ReviewDocumentResponse , ReviewDocumentOperationMetadata >
0 commit comments