Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Commit

Permalink
docs: Minor formatting (#552)
Browse files Browse the repository at this point in the history
* docs: Minor formatting
chore: Update gapic-generator-python to v1.11.5
build: Update rules_python to 0.24.0

PiperOrigin-RevId: 563436317

Source-Link: googleapis/googleapis@42fd37b

Source-Link: https://github.com/googleapis/googleapis-gen/commit/280264ca02fb9316b4237a96d0af1a2343a81a56
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMjgwMjY0Y2EwMmZiOTMxNmI0MjM3YTk2ZDBhZjFhMjM0M2E4MWE1NiJ9

* 🦉 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[bot] and gcf-owl-bot[bot] authored Sep 13, 2023
1 parent 771c38b commit 747296f
Show file tree
Hide file tree
Showing 34 changed files with 47 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ async def batch_annotate_files(
r"""Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
1 change: 1 addition & 0 deletions google/cloud/vision_v1/services/image_annotator/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,7 @@ def batch_annotate_files(
r"""Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ def batch_annotate_files(
Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ def batch_annotate_files(
Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -789,6 +789,7 @@ async def delete_product_set(
) -> None:
r"""Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -1692,6 +1693,7 @@ async def delete_reference_image(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1/services/product_search/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1021,6 +1021,7 @@ def delete_product_set(
) -> None:
r"""Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -1860,6 +1861,7 @@ def delete_reference_image(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,7 @@ def delete_product_set(
Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -666,6 +667,7 @@ def delete_reference_image(
r"""Return a callable for the delete reference image method over gRPC.
Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ def delete_product_set(
Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -679,6 +680,7 @@ def delete_reference_image(
r"""Return a callable for the delete reference image method over gRPC.
Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@


from google.cloud.vision_v1.types import product_search_service
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import (
ProductSearchTransport,
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1/types/image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -1259,13 +1259,15 @@ class AnnotateFileRequest(proto.Message):
Pages starts from 1, we assume the first page of
the file is page 1. At most 5 pages are
supported per request. Pages can be negative.
Page 1 means the first page.
Page 2 means the second page.
Page -1 means the last page.
Page -2 means the second to the last page.
If the file is GIF instead of PDF or TIFF, page
refers to GIF frames.
If this field is empty, by default the service
performs image annotation for the first 5 pages
of the file.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/vision_v1/types/product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class ProductSearchParams(proto.Message):
expressions, where each expression within an OR
must have the same key. An '=' should be used to
connect the key and value.
For example, "(color = red OR color = blue) AND
brand = Google" is acceptable, but "(color = red
OR brand = Google)" is not acceptable. "color:
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1/types/product_search_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ class ProductSet(proto.Message):
Output only. If there was an error with
indexing the product set, the field is
populated.
This field is ignored when creating a
ProductSet.
"""
Expand Down Expand Up @@ -230,6 +231,7 @@ class ReferenceImage(proto.Message):
field is empty, the system will try to detect
regions of interest. At most 10 bounding
polygons will be used.
The provided shape is converted into a
non-rotated rectangle. Once converted, the small
edge of the rectangle must be greater than or
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@


from google.cloud.vision_v1p3beta1.types import product_search_service
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import (
ProductSearchTransport,
Expand Down
1 change: 1 addition & 0 deletions google/cloud/vision_v1p3beta1/types/product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class ProductSearchParams(proto.Message):
expressions, where each expression within an OR
must have the same key. An '=' should be used to
connect the key and value.
For example, "(color = red OR color = blue) AND
brand = Google" is acceptable, but "(color = red
OR brand = Google)" is not acceptable. "color:
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1p3beta1/types/product_search_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ class ProductSet(proto.Message):
Output only. If there was an error with
indexing the product set, the field is
populated.
This field is ignored when creating a
ProductSet.
"""
Expand Down Expand Up @@ -222,6 +223,7 @@ class ReferenceImage(proto.Message):
field is empty, the system will try to detect
regions of interest. At most 10 bounding
polygons will be used.
The provided shape is converted into a
non-rotated rectangle. Once converted, the small
edge of the rectangle must be greater than or
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,7 @@ async def batch_annotate_files(
r"""Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,7 @@ def batch_annotate_files(
r"""Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@ def batch_annotate_files(
Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ def batch_annotate_files(
Service that performs image detection and annotation
for a batch of files. Now only "application/pdf",
"image/tiff" and "image/gif" are supported.
This service will extract at most 5 (customers can
specify which 5 in AnnotateFileRequest.pages) frames
(gif) or pages (pdf or tiff) from each file provided and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -788,6 +788,7 @@ async def delete_product_set(
) -> None:
r"""Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -1688,6 +1689,7 @@ async def delete_reference_image(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,7 @@ def delete_product_set(
) -> None:
r"""Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -1862,6 +1863,7 @@ def delete_reference_image(
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ def delete_product_set(
Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -668,6 +669,7 @@ def delete_reference_image(
r"""Return a callable for the delete reference image method over gRPC.
Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ def delete_product_set(
Permanently deletes a ProductSet. Products and
ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud
Storage.
Expand Down Expand Up @@ -681,6 +682,7 @@ def delete_reference_image(
r"""Return a callable for the delete reference image method over gRPC.
Permanently deletes a reference image.
The image metadata will be deleted right away, but
search queries against ProductSets containing the image
may still work until all related caches are refreshed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@


from google.cloud.vision_v1p4beta1.types import product_search_service
from google.longrunning import operations_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
from google.longrunning import operations_pb2 # type: ignore

from .base import (
ProductSearchTransport,
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1p4beta1/types/image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -1256,13 +1256,15 @@ class AnnotateFileRequest(proto.Message):
Pages starts from 1, we assume the first page of
the file is page 1. At most 5 pages are
supported per request. Pages can be negative.
Page 1 means the first page.
Page 2 means the second page.
Page -1 means the last page.
Page -2 means the second to the last page.
If the file is GIF instead of PDF or TIFF, page
refers to GIF frames.
If this field is empty, by default the service
performs image annotation for the first 5 pages
of the file.
Expand Down
1 change: 1 addition & 0 deletions google/cloud/vision_v1p4beta1/types/product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class ProductSearchParams(proto.Message):
expressions, where each expression within an OR
must have the same key. An '=' should be used to
connect the key and value.
For example, "(color = red OR color = blue) AND
brand = Google" is acceptable, but "(color = red
OR brand = Google)" is not acceptable. "color:
Expand Down
2 changes: 2 additions & 0 deletions google/cloud/vision_v1p4beta1/types/product_search_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ class ProductSet(proto.Message):
Output only. If there was an error with
indexing the product set, the field is
populated.
This field is ignored when creating a
ProductSet.
"""
Expand Down Expand Up @@ -230,6 +231,7 @@ class ReferenceImage(proto.Message):
field is empty, the system will try to detect
regions of interest. At most 10 bounding
polygons will be used.
The provided shape is converted into a
non-rotated rectangle. Once converted, the small
edge of the rectangle must be greater than or
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1/test_image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.vision_v1.types import geometry
from google.cloud.vision_v1.types import image_annotator
from google.cloud.vision_v1.types import product_search
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.type import latlng_pb2 # type: ignore
import google.auth
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1/test_product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.vision_v1.services.product_search import transports
from google.cloud.vision_v1.types import geometry
from google.cloud.vision_v1.types import product_search_service
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import any_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1p2beta1/test_image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
from google.cloud.vision_v1p2beta1.services.image_annotator import ImageAnnotatorClient
from google.cloud.vision_v1p2beta1.services.image_annotator import transports
from google.cloud.vision_v1p2beta1.types import image_annotator
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.type import latlng_pb2 # type: ignore
import google.auth
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1p3beta1/test_image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
from google.cloud.vision_v1p3beta1.types import geometry
from google.cloud.vision_v1p3beta1.types import image_annotator
from google.cloud.vision_v1p3beta1.types import product_search
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.type import latlng_pb2 # type: ignore
import google.auth
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1p3beta1/test_product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
from google.cloud.vision_v1p3beta1.services.product_search import transports
from google.cloud.vision_v1p3beta1.types import geometry
from google.cloud.vision_v1p3beta1.types import product_search_service
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import any_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1p4beta1/test_image_annotator.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
from google.cloud.vision_v1p4beta1.types import geometry
from google.cloud.vision_v1p4beta1.types import image_annotator
from google.cloud.vision_v1p4beta1.types import product_search
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.type import latlng_pb2 # type: ignore
import google.auth
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/gapic/vision_v1p4beta1/test_product_search.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
from google.cloud.vision_v1p4beta1.services.product_search import transports
from google.cloud.vision_v1p4beta1.types import geometry
from google.cloud.vision_v1p4beta1.types import product_search_service
from google.longrunning import operations_pb2
from google.longrunning import operations_pb2 # type: ignore
from google.oauth2 import service_account
from google.protobuf import any_pb2 # type: ignore
from google.protobuf import empty_pb2 # type: ignore
Expand Down

0 comments on commit 747296f

Please sign in to comment.