docs: Keep the API doc up-to-date

feat: update grpc service config settings to reflect correct API deadlines PiperOrigin-RevId: 411660243
googleapis · Nov 22, 2021 · 72adf13 · 72adf13
1 parent eddd3d8
commit 72adf13
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 27 deletions.
diff --git a/google/cloud/retail/v2/catalog.proto b/google/cloud/retail/v2/catalog.proto
@@ -37,12 +37,12 @@ message ProductLevelConfig {
   // The type of [Product][google.cloud.retail.v2.Product]s allowed to be
   // ingested into the catalog. Acceptable values are:
   //
-  // * `primary` (default): You can only ingest
-  // [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY]
-  //   [Product][google.cloud.retail.v2.Product]s. This means
-  //   [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id]
-  //   can only be empty or set to the same value as
-  //   [Product.id][google.cloud.retail.v2.Product.id].
+  // * `primary` (default): You can ingest
+  // [Product][google.cloud.retail.v2.Product]s of all types. When
+  //   ingesting a [Product][google.cloud.retail.v2.Product], its type will
+  //   default to
+  //   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] if
+  //   unset.
   // * `variant`: You can only ingest
   // [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   // [Product][google.cloud.retail.v2.Product]s.

diff --git a/google/cloud/retail/v2/retail_grpc_service_config.json b/google/cloud/retail/v2/retail_grpc_service_config.json
@@ -44,13 +44,26 @@
       {
         "service": "google.cloud.retail.v2.ProductService",
         "method": "ImportProducts"
-      },
+      }
+    ],
+    "timeout": "300s",
+    "retryPolicy": {
+      "initialBackoff": "0.100s",
+      "maxBackoff": "300s",
+      "backoffMultiplier": 1.3,
+      "retryableStatusCodes": [
+        "UNAVAILABLE",
+        "DEADLINE_EXCEEDED"
+      ]
+    }
+  }, {
+    "name": [
       {
         "service": "google.cloud.retail.v2.UserEventService",
         "method": "ImportUserEvents"
       }
     ],
-    "timeout": "300s",
+    "timeout": "600s",
     "retryPolicy": {
       "initialBackoff": "0.100s",
       "maxBackoff": "300s",

diff --git a/google/cloud/retail/v2/search_service.proto b/google/cloud/retail/v2/search_service.proto
@@ -96,6 +96,7 @@ message SearchRequest {
       //     * "customFulfillment3"
       //     * "customFulfillment4"
       //     * "customFulfillment5"
+      //     * "inventory(place_id,attributes.key)"
       //
       // * numerical_field =
       //     * "price"
@@ -104,6 +105,7 @@ message SearchRequest {
       //     * "ratingCount"
       //     * "attributes.key"
       //     * "inventory(place_id,price)"
+      //     * "inventory(place_id,attributes.key)"
       string key = 1 [(google.api.field_behavior) = REQUIRED];
 
       // Set only if values should be bucketized into intervals. Must be set
@@ -513,7 +515,10 @@ message SearchRequest {
   // * price
   // * originalPrice
   // * discount
+  // * variantId
   // * inventory(place_id,price)
+  // * inventory(place_id,attributes.key), where key is any key in the
+  //   [Product.inventories.attributes][] map.
   // * attributes.key, where key is any key in the
   //   [Product.attributes][google.cloud.retail.v2.Product.attributes] map.
   // * pickupInStore.id, where id is any

diff --git a/google/cloud/retail/v2alpha/catalog.proto b/google/cloud/retail/v2alpha/catalog.proto
@@ -37,12 +37,12 @@ message ProductLevelConfig {
   // The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
   // ingested into the catalog. Acceptable values are:
   //
-  // * `primary` (default): You can only ingest
-  // [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
-  //   [Product][google.cloud.retail.v2alpha.Product]s. This means
-  //   [Product.primary_product_id][google.cloud.retail.v2alpha.Product.primary_product_id]
-  //   can only be empty or set to the same value as
-  //   [Product.id][google.cloud.retail.v2alpha.Product.id].
+  // * `primary` (default): You can ingest
+  // [Product][google.cloud.retail.v2alpha.Product]s of all types. When
+  //   ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
+  //   default to
+  //   [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
+  //   if unset.
   // * `variant`: You can only ingest
   // [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
   // [Product][google.cloud.retail.v2alpha.Product]s.
@@ -106,8 +106,8 @@ message MerchantCenterLink {
   // List of possible values can be found here.
   // [https://support.google.com/merchants/answer/7501026]
   // List of allowed string values:
-  // "shopping-ads", "buy-on-google-listings", "display-ads", "local-inventory
-  // -ads", "free-listings", "free-local-listings"
+  // "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory
+  // _ads", "Free_listings", "Free_local_listings"
   // NOTE: The string values are case sensitive.
   repeated string destinations = 3;
 }

diff --git a/google/cloud/retail/v2alpha/common.proto b/google/cloud/retail/v2alpha/common.proto
@@ -456,5 +456,7 @@ message LocalInventory {
   // * The attribute values must be of the same type (text or number).
   // * The max number of values per attribute is 10.
   // * For text values, the length limit is 10 UTF-8 characters.
+  // * The attribute does not support search. The `searchable` field should be
+  //   unset or set to false.
   map<string, CustomAttribute> attributes = 3;
 }
diff --git a/google/cloud/retail/v2alpha/product_service.proto b/google/cloud/retail/v2alpha/product_service.proto
@@ -711,7 +711,7 @@ message AddLocalInventoriesRequest {
   // not found, the local inventory will still be processed and retained for at
   // most 1 day and processed once the
   // [Product][google.cloud.retail.v2alpha.Product] is created. If set to false,
-  // an INVALID_ARGUMENT error is returned if the
+  // a NOT_FOUND error is returned if the
   // [Product][google.cloud.retail.v2alpha.Product] is not found.
   bool allow_missing = 6;
 }

diff --git a/google/cloud/retail/v2alpha/retail_grpc_service_config.json b/google/cloud/retail/v2alpha/retail_grpc_service_config.json
@@ -44,13 +44,26 @@
       {
         "service": "google.cloud.retail.v2alpha.ProductService",
         "method": "ImportProducts"
-      },
+      }
+    ],
+    "timeout": "300s",
+    "retryPolicy": {
+      "initialBackoff": "0.100s",
+      "maxBackoff": "300s",
+      "backoffMultiplier": 1.3,
+      "retryableStatusCodes": [
+        "UNAVAILABLE",
+        "DEADLINE_EXCEEDED"
+      ]
+    }
+  }, {
+    "name": [
       {
         "service": "google.cloud.retail.v2alpha.UserEventService",
         "method": "ImportUserEvents"
       }
     ],
-    "timeout": "300s",
+    "timeout": "600s",
     "retryPolicy": {
       "initialBackoff": "0.100s",
       "maxBackoff": "300s",

diff --git a/google/cloud/retail/v2alpha/search_service.proto b/google/cloud/retail/v2alpha/search_service.proto
@@ -97,6 +97,7 @@ message SearchRequest {
       //     * "customFulfillment3"
       //     * "customFulfillment4"
       //     * "customFulfillment5"
+      //     * "inventory(place_id,attributes.key)"
       //
       // * numerical_field =
       //     * "price"
@@ -105,6 +106,7 @@ message SearchRequest {
       //     * "ratingCount"
       //     * "attributes.key"
       //     * "inventory(place_id,price)"
+      //     * "inventory(place_id,attributes.key)"
       string key = 1 [(google.api.field_behavior) = REQUIRED];
 
       // Set only if values should be bucketized into intervals. Must be set
@@ -550,7 +552,10 @@ message SearchRequest {
   // * price
   // * originalPrice
   // * discount
+  // * variantId
   // * inventory(place_id,price)
+  // * inventory(place_id,attributes.key), where key is any key in the
+  //   [Product.inventories.attributes][] map.
   // * attributes.key, where key is any key in the
   //   [Product.attributes][google.cloud.retail.v2alpha.Product.attributes] map.
   // * pickupInStore.id, where id is any

diff --git a/google/cloud/retail/v2beta/catalog.proto b/google/cloud/retail/v2beta/catalog.proto
@@ -37,12 +37,12 @@ message ProductLevelConfig {
   // The type of [Product][google.cloud.retail.v2beta.Product]s allowed to be
   // ingested into the catalog. Acceptable values are:
   //
-  // * `primary` (default): You can only ingest
-  // [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
-  //   [Product][google.cloud.retail.v2beta.Product]s. This means
-  //   [Product.primary_product_id][google.cloud.retail.v2beta.Product.primary_product_id]
-  //   can only be empty or set to the same value as
-  //   [Product.id][google.cloud.retail.v2beta.Product.id].
+  // * `primary` (default): You can ingest
+  // [Product][google.cloud.retail.v2beta.Product]s of all types. When
+  //   ingesting a [Product][google.cloud.retail.v2beta.Product], its type will
+  //   default to
+  //   [Product.Type.PRIMARY][google.cloud.retail.v2beta.Product.Type.PRIMARY]
+  //   if unset.
   // * `variant`: You can only ingest
   // [Product.Type.VARIANT][google.cloud.retail.v2beta.Product.Type.VARIANT]
   // [Product][google.cloud.retail.v2beta.Product]s.

diff --git a/google/cloud/retail/v2beta/retail_grpc_service_config.json b/google/cloud/retail/v2beta/retail_grpc_service_config.json
@@ -44,13 +44,26 @@
       {
         "service": "google.cloud.retail.v2beta.ProductService",
         "method": "ImportProducts"
-      },
+      }
+    ],
+    "timeout": "300s",
+    "retryPolicy": {
+      "initialBackoff": "0.100s",
+      "maxBackoff": "300s",
+      "backoffMultiplier": 1.3,
+      "retryableStatusCodes": [
+        "UNAVAILABLE",
+        "DEADLINE_EXCEEDED"
+      ]
+    }
+  }, {
+    "name": [
       {
         "service": "google.cloud.retail.v2beta.UserEventService",
         "method": "ImportUserEvents"
       }
     ],
-    "timeout": "300s",
+    "timeout": "600s",
     "retryPolicy": {
       "initialBackoff": "0.100s",
       "maxBackoff": "300s",

diff --git a/google/cloud/retail/v2beta/search_service.proto b/google/cloud/retail/v2beta/search_service.proto
@@ -97,6 +97,7 @@ message SearchRequest {
       //     * "customFulfillment3"
       //     * "customFulfillment4"
       //     * "customFulfillment5"
+      //     * "inventory(place_id,attributes.key)"
       //
       // * numerical_field =
       //     * "price"
@@ -105,6 +106,7 @@ message SearchRequest {
       //     * "ratingCount"
       //     * "attributes.key"
       //     * "inventory(place_id,price)"
+      //     * "inventory(place_id,attributes.key)"
       string key = 1 [(google.api.field_behavior) = REQUIRED];
 
       // Set only if values should be bucketized into intervals. Must be set
@@ -517,7 +519,10 @@ message SearchRequest {
   // * price
   // * originalPrice
   // * discount
+  // * variantId
   // * inventory(place_id,price)
+  // * inventory(place_id,attributes.key), where key is any key in the
+  //   [Product.inventories.attributes][] map.
   // * attributes.key, where key is any key in the
   //   [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map.
   // * pickupInStore.id, where id is any