docs: Add documentation for enums (#385)

* docs: Add documentation for enums fix: Add context manager return types chore: Update gapic-generator-python to v1.8.1 PiperOrigin-RevId: 503210727 Source-Link: googleapis/googleapis@a391fd1 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0080f830dec37c3384157082bce279e37079ea58 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 * 🦉 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>

Author: gcf-owl-bot[bot]

google/cloud/retail_v2/services/catalog_service/client.py

@@ -1758,7 +1758,7 @@ def sample_replace_catalog_attribute():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "CatalogServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/completion_service/client.py

@@ -644,7 +644,7 @@ def sample_import_completion_data():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "CompletionServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/control_service/client.py

@@ -1042,7 +1042,7 @@ def sample_list_controls():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "ControlServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/prediction_service/client.py

@@ -529,7 +529,7 @@ def sample_predict():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "PredictionServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/product_service/client.py

@@ -2124,7 +2124,7 @@ def sample_remove_local_inventories():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "ProductServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/search_service/client.py

@@ -573,7 +573,7 @@ def sample_search():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "SearchServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/serving_config_service/client.py

@@ -1282,7 +1282,7 @@ def sample_remove_control():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "ServingConfigServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/services/user_event_service/client.py

@@ -1020,7 +1020,7 @@ def sample_rejoin_user_events():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "UserEventServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/retail_v2/types/catalog.py

@@ -190,41 +190,102 @@ class CatalogAttribute(proto.Message):
  """
 
  class AttributeType(proto.Enum):
- r"""The type of an attribute."""
+ r"""The type of an attribute.
+
+ Values:
+ UNKNOWN (0):
+ The type of the attribute is unknown.
+
+ Used when type cannot be derived from attribute that is not
+ [in_use][google.cloud.retail.v2.CatalogAttribute.in_use].
+ TEXTUAL (1):
+ Textual attribute.
+ NUMERICAL (2):
+ Numerical attribute.
+ """
  UNKNOWN = 0
  TEXTUAL = 1
  NUMERICAL = 2
 
  class IndexableOption(proto.Enum):
- r"""The status of the indexable option of a catalog attribute."""
+ r"""The status of the indexable option of a catalog attribute.
+
+ Values:
+ INDEXABLE_OPTION_UNSPECIFIED (0):
+ Value used when unset.
+ INDEXABLE_ENABLED (1):
+ Indexable option enabled for an attribute.
+ INDEXABLE_DISABLED (2):
+ Indexable option disabled for an attribute.
+ """
  INDEXABLE_OPTION_UNSPECIFIED = 0
  INDEXABLE_ENABLED = 1
  INDEXABLE_DISABLED = 2
 
  class DynamicFacetableOption(proto.Enum):
  r"""The status of the dynamic facetable option of a catalog
  attribute.
+
+ Values:
+ DYNAMIC_FACETABLE_OPTION_UNSPECIFIED (0):
+ Value used when unset.
+ DYNAMIC_FACETABLE_ENABLED (1):
+ Dynamic facetable option enabled for an
+ attribute.
+ DYNAMIC_FACETABLE_DISABLED (2):
+ Dynamic facetable option disabled for an
+ attribute.
  """
  DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0
  DYNAMIC_FACETABLE_ENABLED = 1
  DYNAMIC_FACETABLE_DISABLED = 2
 
  class SearchableOption(proto.Enum):
- r"""The status of the searchable option of a catalog attribute."""
+ r"""The status of the searchable option of a catalog attribute.
+
+ Values:
+ SEARCHABLE_OPTION_UNSPECIFIED (0):
+ Value used when unset.
+ SEARCHABLE_ENABLED (1):
+ Searchable option enabled for an attribute.
+ SEARCHABLE_DISABLED (2):
+ Searchable option disabled for an attribute.
+ """
  SEARCHABLE_OPTION_UNSPECIFIED = 0
  SEARCHABLE_ENABLED = 1
  SEARCHABLE_DISABLED = 2
 
  class ExactSearchableOption(proto.Enum):
  r"""The status of the exact-searchable option of a catalog
  attribute.
+
+ Values:
+ EXACT_SEARCHABLE_OPTION_UNSPECIFIED (0):
+ Value used when unset. Defaults to
+ [EXACT_SEARCHABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption.EXACT_SEARCHABLE_DISABLED].
+ EXACT_SEARCHABLE_ENABLED (1):
+ Exact searchable option enabled for an
+ attribute.
+ EXACT_SEARCHABLE_DISABLED (2):
+ Exact searchable option disabled for an
+ attribute.
  """
  EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0
  EXACT_SEARCHABLE_ENABLED = 1
  EXACT_SEARCHABLE_DISABLED = 2
 
  class RetrievableOption(proto.Enum):
- r"""The status of the retrievable option of a catalog attribute."""
+ r"""The status of the retrievable option of a catalog attribute.
+
+ Values:
+ RETRIEVABLE_OPTION_UNSPECIFIED (0):
+ Value used when unset. Defaults to
+ [RETRIEVABLE_DISABLED][google.cloud.retail.v2.CatalogAttribute.RetrievableOption.RETRIEVABLE_DISABLED].
+ RETRIEVABLE_ENABLED (1):
+ Retrievable option enabled for an attribute.
+ RETRIEVABLE_DISABLED (2):
+ Retrievable option disabled for an attribute.
+ """
  RETRIEVABLE_OPTION_UNSPECIFIED = 0
  RETRIEVABLE_ENABLED = 1
  RETRIEVABLE_DISABLED = 2

google/cloud/retail_v2/types/common.py

@@ -41,21 +41,56 @@
 
 
 class AttributeConfigLevel(proto.Enum):
- r"""At which level we offer configuration for attributes."""
+ r"""At which level we offer configuration for attributes.
+
+ Values:
+ ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED (0):
+ Value used when unset. In this case, server behavior
+ defaults to
+ [CATALOG_LEVEL_ATTRIBUTE_CONFIG][google.cloud.retail.v2.AttributeConfigLevel.CATALOG_LEVEL_ATTRIBUTE_CONFIG].
+ PRODUCT_LEVEL_ATTRIBUTE_CONFIG (1):
+ At this level, we honor the attribute configurations set in
+ [Product.attributes][google.cloud.retail.v2.Product.attributes].
+ CATALOG_LEVEL_ATTRIBUTE_CONFIG (2):
+ At this level, we honor the attribute configurations set in
+ [CatalogConfig.attribute_configs][].
+ """
  ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED = 0
  PRODUCT_LEVEL_ATTRIBUTE_CONFIG = 1
  CATALOG_LEVEL_ATTRIBUTE_CONFIG = 2
 
 
 class SolutionType(proto.Enum):
- r"""The type of solution."""
+ r"""The type of solution.
+
+ Values:
+ SOLUTION_TYPE_UNSPECIFIED (0):
+ Default value.
+ SOLUTION_TYPE_RECOMMENDATION (1):
+ Used for Recommendations AI.
+ SOLUTION_TYPE_SEARCH (2):
+ Used for Retail Search.
+ """
  SOLUTION_TYPE_UNSPECIFIED = 0
  SOLUTION_TYPE_RECOMMENDATION = 1
  SOLUTION_TYPE_SEARCH = 2
 
 
 class SearchSolutionUseCase(proto.Enum):
- r"""The use case of Cloud Retail Search."""
+ r"""The use case of Cloud Retail Search.
+
+ Values:
+ SEARCH_SOLUTION_USE_CASE_UNSPECIFIED (0):
+ The value when it's unspecified. In this case, server
+ behavior defaults to
+ [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH].
+ SEARCH_SOLUTION_USE_CASE_SEARCH (1):
+ Search use case. Expects the traffic has a non-empty
+ [query][google.cloud.retail.v2.SearchRequest.query].
+ SEARCH_SOLUTION_USE_CASE_BROWSE (2):
+ Browse use case. Expects the traffic has an empty
+ [query][google.cloud.retail.v2.SearchRequest.query].
+ """
  SEARCH_SOLUTION_USE_CASE_UNSPECIFIED = 0
  SEARCH_SOLUTION_USE_CASE_SEARCH = 1
  SEARCH_SOLUTION_USE_CASE_BROWSE = 2