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

Commit

Permalink
docs: Fix formatting of request arg in docstring (#473)
Browse files Browse the repository at this point in the history 
* chore: Update gapic-generator-python to v1.9.0

PiperOrigin-RevId: 517425588

Source-Link: googleapis/googleapis@33c93eb

Source-Link: googleapis/googleapis-gen@d5f5978
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: googleapis/googleapis-gen@a9e1daa
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: googleapis/googleapis-gen@b2ab4b0
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>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Mar 24, 2023
1 parent 71f351b commit f3aa285
Show file tree
Hide file tree
Showing 27 changed files with 1,427 additions and 76 deletions.
14 changes: 8 additions & 6 deletions google/cloud/documentai_v1/services/document_processor_service/async_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1364,7 +1364,8 @@ async def sample_list_processor_versions():
Args:
request (Optional[Union[google.cloud.documentai_v1.types.ListProcessorVersionsRequest, dict]]):
The request object. Request message for list all
processor versions belongs to a processor.
processor versions belongs to a
processor.
parent (:class:`str`):
Required. The parent (project, location and processor)
to list all versions. Format:
Expand Down Expand Up @@ -1850,9 +1851,10 @@ async def sample_create_processor():
Args:
request (Optional[Union[google.cloud.documentai_v1.types.CreateProcessorRequest, dict]]):
The request object. Request message for create a
processor. Notice this request is sent to a regionalized
backend service, and if the processor type is not
available on that region, the creation will fail.
processor. Notice this request is sent
to a regionalized backend service, and
if the processor type is not available
on that region, the creation will fail.
parent (:class:`str`):
Required. The parent (project and location) under which
to create the processor. Format:
Expand Down Expand Up @@ -2764,8 +2766,8 @@ async def sample_list_evaluations():
Args:
request (Optional[Union[google.cloud.documentai_v1.types.ListEvaluationsRequest, dict]]):
The request object. Retrieves a list of evaluations for
a given ProcessorVersion.
The request object. Retrieves a list of evaluations for a
given ProcessorVersion.
parent (:class:`str`):
Required. The resource name of the
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
Expand Down
14 changes: 8 additions & 6 deletions google/cloud/documentai_v1/services/document_processor_service/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1646,7 +1646,8 @@ def sample_list_processor_versions():
Args:
request (Union[google.cloud.documentai_v1.types.ListProcessorVersionsRequest, dict]):
The request object. Request message for list all
processor versions belongs to a processor.
processor versions belongs to a
processor.
parent (str):
Required. The parent (project, location and processor)
to list all versions. Format:
Expand Down Expand Up @@ -2144,9 +2145,10 @@ def sample_create_processor():
Args:
request (Union[google.cloud.documentai_v1.types.CreateProcessorRequest, dict]):
The request object. Request message for create a
processor. Notice this request is sent to a regionalized
backend service, and if the processor type is not
available on that region, the creation will fail.
processor. Notice this request is sent
to a regionalized backend service, and
if the processor type is not available
on that region, the creation will fail.
parent (str):
Required. The parent (project and location) under which
to create the processor. Format:
Expand Down Expand Up @@ -3063,8 +3065,8 @@ def sample_list_evaluations():
Args:
request (Union[google.cloud.documentai_v1.types.ListEvaluationsRequest, dict]):
The request object. Retrieves a list of evaluations for
a given ProcessorVersion.
The request object. Retrieves a list of evaluations for a
given ProcessorVersion.
parent (str):
Required. The resource name of the
[ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
Expand Down
19 changes: 0 additions & 19 deletions google/cloud/documentai_v1/services/document_processor_service/transports/rest.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,6 @@ def __call__(
request (~.document_processor_service.BatchProcessRequest):
The request object. Request message for batch process
document method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1224,7 +1223,6 @@ def __call__(
to a regionalized backend service, and
if the processor type is not available
on that region, the creation will fail.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1327,7 +1325,6 @@ def __call__(
request (~.document_processor_service.DeleteProcessorRequest):
The request object. Request message for the delete
processor method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1418,7 +1415,6 @@ def __call__(
request (~.document_processor_service.DeleteProcessorVersionRequest):
The request object. Request message for the delete
processor version method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1511,7 +1507,6 @@ def __call__(
request (~.document_processor_service.DeployProcessorVersionRequest):
The request object. Request message for the deploy
processor version method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1613,7 +1608,6 @@ def __call__(
request (~.document_processor_service.DisableProcessorRequest):
The request object. Request message for the disable
processor method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1713,7 +1707,6 @@ def __call__(
request (~.document_processor_service.EnableProcessorRequest):
The request object. Request message for the enable
processor method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1814,7 +1807,6 @@ def __call__(
request (~.document_processor_service.EvaluateProcessorVersionRequest):
The request object. Evaluates the given ProcessorVersion
against the supplied documents.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -1916,7 +1908,6 @@ def __call__(
request (~.document_processor_service.FetchProcessorTypesRequest):
The request object. Request message for fetch processor
types.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2280,7 +2271,6 @@ def __call__(
request (~.document_processor_service.GetProcessorVersionRequest):
The request object. Request message for get processor
version.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2381,7 +2371,6 @@ def __call__(
request (~.document_processor_service.ListEvaluationsRequest):
The request object. Retrieves a list of evaluations for a
given ProcessorVersion.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2471,7 +2460,6 @@ def __call__(
request (~.document_processor_service.ListProcessorsRequest):
The request object. Request message for list all
processors belongs to a project.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2559,7 +2547,6 @@ def __call__(
request (~.document_processor_service.ListProcessorTypesRequest):
The request object. Request message for list processor
types.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2654,7 +2641,6 @@ def __call__(
The request object. Request message for list all
processor versions belongs to a
processor.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2746,7 +2732,6 @@ def __call__(
request (~.document_processor_service.ProcessRequest):
The request object. Request message for the process
document method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2852,7 +2837,6 @@ def __call__(
request (~.document_processor_service.ReviewDocumentRequest):
The request object. Request message for review document
method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -2951,7 +2935,6 @@ def __call__(
request (~.document_processor_service.SetDefaultProcessorVersionRequest):
The request object. Request message for the set default
processor version method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -3053,7 +3036,6 @@ def __call__(
request (~.document_processor_service.TrainProcessorVersionRequest):
The request object. Request message for the create
processor version method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down Expand Up @@ -3156,7 +3138,6 @@ def __call__(
request (~.document_processor_service.UndeployProcessorVersionRequest):
The request object. Request message for the undeploy
processor version method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/documentai_v1beta2/services/document_understanding_service/async_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,9 @@ async def sample_batch_process_documents():
Args:
request (Optional[Union[google.cloud.documentai_v1beta2.types.BatchProcessDocumentsRequest, dict]]):
The request object. Request to batch process documents
as an asynchronous operation. The output is written to
Cloud Storage as JSON in the [Document] format.
The request object. Request to batch process documents as an asynchronous
operation. The output is written to Cloud Storage as
JSON in the [Document] format.
requests (:class:`MutableSequence[google.cloud.documentai_v1beta2.types.ProcessDocumentRequest]`):
Required. Individual requests for
each document.
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/documentai_v1beta2/services/document_understanding_service/client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -481,9 +481,9 @@ def sample_batch_process_documents():
Args:
request (Union[google.cloud.documentai_v1beta2.types.BatchProcessDocumentsRequest, dict]):
The request object. Request to batch process documents
as an asynchronous operation. The output is written to
Cloud Storage as JSON in the [Document] format.
The request object. Request to batch process documents as an asynchronous
operation. The output is written to Cloud Storage as
JSON in the [Document] format.
requests (MutableSequence[google.cloud.documentai_v1beta2.types.ProcessDocumentRequest]):
Required. Individual requests for
each document.
Expand Down
6 changes: 6 additions & 0 deletions google/cloud/documentai_v1beta3/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@
GetProcessorTypeRequest,
GetProcessorVersionRequest,
HumanReviewStatus,
ImportProcessorVersionMetadata,
ImportProcessorVersionRequest,
ImportProcessorVersionResponse,
ListEvaluationsRequest,
ListEvaluationsResponse,
ListProcessorsRequest,
Expand Down Expand Up @@ -134,6 +137,9 @@
"GetProcessorTypeRequest",
"GetProcessorVersionRequest",
"HumanReviewStatus",
"ImportProcessorVersionMetadata",
"ImportProcessorVersionRequest",
"ImportProcessorVersionResponse",
"ListEvaluationsRequest",
"ListEvaluationsResponse",
"ListProcessorTypesRequest",
Expand Down
15 changes: 15 additions & 0 deletions google/cloud/documentai_v1beta3/gapic_metadata.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@
"get_processor_version"
]
},
"ImportProcessorVersion": {
"methods": [
"import_processor_version"
]
},
"ListEvaluations": {
"methods": [
"list_evaluations"
Expand Down Expand Up @@ -190,6 +195,11 @@
"get_processor_version"
]
},
"ImportProcessorVersion": {
"methods": [
"import_processor_version"
]
},
"ListEvaluations": {
"methods": [
"list_evaluations"
Expand Down Expand Up @@ -305,6 +315,11 @@
"get_processor_version"
]
},
"ImportProcessorVersion": {
"methods": [
"import_processor_version"
]
},
"ListEvaluations": {
"methods": [
"list_evaluations"
Expand Down
Loading

0 comments on commit f3aa285

Please sign in to comment.