docs: Keep the API doc up-to-date feat: update grpc service config se…

…ttings to reflect correct API deadlines chore: remove relative private links from search service comments to prevent crashing client lib generation tool (#95) * docs: Keep the API doc up-to-date feat: update grpc service config settings to reflect correct API deadlines chore: remove relative private links from search service comments to prevent crashing client lib generation tool PiperOrigin-RevId: 392712211 Source-Link: googleapis/googleapis@cb637a6 Source-Link: googleapis/googleapis-gen@4c87ab9 * 🦉 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>
googleapis · Aug 25, 2021 · fd4b8ed · fd4b8ed
1 parent 47d95e8
commit fd4b8ed
Show file tree

Hide file tree

Showing 66 changed files with 1,687 additions and 774 deletions.
diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/catalog.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/catalog.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/catalog_service.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/catalog_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -93,8 +93,8 @@ service CatalogService {
   //   {newBranch}.
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc SetDefaultBranch(SetDefaultBranchRequest)
       returns (google.protobuf.Empty) {
     option (google.api.http) = {
@@ -109,8 +109,8 @@ service CatalogService {
   // method under a specified parent catalog.
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc GetDefaultBranch(GetDefaultBranchRequest)
       returns (GetDefaultBranchResponse) {
     option (google.api.http) = {

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/common.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/completion_service.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/completion_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -36,8 +36,8 @@ option ruby_package = "Google::Cloud::Retail::V2";
 // Auto-completion service for retail.
 //
 // This feature is only available for users who have Retail Search enabled.
-// Contact Retail Support (retail-search-support@google.com) if you are
-// interested in using Retail Search.
+// Please submit a form [here](https://cloud.google.com/contact) to contact
+// cloud sales if you are interested in using Retail Search.
 service CompletionService {
   option (google.api.default_host) = "retail.googleapis.com";
   option (google.api.oauth_scopes) =
@@ -46,8 +46,8 @@ service CompletionService {
   // Completes the specified prefix with keyword suggestions.
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) {
     option (google.api.http) = {
       get: "/v2/{catalog=projects/*/locations/*/catalogs/*}:completeQuery"
@@ -59,8 +59,8 @@ service CompletionService {
   // Request processing may be synchronous. Partial updating is not supported.
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc ImportCompletionData(ImportCompletionDataRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {
@@ -135,13 +135,15 @@ message CompleteQueryRequest {
   // * user-data
   //
   // * cloud-retail
-  //   This option is not automatically enabled. Before using cloud-retail,
-  //   contact retail-search-support@google.com first.
+  //   This option requires additional allowlisting. Before using cloud-retail,
+  //   contact Cloud Retail support team first.
   string dataset = 6;
 
-  // Completion max suggestions.
+  // Completion max suggestions. If left unset or set to 0, then will fallback
+  // to the configured value [CompletionConfig.max_suggestions][].
   //
-  // The maximum allowed max suggestions is 20. The default value is 20.
+  // The maximum allowed max suggestions is 20. If it is set higher, it will be
+  // capped by 20.
   int32 max_suggestions = 5;
 }
 
@@ -172,9 +174,9 @@ message CompleteQueryResponse {
   // performance.
   string attribution_token = 2;
 
-  // Matched recent searches of this user. This field is a restricted feature.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in enabling it.
+  // Matched recent searches of this user. The maximum number of recent searches
+  // is 10. This field is a restricted feature. Contact Retail Search support
+  // team if you are interested in enabling it.
   //
   // This feature is only available when
   // [CompleteQueryRequest.visitor_id][google.cloud.retail.v2.CompleteQueryRequest.visitor_id]

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/import_config.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/import_config.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -160,13 +160,13 @@ message ImportProductsRequest {
     // Can only be while using
     // [BigQuerySource][google.cloud.retail.v2.BigQuerySource].
     //
-    // Add the IAM permission “BigQuery Data Viewer” for
+    // Add the IAM permission "BigQuery Data Viewer" for
     // cloud-retail-customer-data-access@system.gserviceaccount.com before
     // using this feature otherwise an error is thrown.
     //
     // This feature is only available for users who have Retail Search enabled.
-    // Contact Retail Support (retail-search-support@google.com) if you are
-    // interested in using Retail Search.
+    // Please submit a form [here](https://cloud.google.com/contact) to contact
+    // cloud sales if you are interested in using Retail Search.
     FULL = 2;
   }
 
@@ -303,7 +303,7 @@ message CompletionDataInputConfig {
   oneof source {
     // Required. BigQuery input source.
     //
-    // Add the IAM permission “BigQuery Data Viewer” for
+    // Add the IAM permission "BigQuery Data Viewer" for
     // cloud-retail-customer-data-access@system.gserviceaccount.com before
     // using this feature otherwise an error is thrown.
     BigQuerySource big_query_source = 1

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/prediction_service.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/prediction_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/product.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/product.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -200,6 +200,9 @@ message Product {
   // This field must be a UTF-8 encoded string with a length limit of 128
   // characters. Otherwise, an INVALID_ARGUMENT error is returned.
   //
+  // This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
+  // returned.
+  //
   // Google Merchant Center property
   // [gtin](https://support.google.com/merchants/answer/6324461).
   // Schema.org property
@@ -310,13 +313,9 @@ message Product {
   // This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
   // error is returned:
   //
-  // * Max entries count: 200 by default; 100 for
-  // [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT].
+  // * Max entries count: 200.
   // * The key must be a UTF-8 encoded string with a length limit of 128
   //   characters.
-  // * Max indexable entries count: 200 by default; 40 for
-  // [Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT].
-  // * Max searchable entries count: 30.
   // * For indexable attribute, the key must match the pattern:
   //   [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
   map<string, CustomAttribute> attributes = 12;
@@ -426,7 +425,7 @@ message Product {
 
   // The material of the product. For example, "leather", "wooden".
   //
-  // A maximum of 5 values are allowed. Each value must be a UTF-8 encoded
+  // A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
   // string with a length limit of 128 characters. Otherwise, an
   // INVALID_ARGUMENT error is returned.
   //
@@ -438,7 +437,7 @@ message Product {
   // The pattern or graphic print of the product. For example, "striped", "polka
   // dot", "paisley".
   //
-  // A maximum of 5 values are allowed per
+  // A maximum of 20 values are allowed per
   // [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8
   // encoded string with a length limit of 128 characters. Otherwise, an
   // INVALID_ARGUMENT error is returned.
@@ -525,8 +524,12 @@ message Product {
   // * [name][google.cloud.retail.v2.Product.name]
   // * [color_info][google.cloud.retail.v2.Product.color_info]
   //
-  // Maximum number of paths is 20. Otherwise, an INVALID_ARGUMENT error is
+  // Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
   // returned.
+  //
+  // Note: Returning more fields in
+  // [SearchResponse][google.cloud.retail.v2.SearchResponse] may increase
+  // response payload size and serving latency.
   google.protobuf.FieldMask retrievable_fields = 30;
 
   // Output only. Product variants grouped together on primary product which

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/product_service.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/product_service.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -143,8 +143,8 @@ service ProductService {
   // [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc SetInventory(SetInventoryRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2/{inventory.name=projects/*/locations/*/catalogs/*/branches/*/products/**}:setInventory"
@@ -170,8 +170,8 @@ service ProductService {
   // [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc AddFulfillmentPlaces(AddFulfillmentPlacesRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {
@@ -198,8 +198,8 @@ service ProductService {
   // [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
   //
   // This feature is only available for users who have Retail Search enabled.
-  // Contact Retail Support (retail-search-support@google.com) if you are
-  // interested in using Retail Search.
+  // Please submit a form [here](https://cloud.google.com/contact) to contact
+  // cloud sales if you are interested in using Retail Search.
   rpc RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {

diff --git a/packages/google-cloud-retail/protos/google/cloud/retail/v2/purge_config.proto b/packages/google-cloud-retail/protos/google/cloud/retail/v2/purge_config.proto
@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.