Skip to content

Commit

Permalink
Add RPC annotations, update docstrings (via synth). (#9230)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoshi-automation @tseaver
yoshi-automation authored and tseaver committed Sep 16, 2019
1 parent 71eb814 commit 94178dd
Show file tree
Hide file tree
Showing 12 changed files with 973 additions and 614 deletions.
8 changes: 4 additions & 4 deletions packages/google-cloud-vision/google/cloud/vision_v1/gapic/image_annotator_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ def batch_annotate_images(
>>> response = client.batch_annotate_images(requests)
Args:
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateImageRequest]]): Individual image annotation requests for this batch.
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateImageRequest]]): Required. Individual image annotation requests for this batch.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.AnnotateImageRequest`
Expand Down Expand Up @@ -302,7 +302,7 @@ def batch_annotate_files(
>>> response = client.batch_annotate_files(requests)
Args:
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateFileRequest]]): The list of file annotation requests. Right now we support only one
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateFileRequest]]): Required. The list of file annotation requests. Right now we support only one
AnnotateFileRequest in BatchAnnotateFilesRequest.
If a dict is provided, it must be of the same form as the protobuf
Expand Down Expand Up @@ -411,7 +411,7 @@ def async_batch_annotate_images(
>>> metadata = response.metadata()
Args:
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateImageRequest]]): Individual image annotation requests for this batch.
requests (list[Union[dict, ~google.cloud.vision_v1.types.AnnotateImageRequest]]): Required. Individual image annotation requests for this batch.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.AnnotateImageRequest`
Expand Down Expand Up @@ -523,7 +523,7 @@ def async_batch_annotate_files(
>>> metadata = response.metadata()
Args:
requests (list[Union[dict, ~google.cloud.vision_v1.types.AsyncAnnotateFileRequest]]): Individual async file annotation requests for this batch.
requests (list[Union[dict, ~google.cloud.vision_v1.types.AsyncAnnotateFileRequest]]): Required. Individual async file annotation requests for this batch.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.AsyncAnnotateFileRequest`
Expand Down
55 changes: 30 additions & 25 deletions packages/google-cloud-vision/google/cloud/vision_v1/gapic/product_search_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,10 +277,10 @@ def create_product_set(
>>> response = client.create_product_set(parent, product_set)
Args:
parent (str): The project in which the ProductSet should be created.
parent (str): Required. The project in which the ProductSet should be created.
Format is ``projects/PROJECT_ID/locations/LOC_ID``.
product_set (Union[dict, ~google.cloud.vision_v1.types.ProductSet]): The ProductSet to create.
product_set (Union[dict, ~google.cloud.vision_v1.types.ProductSet]): Required. The ProductSet to create.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.ProductSet`
Expand Down Expand Up @@ -376,7 +376,7 @@ def list_product_sets(
... pass
Args:
parent (str): The project from which ProductSets should be listed.
parent (str): Required. The project from which ProductSets should be listed.
Format is ``projects/PROJECT_ID/locations/LOC_ID``.
page_size (int): The maximum number of resources contained in the
Expand Down Expand Up @@ -472,7 +472,7 @@ def get_product_set(
>>> response = client.get_product_set(name)
Args:
name (str): Resource name of the ProductSet to get.
name (str): Required. Resource name of the ProductSet to get.
Format is:
``projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID``
Expand Down Expand Up @@ -553,7 +553,7 @@ def update_product_set(
>>> response = client.update_product_set(product_set)
Args:
product_set (Union[dict, ~google.cloud.vision_v1.types.ProductSet]): The ProductSet resource which replaces the one on the server.
product_set (Union[dict, ~google.cloud.vision_v1.types.ProductSet]): Required. The ProductSet resource which replaces the one on the server.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.ProductSet`
Expand Down Expand Up @@ -636,7 +636,7 @@ def delete_product_set(
>>> client.delete_product_set(name)
Args:
name (str): Resource name of the ProductSet to delete.
name (str): Required. Resource name of the ProductSet to delete.
Format is:
``projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID``
Expand Down Expand Up @@ -718,10 +718,10 @@ def create_product(
>>> response = client.create_product(parent, product)
Args:
parent (str): The project in which the Product should be created.
parent (str): Required. The project in which the Product should be created.
Format is ``projects/PROJECT_ID/locations/LOC_ID``.
product (Union[dict, ~google.cloud.vision_v1.types.Product]): The product to create.
product (Union[dict, ~google.cloud.vision_v1.types.Product]): Required. The product to create.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.Product`
Expand Down Expand Up @@ -817,7 +817,8 @@ def list_products(
... pass
Args:
parent (str): The project OR ProductSet from which Products should be listed.
parent (str): Required. The project OR ProductSet from which Products should be
listed.
Format: ``projects/PROJECT_ID/locations/LOC_ID``
page_size (int): The maximum number of resources contained in the
Expand Down Expand Up @@ -913,7 +914,7 @@ def get_product(
>>> response = client.get_product(name)
Args:
name (str): Resource name of the Product to get.
name (str): Required. Resource name of the Product to get.
Format is: ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -1000,7 +1001,7 @@ def update_product(
>>> response = client.update_product(product)
Args:
product (Union[dict, ~google.cloud.vision_v1.types.Product]): The Product resource which replaces the one on the server.
product (Union[dict, ~google.cloud.vision_v1.types.Product]): Required. The Product resource which replaces the one on the server.
product.name is immutable.
If a dict is provided, it must be of the same form as the protobuf
Expand Down Expand Up @@ -1085,7 +1086,7 @@ def delete_product(
>>> client.delete_product(name)
Args:
name (str): Resource name of product to delete.
name (str): Required. Resource name of product to delete.
Format is: ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -1178,10 +1179,11 @@ def create_reference_image(
>>> response = client.create_reference_image(parent, reference_image)
Args:
parent (str): Resource name of the product in which to create the reference image.
parent (str): Required. Resource name of the product in which to create the reference
image.
Format is ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``.
reference_image (Union[dict, ~google.cloud.vision_v1.types.ReferenceImage]): The reference image to create.
reference_image (Union[dict, ~google.cloud.vision_v1.types.ReferenceImage]): Required. The reference image to create.
If an image ID is specified, it is ignored.
If a dict is provided, it must be of the same form as the protobuf
Expand Down Expand Up @@ -1268,7 +1270,7 @@ def delete_reference_image(
>>> client.delete_reference_image(name)
Args:
name (str): The resource name of the reference image to delete.
name (str): Required. The resource name of the reference image to delete.
Format is:
Expand Down Expand Up @@ -1357,7 +1359,7 @@ def list_reference_images(
... pass
Args:
parent (str): Resource name of the product containing the reference images.
parent (str): Required. Resource name of the product containing the reference images.
Format is ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``.
page_size (int): The maximum number of resources contained in the
Expand Down Expand Up @@ -1453,7 +1455,7 @@ def get_reference_image(
>>> response = client.get_reference_image(name)
Args:
name (str): The resource name of the ReferenceImage to get.
name (str): Required. The resource name of the ReferenceImage to get.
Format is:
Expand Down Expand Up @@ -1535,11 +1537,12 @@ def add_product_to_product_set(
>>> client.add_product_to_product_set(name, product)
Args:
name (str): The resource name for the ProductSet to modify.
name (str): Required. The resource name for the ProductSet to modify.
Format is:
``projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID``
product (str): The resource name for the Product to be added to this ProductSet.
product (str): Required. The resource name for the Product to be added to this
ProductSet.
Format is: ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -1611,11 +1614,12 @@ def remove_product_from_product_set(
>>> client.remove_product_from_product_set(name, product)
Args:
name (str): The resource name for the ProductSet to modify.
name (str): Required. The resource name for the ProductSet to modify.
Format is:
``projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID``
product (str): The resource name for the Product to be removed from this ProductSet.
product (str): Required. The resource name for the Product to be removed from this
ProductSet.
Format is: ``projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID``
retry (Optional[google.api_core.retry.Retry]): A retry object used
Expand Down Expand Up @@ -1707,7 +1711,7 @@ def list_products_in_product_set(
... pass
Args:
name (str): The ProductSet resource for which to retrieve Products.
name (str): Required. The ProductSet resource for which to retrieve Products.
Format is:
``projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID``
Expand Down Expand Up @@ -1825,10 +1829,10 @@ def import_product_sets(
>>> metadata = response.metadata()
Args:
parent (str): The project in which the ProductSets should be imported.
parent (str): Required. The project in which the ProductSets should be imported.
Format is ``projects/PROJECT_ID/locations/LOC_ID``.
input_config (Union[dict, ~google.cloud.vision_v1.types.ImportProductSetsInputConfig]): The input content for the list of requests.
input_config (Union[dict, ~google.cloud.vision_v1.types.ImportProductSetsInputConfig]): Required. The input content for the list of requests.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.vision_v1.types.ImportProductSetsInputConfig`
Expand Down Expand Up @@ -1943,7 +1947,8 @@ def purge_products(
>>> metadata = response.metadata()
Args:
parent (str): The project and location in which the Products should be deleted.
parent (str): Required. The project and location in which the Products should be
deleted.
Format is ``projects/PROJECT_ID/locations/LOC_ID``.
product_set_purge_config (Union[dict, ~google.cloud.vision_v1.types.ProductSetPurgeConfig]): Specify which ProductSet contains the Products to be deleted.
Expand Down
Loading

0 comments on commit 94178dd

Please sign in to comment.