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

Commit

Permalink
docs: add generated snippets (#122)
Browse files Browse the repository at this point in the history 
* chore: use gapic-generator-python 0.63.2
docs: add generated snippets

PiperOrigin-RevId: 427792504

Source-Link: googleapis/googleapis@55b9e1e

Source-Link: googleapis/googleapis-gen@bf4e86b
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYmY0ZTg2Yjc1M2Y0MmNiMGVkYjFmZDUxZmJlODQwZDdkYTBhMWNkZSJ9

* 🦉 Updates from OwlBot

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 Feb 11, 2022
1 parent 175da64 commit eebbeb6
Show file tree
Hide file tree
Showing 39 changed files with 3,422 additions and 0 deletions.
130 changes: 130 additions & 0 deletions google/cloud/recommendationengine_v1beta1/services/catalog_service/async_client.py
View file
Expand Up @@ -223,6 +223,31 @@ async def create_catalog_item(
) -> catalog.CatalogItem:
r"""Creates a catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_create_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
catalog_item = recommendationengine_v1beta1.CatalogItem()
catalog_item.id = "id_value"
catalog_item.category_hierarchies.categories = ['categories_value_1', 'categories_value_2']
catalog_item.title = "title_value"
request = recommendationengine_v1beta1.CreateCatalogItemRequest(
parent="parent_value",
catalog_item=catalog_item,
)
# Make the request
response = client.create_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.CreateCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -311,6 +336,25 @@ async def get_catalog_item(
) -> catalog.CatalogItem:
r"""Gets a specific catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_get_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.GetCatalogItemRequest(
name="name_value",
)
# Make the request
response = client.get_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.GetCatalogItemRequest, dict]):
The request object. Request message for GetCatalogItem
Expand Down Expand Up @@ -393,6 +437,26 @@ async def list_catalog_items(
) -> pagers.ListCatalogItemsAsyncPager:
r"""Gets a list of catalog items.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_list_catalog_items():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.ListCatalogItemsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalog_items(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest, dict]):
The request object. Request message for ListCatalogItems
Expand Down Expand Up @@ -495,6 +559,32 @@ async def update_catalog_item(
r"""Updates a catalog item. Partial updating is
supported. Non-existing items will be created.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_update_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
catalog_item = recommendationengine_v1beta1.CatalogItem()
catalog_item.id = "id_value"
catalog_item.category_hierarchies.categories = ['categories_value_1', 'categories_value_2']
catalog_item.title = "title_value"
request = recommendationengine_v1beta1.UpdateCatalogItemRequest(
name="name_value",
catalog_item=catalog_item,
)
# Make the request
response = client.update_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -595,6 +685,22 @@ async def delete_catalog_item(
) -> None:
r"""Deletes a catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_delete_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.DeleteCatalogItemRequest(
name="name_value",
)
# Make the request
client.delete_catalog_item(request=request)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.DeleteCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -678,6 +784,30 @@ async def import_catalog_items(
it is possible for a subset of the items to be
successfully updated.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_import_catalog_items():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.ImportCatalogItemsRequest(
parent="parent_value",
)
# Make the request
operation = client.import_catalog_items(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest, dict]):
The request object. Request message for Import methods.
Expand Down
136 changes: 136 additions & 0 deletions google/cloud/recommendationengine_v1beta1/services/catalog_service/client.py
View file
Expand Up @@ -419,6 +419,32 @@ def create_catalog_item(
) -> catalog.CatalogItem:
r"""Creates a catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_create_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
catalog_item = recommendationengine_v1beta1.CatalogItem()
catalog_item.id = "id_value"
catalog_item.category_hierarchies.categories = ['categories_value_1', 'categories_value_2']
catalog_item.title = "title_value"
request = recommendationengine_v1beta1.CreateCatalogItemRequest(
parent="parent_value",
catalog_item=catalog_item,
)
# Make the request
response = client.create_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.CreateCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -497,6 +523,26 @@ def get_catalog_item(
) -> catalog.CatalogItem:
r"""Gets a specific catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_get_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.GetCatalogItemRequest(
name="name_value",
)
# Make the request
response = client.get_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.GetCatalogItemRequest, dict]):
The request object. Request message for GetCatalogItem
Expand Down Expand Up @@ -569,6 +615,27 @@ def list_catalog_items(
) -> pagers.ListCatalogItemsPager:
r"""Gets a list of catalog items.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_list_catalog_items():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.ListCatalogItemsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalog_items(request=request)
# Handle the response
for response in page_result:
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.ListCatalogItemsRequest, dict]):
The request object. Request message for ListCatalogItems
Expand Down Expand Up @@ -661,6 +728,33 @@ def update_catalog_item(
r"""Updates a catalog item. Partial updating is
supported. Non-existing items will be created.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_update_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
catalog_item = recommendationengine_v1beta1.CatalogItem()
catalog_item.id = "id_value"
catalog_item.category_hierarchies.categories = ['categories_value_1', 'categories_value_2']
catalog_item.title = "title_value"
request = recommendationengine_v1beta1.UpdateCatalogItemRequest(
name="name_value",
catalog_item=catalog_item,
)
# Make the request
response = client.update_catalog_item(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.UpdateCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -751,6 +845,23 @@ def delete_catalog_item(
) -> None:
r"""Deletes a catalog item.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_delete_catalog_item():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.DeleteCatalogItemRequest(
name="name_value",
)
# Make the request
client.delete_catalog_item(request=request)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.DeleteCatalogItemRequest, dict]):
The request object. Request message for
Expand Down Expand Up @@ -824,6 +935,31 @@ def import_catalog_items(
it is possible for a subset of the items to be
successfully updated.
.. code-block::
from google.cloud import recommendationengine_v1beta1
def sample_import_catalog_items():
# Create a client
client = recommendationengine_v1beta1.CatalogServiceClient()
# Initialize request argument(s)
request = recommendationengine_v1beta1.ImportCatalogItemsRequest(
parent="parent_value",
)
# Make the request
operation = client.import_catalog_items(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.recommendationengine_v1beta1.types.ImportCatalogItemsRequest, dict]):
The request object. Request message for Import methods.
Expand Down

0 comments on commit eebbeb6

Please sign in to comment.