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

docs: Keep the API doc up-to-date feat: update grpc service config settings to reflect correct API deadlines #117

Merged
merged 2 commits into from
Nov 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions protos/google/cloud/retail/v2/catalog.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions protos/google/cloud/retail/v2/search_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ message SearchRequest {
// * "customFulfillment3"
// * "customFulfillment4"
// * "customFulfillment5"
// * "inventory(place_id,attributes.key)"
//
// * numerical_field =
// * "price"
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions protos/google/cloud/retail/v2alpha/catalog.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 2 additions & 0 deletions protos/google/cloud/retail/v2alpha/common.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
2 changes: 1 addition & 1 deletion protos/google/cloud/retail/v2alpha/product_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
5 changes: 5 additions & 0 deletions protos/google/cloud/retail/v2alpha/search_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ message SearchRequest {
// * "customFulfillment3"
// * "customFulfillment4"
// * "customFulfillment5"
// * "inventory(place_id,attributes.key)"
//
// * numerical_field =
// * "price"
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions protos/google/cloud/retail/v2beta/catalog.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions protos/google/cloud/retail/v2beta/search_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ message SearchRequest {
// * "customFulfillment3"
// * "customFulfillment4"
// * "customFulfillment5"
// * "inventory(place_id,attributes.key)"
//
// * numerical_field =
// * "price"
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions samples/generated/v2/search_service.search.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,10 @@ function main(placement, visitorId) {
* * 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ function main(product, localInventories) {
* 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.
*/
// const allowMissing = true
Expand Down
3 changes: 3 additions & 0 deletions samples/generated/v2alpha/search_service.search.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,10 @@ function main(placement, visitorId) {
* * 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
Expand Down
3 changes: 3 additions & 0 deletions samples/generated/v2beta/search_service.search.js
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,10 @@ function main(placement, visitorId) {
* * 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
Expand Down
9 changes: 9 additions & 0 deletions src/v2/search_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -709,7 +712,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -925,7 +931,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down
2 changes: 1 addition & 1 deletion src/v2/user_event_service_client_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"retry_params_name": "71ca22c74d2828b200f9ff1cc285a8beb96cc2af"
},
"ImportUserEvents": {
"timeout_millis": 300000,
"timeout_millis": 600000,
"retry_codes_name": "idempotent",
"retry_params_name": "49abb7cadc111ff8dd551b61fcad123362c8d090"
},
Expand Down
2 changes: 1 addition & 1 deletion src/v2alpha/product_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1732,7 +1732,7 @@ export class ProductServiceClient {
* not found, the local inventory will still be processed and retained for at
* most 1 day and processed once the
* {@link google.cloud.retail.v2alpha.Product|Product} is created. If set to false,
* an INVALID_ARGUMENT error is returned if the
* a NOT_FOUND error is returned if the
* {@link google.cloud.retail.v2alpha.Product|Product} is not found.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
Expand Down
9 changes: 9 additions & 0 deletions src/v2alpha/search_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2alpha.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -744,7 +747,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2alpha.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -982,7 +988,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2alpha.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down
2 changes: 1 addition & 1 deletion src/v2alpha/user_event_service_client_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"retry_params_name": "71ca22c74d2828b200f9ff1cc285a8beb96cc2af"
},
"ImportUserEvents": {
"timeout_millis": 300000,
"timeout_millis": 600000,
"retry_codes_name": "idempotent",
"retry_params_name": "49abb7cadc111ff8dd551b61fcad123362c8d090"
},
Expand Down
9 changes: 9 additions & 0 deletions src/v2beta/search_service_client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2beta.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -713,7 +716,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2beta.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down Expand Up @@ -931,7 +937,10 @@ export class SearchServiceClient {
* * price
* * originalPrice
* * discount
* * variantId
* * inventory(place_id,price)
* * inventory(place_id,attributes.key), where key is any key in the
* {@link |Product.inventories.attributes} map.
* * attributes.key, where key is any key in the
* {@link google.cloud.retail.v2beta.Product.attributes|Product.attributes} map.
* * pickupInStore.id, where id is any
Expand Down
2 changes: 1 addition & 1 deletion src/v2beta/user_event_service_client_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"retry_params_name": "71ca22c74d2828b200f9ff1cc285a8beb96cc2af"
},
"ImportUserEvents": {
"timeout_millis": 300000,
"timeout_millis": 600000,
"retry_codes_name": "idempotent",
"retry_params_name": "49abb7cadc111ff8dd551b61fcad123362c8d090"
},
Expand Down