4545
4646// AUTO-GENERATED DOCUMENTATION AND CLASS.
4747/**
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
4949 * processor's definition. Processors are built using state-of-the-art Google AI such as natural
5050 * language, computer vision, and translation to extract structured information from unstructured or
5151 * semi-structured documents.
@@ -525,8 +525,9 @@ public final UnaryCallable<BatchProcessRequest, Operation> batchProcessDocuments
525525
526526 // AUTO-GENERATED DOCUMENTATION AND METHOD.
527527 /**
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.
530531 *
531532 * <p>Sample code:
532533 *
@@ -544,9 +545,8 @@ public final UnaryCallable<BatchProcessRequest, Operation> batchProcessDocuments
544545 * }
545546 * }</pre>
546547 *
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}`.
550550 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
551551 */
552552 public final FetchProcessorTypesResponse fetchProcessorTypes (LocationName parent ) {
@@ -559,8 +559,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent
559559
560560 // AUTO-GENERATED DOCUMENTATION AND METHOD.
561561 /**
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.
564565 *
565566 * <p>Sample code:
566567 *
@@ -578,9 +579,8 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(LocationName parent
578579 * }
579580 * }</pre>
580581 *
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}`.
584584 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
585585 */
586586 public final FetchProcessorTypesResponse fetchProcessorTypes (String parent ) {
@@ -591,8 +591,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(String parent) {
591591
592592 // AUTO-GENERATED DOCUMENTATION AND METHOD.
593593 /**
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.
596597 *
597598 * <p>Sample code:
598599 *
@@ -622,8 +623,9 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypes
622623
623624 // AUTO-GENERATED DOCUMENTATION AND METHOD.
624625 /**
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.
627629 *
628630 * <p>Sample code:
629631 *
@@ -673,9 +675,8 @@ public final FetchProcessorTypesResponse fetchProcessorTypes(FetchProcessorTypes
673675 * }
674676 * }</pre>
675677 *
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}`.
679680 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
680681 */
681682 public final ListProcessorTypesPagedResponse listProcessorTypes (LocationName parent ) {
@@ -708,9 +709,8 @@ public final ListProcessorTypesPagedResponse listProcessorTypes(LocationName par
708709 * }
709710 * }</pre>
710711 *
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}`.
714714 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
715715 */
716716 public final ListProcessorTypesPagedResponse listProcessorTypes (String parent ) {
@@ -1232,7 +1232,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
12321232 // AUTO-GENERATED DOCUMENTATION AND METHOD.
12331233 /**
12341234 * Trains a new processor version. Operation metadata is returned as
1235- * cloud_documentai_core. TrainProcessorVersionMetadata.
1235+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
12361236 *
12371237 * <p>Sample code:
12381238 *
@@ -1269,7 +1269,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
12691269 // AUTO-GENERATED DOCUMENTATION AND METHOD.
12701270 /**
12711271 * Trains a new processor version. Operation metadata is returned as
1272- * cloud_documentai_core. TrainProcessorVersionMetadata.
1272+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
12731273 *
12741274 * <p>Sample code:
12751275 *
@@ -1306,7 +1306,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
13061306 // AUTO-GENERATED DOCUMENTATION AND METHOD.
13071307 /**
13081308 * Trains a new processor version. Operation metadata is returned as
1309- * cloud_documentai_core. TrainProcessorVersionMetadata.
1309+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
13101310 *
13111311 * <p>Sample code:
13121312 *
@@ -1342,7 +1342,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
13421342 // AUTO-GENERATED DOCUMENTATION AND METHOD.
13431343 /**
13441344 * Trains a new processor version. Operation metadata is returned as
1345- * cloud_documentai_core. TrainProcessorVersionMetadata.
1345+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
13461346 *
13471347 * <p>Sample code:
13481348 *
@@ -1382,7 +1382,7 @@ public final UnaryCallable<GetProcessorRequest, Processor> getProcessorCallable(
13821382 // AUTO-GENERATED DOCUMENTATION AND METHOD.
13831383 /**
13841384 * Trains a new processor version. Operation metadata is returned as
1385- * cloud_documentai_core. TrainProcessorVersionMetadata.
1385+ * [TrainProcessorVersionMetadata][google.cloud.documentai.v1. TrainProcessorVersionMetadata] .
13861386 *
13871387 * <p>Sample code:
13881388 *
@@ -2223,8 +2223,8 @@ public final OperationFuture<Empty, DeleteProcessorVersionMetadata> deleteProces
22232223
22242224 // AUTO-GENERATED DOCUMENTATION AND METHOD.
22252225 /**
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.
22282228 *
22292229 * <p>Sample code:
22302230 *
@@ -2244,8 +2244,11 @@ public final OperationFuture<Empty, DeleteProcessorVersionMetadata> deleteProces
22442244 *
22452245 * @param parent Required. The parent (project and location) under which to create the processor.
22462246 * 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.
22492252 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
22502253 */
22512254 public final Processor createProcessor (LocationName parent , Processor processor ) {
@@ -2259,8 +2262,8 @@ public final Processor createProcessor(LocationName parent, Processor processor)
22592262
22602263 // AUTO-GENERATED DOCUMENTATION AND METHOD.
22612264 /**
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.
22642267 *
22652268 * <p>Sample code:
22662269 *
@@ -2280,8 +2283,11 @@ public final Processor createProcessor(LocationName parent, Processor processor)
22802283 *
22812284 * @param parent Required. The parent (project and location) under which to create the processor.
22822285 * 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.
22852291 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
22862292 */
22872293 public final Processor createProcessor (String parent , Processor processor ) {
@@ -2292,8 +2298,8 @@ public final Processor createProcessor(String parent, Processor processor) {
22922298
22932299 // AUTO-GENERATED DOCUMENTATION AND METHOD.
22942300 /**
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.
22972303 *
22982304 * <p>Sample code:
22992305 *
@@ -2323,8 +2329,8 @@ public final Processor createProcessor(CreateProcessorRequest request) {
23232329
23242330 // AUTO-GENERATED DOCUMENTATION AND METHOD.
23252331 /**
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.
23282334 *
23292335 * <p>Sample code:
23302336 *
@@ -2825,8 +2831,9 @@ public final UnaryCallable<DisableProcessorRequest, Operation> disableProcessorC
28252831 * }
28262832 * }</pre>
28272833 *
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.
28302837 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
28312838 */
28322839 public final OperationFuture <ReviewDocumentResponse , ReviewDocumentOperationMetadata >
@@ -2860,8 +2867,9 @@ public final UnaryCallable<DisableProcessorRequest, Operation> disableProcessorC
28602867 * }
28612868 * }</pre>
28622869 *
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.
28652873 * @throws com.google.api.gax.rpc.ApiException if the remote call fails
28662874 */
28672875 public final OperationFuture <ReviewDocumentResponse , ReviewDocumentOperationMetadata >
0 commit comments