Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit f3aa285

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#473)
* chore: Update gapic-generator-python to v1.9.0 PiperOrigin-RevId: 517425588 Source-Link: googleapis/googleapis@33c93eb Source-Link: https://github.com/googleapis/googleapis-gen/commit/d5f59789d19fc43270ff2124967d4ec8992b8e8f Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDVmNTk3ODlkMTlmYzQzMjcwZmYyMTI0OTY3ZDRlYzg5OTJiOGU4ZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: Add ImportProcessorVersion in v1beta3 PiperOrigin-RevId: 517997886 Source-Link: googleapis/googleapis@ae3e613 Source-Link: https://github.com/googleapis/googleapis-gen/commit/a9e1daab141f302a3320478d22c07aa65b80d8eb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTllMWRhYWIxNDFmMzAyYTMzMjA0NzhkMjJjMDdhYTY1YjgwZDhlYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 71f351b commit f3aa285

27 files changed

+1427
-76
lines changed

‎google/cloud/documentai_v1/services/document_processor_service/async_client.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,7 +1364,8 @@ async def sample_list_processor_versions():
13641364
Args:
13651365
request (Optional[Union[google.cloud.documentai_v1.types.ListProcessorVersionsRequest, dict]]):
13661366
The request object. Request message for list all
1367-
processor versions belongs to a processor.
1367+
processor versions belongs to a
1368+
processor.
13681369
parent (:class:`str`):
13691370
Required. The parent (project, location and processor)
13701371
to list all versions. Format:
@@ -1850,9 +1851,10 @@ async def sample_create_processor():
18501851
Args:
18511852
request (Optional[Union[google.cloud.documentai_v1.types.CreateProcessorRequest, dict]]):
18521853
The request object. Request message for create a
1853-
processor. Notice this request is sent to a regionalized
1854-
backend service, and if the processor type is not
1855-
available on that region, the creation will fail.
1854+
processor. Notice this request is sent
1855+
to a regionalized backend service, and
1856+
if the processor type is not available
1857+
on that region, the creation will fail.
18561858
parent (:class:`str`):
18571859
Required. The parent (project and location) under which
18581860
to create the processor. Format:
@@ -2764,8 +2766,8 @@ async def sample_list_evaluations():
27642766
27652767
Args:
27662768
request (Optional[Union[google.cloud.documentai_v1.types.ListEvaluationsRequest, dict]]):
2767-
The request object. Retrieves a list of evaluations for
2768-
a given ProcessorVersion.
2769+
The request object. Retrieves a list of evaluations for a
2770+
given ProcessorVersion.
27692771
parent (:class:`str`):
27702772
Required. The resource name of the
27712773
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]

‎google/cloud/documentai_v1/services/document_processor_service/client.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1646,7 +1646,8 @@ def sample_list_processor_versions():
16461646
Args:
16471647
request (Union[google.cloud.documentai_v1.types.ListProcessorVersionsRequest, dict]):
16481648
The request object. Request message for list all
1649-
processor versions belongs to a processor.
1649+
processor versions belongs to a
1650+
processor.
16501651
parent (str):
16511652
Required. The parent (project, location and processor)
16521653
to list all versions. Format:
@@ -2144,9 +2145,10 @@ def sample_create_processor():
21442145
Args:
21452146
request (Union[google.cloud.documentai_v1.types.CreateProcessorRequest, dict]):
21462147
The request object. Request message for create a
2147-
processor. Notice this request is sent to a regionalized
2148-
backend service, and if the processor type is not
2149-
available on that region, the creation will fail.
2148+
processor. Notice this request is sent
2149+
to a regionalized backend service, and
2150+
if the processor type is not available
2151+
on that region, the creation will fail.
21502152
parent (str):
21512153
Required. The parent (project and location) under which
21522154
to create the processor. Format:
@@ -3063,8 +3065,8 @@ def sample_list_evaluations():
30633065
30643066
Args:
30653067
request (Union[google.cloud.documentai_v1.types.ListEvaluationsRequest, dict]):
3066-
The request object. Retrieves a list of evaluations for
3067-
a given ProcessorVersion.
3068+
The request object. Retrieves a list of evaluations for a
3069+
given ProcessorVersion.
30683070
parent (str):
30693071
Required. The resource name of the
30703072
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]

‎google/cloud/documentai_v1/services/document_processor_service/transports/rest.py

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1116,7 +1116,6 @@ def __call__(
11161116
request (~.document_processor_service.BatchProcessRequest):
11171117
The request object. Request message for batch process
11181118
document method.
1119-
11201119
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11211120
should be retried.
11221121
timeout (float): The timeout for this request.
@@ -1224,7 +1223,6 @@ def __call__(
12241223
to a regionalized backend service, and
12251224
if the processor type is not available
12261225
on that region, the creation will fail.
1227-
12281226
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12291227
should be retried.
12301228
timeout (float): The timeout for this request.
@@ -1327,7 +1325,6 @@ def __call__(
13271325
request (~.document_processor_service.DeleteProcessorRequest):
13281326
The request object. Request message for the delete
13291327
processor method.
1330-
13311328
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13321329
should be retried.
13331330
timeout (float): The timeout for this request.
@@ -1418,7 +1415,6 @@ def __call__(
14181415
request (~.document_processor_service.DeleteProcessorVersionRequest):
14191416
The request object. Request message for the delete
14201417
processor version method.
1421-
14221418
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14231419
should be retried.
14241420
timeout (float): The timeout for this request.
@@ -1511,7 +1507,6 @@ def __call__(
15111507
request (~.document_processor_service.DeployProcessorVersionRequest):
15121508
The request object. Request message for the deploy
15131509
processor version method.
1514-
15151510
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15161511
should be retried.
15171512
timeout (float): The timeout for this request.
@@ -1613,7 +1608,6 @@ def __call__(
16131608
request (~.document_processor_service.DisableProcessorRequest):
16141609
The request object. Request message for the disable
16151610
processor method.
1616-
16171611
retry (google.api_core.retry.Retry): Designation of what errors, if any,
16181612
should be retried.
16191613
timeout (float): The timeout for this request.
@@ -1713,7 +1707,6 @@ def __call__(
17131707
request (~.document_processor_service.EnableProcessorRequest):
17141708
The request object. Request message for the enable
17151709
processor method.
1716-
17171710
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17181711
should be retried.
17191712
timeout (float): The timeout for this request.
@@ -1814,7 +1807,6 @@ def __call__(
18141807
request (~.document_processor_service.EvaluateProcessorVersionRequest):
18151808
The request object. Evaluates the given ProcessorVersion
18161809
against the supplied documents.
1817-
18181810
retry (google.api_core.retry.Retry): Designation of what errors, if any,
18191811
should be retried.
18201812
timeout (float): The timeout for this request.
@@ -1916,7 +1908,6 @@ def __call__(
19161908
request (~.document_processor_service.FetchProcessorTypesRequest):
19171909
The request object. Request message for fetch processor
19181910
types.
1919-
19201911
retry (google.api_core.retry.Retry): Designation of what errors, if any,
19211912
should be retried.
19221913
timeout (float): The timeout for this request.
@@ -2280,7 +2271,6 @@ def __call__(
22802271
request (~.document_processor_service.GetProcessorVersionRequest):
22812272
The request object. Request message for get processor
22822273
version.
2283-
22842274
retry (google.api_core.retry.Retry): Designation of what errors, if any,
22852275
should be retried.
22862276
timeout (float): The timeout for this request.
@@ -2381,7 +2371,6 @@ def __call__(
23812371
request (~.document_processor_service.ListEvaluationsRequest):
23822372
The request object. Retrieves a list of evaluations for a
23832373
given ProcessorVersion.
2384-
23852374
retry (google.api_core.retry.Retry): Designation of what errors, if any,
23862375
should be retried.
23872376
timeout (float): The timeout for this request.
@@ -2471,7 +2460,6 @@ def __call__(
24712460
request (~.document_processor_service.ListProcessorsRequest):
24722461
The request object. Request message for list all
24732462
processors belongs to a project.
2474-
24752463
retry (google.api_core.retry.Retry): Designation of what errors, if any,
24762464
should be retried.
24772465
timeout (float): The timeout for this request.
@@ -2559,7 +2547,6 @@ def __call__(
25592547
request (~.document_processor_service.ListProcessorTypesRequest):
25602548
The request object. Request message for list processor
25612549
types.
2562-
25632550
retry (google.api_core.retry.Retry): Designation of what errors, if any,
25642551
should be retried.
25652552
timeout (float): The timeout for this request.
@@ -2654,7 +2641,6 @@ def __call__(
26542641
The request object. Request message for list all
26552642
processor versions belongs to a
26562643
processor.
2657-
26582644
retry (google.api_core.retry.Retry): Designation of what errors, if any,
26592645
should be retried.
26602646
timeout (float): The timeout for this request.
@@ -2746,7 +2732,6 @@ def __call__(
27462732
request (~.document_processor_service.ProcessRequest):
27472733
The request object. Request message for the process
27482734
document method.
2749-
27502735
retry (google.api_core.retry.Retry): Designation of what errors, if any,
27512736
should be retried.
27522737
timeout (float): The timeout for this request.
@@ -2852,7 +2837,6 @@ def __call__(
28522837
request (~.document_processor_service.ReviewDocumentRequest):
28532838
The request object. Request message for review document
28542839
method.
2855-
28562840
retry (google.api_core.retry.Retry): Designation of what errors, if any,
28572841
should be retried.
28582842
timeout (float): The timeout for this request.
@@ -2951,7 +2935,6 @@ def __call__(
29512935
request (~.document_processor_service.SetDefaultProcessorVersionRequest):
29522936
The request object. Request message for the set default
29532937
processor version method.
2954-
29552938
retry (google.api_core.retry.Retry): Designation of what errors, if any,
29562939
should be retried.
29572940
timeout (float): The timeout for this request.
@@ -3053,7 +3036,6 @@ def __call__(
30533036
request (~.document_processor_service.TrainProcessorVersionRequest):
30543037
The request object. Request message for the create
30553038
processor version method.
3056-
30573039
retry (google.api_core.retry.Retry): Designation of what errors, if any,
30583040
should be retried.
30593041
timeout (float): The timeout for this request.
@@ -3156,7 +3138,6 @@ def __call__(
31563138
request (~.document_processor_service.UndeployProcessorVersionRequest):
31573139
The request object. Request message for the undeploy
31583140
processor version method.
3159-
31603141
retry (google.api_core.retry.Retry): Designation of what errors, if any,
31613142
should be retried.
31623143
timeout (float): The timeout for this request.

‎google/cloud/documentai_v1beta2/services/document_understanding_service/async_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,9 @@ async def sample_batch_process_documents():
277277
278278
Args:
279279
request (Optional[Union[google.cloud.documentai_v1beta2.types.BatchProcessDocumentsRequest, dict]]):
280-
The request object. Request to batch process documents
281-
as an asynchronous operation. The output is written to
282-
Cloud Storage as JSON in the [Document] format.
280+
The request object. Request to batch process documents as an asynchronous
281+
operation. The output is written to Cloud Storage as
282+
JSON in the [Document] format.
283283
requests (:class:`MutableSequence[google.cloud.documentai_v1beta2.types.ProcessDocumentRequest]`):
284284
Required. Individual requests for
285285
each document.

‎google/cloud/documentai_v1beta2/services/document_understanding_service/client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -481,9 +481,9 @@ def sample_batch_process_documents():
481481
482482
Args:
483483
request (Union[google.cloud.documentai_v1beta2.types.BatchProcessDocumentsRequest, dict]):
484-
The request object. Request to batch process documents
485-
as an asynchronous operation. The output is written to
486-
Cloud Storage as JSON in the [Document] format.
484+
The request object. Request to batch process documents as an asynchronous
485+
operation. The output is written to Cloud Storage as
486+
JSON in the [Document] format.
487487
requests (MutableSequence[google.cloud.documentai_v1beta2.types.ProcessDocumentRequest]):
488488
Required. Individual requests for
489489
each document.

‎google/cloud/documentai_v1beta3/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@
6161
GetProcessorTypeRequest,
6262
GetProcessorVersionRequest,
6363
HumanReviewStatus,
64+
ImportProcessorVersionMetadata,
65+
ImportProcessorVersionRequest,
66+
ImportProcessorVersionResponse,
6467
ListEvaluationsRequest,
6568
ListEvaluationsResponse,
6669
ListProcessorsRequest,
@@ -134,6 +137,9 @@
134137
"GetProcessorTypeRequest",
135138
"GetProcessorVersionRequest",
136139
"HumanReviewStatus",
140+
"ImportProcessorVersionMetadata",
141+
"ImportProcessorVersionRequest",
142+
"ImportProcessorVersionResponse",
137143
"ListEvaluationsRequest",
138144
"ListEvaluationsResponse",
139145
"ListProcessorTypesRequest",

‎google/cloud/documentai_v1beta3/gapic_metadata.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@
7575
"get_processor_version"
7676
]
7777
},
78+
"ImportProcessorVersion": {
79+
"methods": [
80+
"import_processor_version"
81+
]
82+
},
7883
"ListEvaluations": {
7984
"methods": [
8085
"list_evaluations"
@@ -190,6 +195,11 @@
190195
"get_processor_version"
191196
]
192197
},
198+
"ImportProcessorVersion": {
199+
"methods": [
200+
"import_processor_version"
201+
]
202+
},
193203
"ListEvaluations": {
194204
"methods": [
195205
"list_evaluations"
@@ -305,6 +315,11 @@
305315
"get_processor_version"
306316
]
307317
},
318+
"ImportProcessorVersion": {
319+
"methods": [
320+
"import_processor_version"
321+
]
322+
},
308323
"ListEvaluations": {
309324
"methods": [
310325
"list_evaluations"

0 commit comments

Comments
 (0)