google-cloud-retail-v2 0.8.0 → 0.11.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/retail/v2/catalog_pb.rb +55 -0
  4. data/lib/google/cloud/retail/v2/catalog_service/client.rb +718 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/paths.rb +38 -0
  6. data/lib/google/cloud/retail/v2/catalog_service_pb.rb +34 -0
  7. data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +38 -0
  8. data/lib/google/cloud/retail/v2/common_pb.rb +86 -0
  9. data/lib/google/cloud/retail/v2/completion_service/client.rb +7 -3
  10. data/lib/google/cloud/retail/v2/completion_service/operations.rb +3 -0
  11. data/lib/google/cloud/retail/v2/control_pb.rb +33 -0
  12. data/lib/google/cloud/retail/v2/control_service/client.rb +807 -0
  13. data/lib/google/cloud/retail/v2/control_service/credentials.rb +51 -0
  14. data/lib/google/cloud/retail/v2/control_service/paths.rb +73 -0
  15. data/lib/google/cloud/retail/v2/control_service.rb +49 -0
  16. data/lib/google/cloud/retail/v2/control_service_pb.rb +57 -0
  17. data/lib/google/cloud/retail/v2/control_service_services_pb.rb +65 -0
  18. data/lib/google/cloud/retail/v2/prediction_service/client.rb +28 -13
  19. data/lib/google/cloud/retail/v2/product_pb.rb +1 -0
  20. data/lib/google/cloud/retail/v2/product_service/client.rb +87 -42
  21. data/lib/google/cloud/retail/v2/product_service/operations.rb +3 -0
  22. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +67 -23
  23. data/lib/google/cloud/retail/v2/search_service/client.rb +15 -2
  24. data/lib/google/cloud/retail/v2/search_service_pb.rb +5 -0
  25. data/lib/google/cloud/retail/v2/serving_config_pb.rb +44 -0
  26. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +998 -0
  27. data/lib/google/cloud/retail/v2/serving_config_service/credentials.rb +51 -0
  28. data/lib/google/cloud/retail/v2/serving_config_service/paths.rb +73 -0
  29. data/lib/google/cloud/retail/v2/serving_config_service.rb +49 -0
  30. data/lib/google/cloud/retail/v2/serving_config_service_pb.rb +66 -0
  31. data/lib/google/cloud/retail/v2/serving_config_service_services_pb.rb +74 -0
  32. data/lib/google/cloud/retail/v2/user_event_service/client.rb +2 -2
  33. data/lib/google/cloud/retail/v2/user_event_service/operations.rb +3 -0
  34. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +0 -1
  35. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +2 -2
  36. data/lib/google/cloud/retail/v2/version.rb +1 -1
  37. data/lib/google/cloud/retail/v2.rb +2 -0
  38. data/proto_docs/google/cloud/retail/v2/catalog.rb +233 -0
  39. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +133 -0
  40. data/proto_docs/google/cloud/retail/v2/common.rb +314 -4
  41. data/proto_docs/google/cloud/retail/v2/completion_service.rb +9 -4
  42. data/proto_docs/google/cloud/retail/v2/control.rb +76 -0
  43. data/proto_docs/google/cloud/retail/v2/control_service.rb +122 -0
  44. data/proto_docs/google/cloud/retail/v2/import_config.rb +20 -35
  45. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +27 -12
  46. data/proto_docs/google/cloud/retail/v2/product.rb +7 -1
  47. data/proto_docs/google/cloud/retail/v2/product_service.rb +49 -21
  48. data/proto_docs/google/cloud/retail/v2/search_service.rb +72 -13
  49. data/proto_docs/google/cloud/retail/v2/serving_config.rb +238 -0
  50. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +143 -0
  51. data/proto_docs/google/protobuf/empty.rb +0 -2
  52. metadata +29 -11
@@ -0,0 +1,122 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Retail
23
+ module V2
24
+ # Request for CreateControl method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Full resource name of parent catalog. Format:
28
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
29
+ # @!attribute [rw] control
30
+ # @return [::Google::Cloud::Retail::V2::Control]
31
+ # Required. The Control to create.
32
+ # @!attribute [rw] control_id
33
+ # @return [::String]
34
+ # Required. The ID to use for the Control, which will become the final
35
+ # component of the Control's resource name.
36
+ #
37
+ # This value should be 4-63 characters, and valid characters
38
+ # are /[a-z][0-9]-_/.
39
+ class CreateControlRequest
40
+ include ::Google::Protobuf::MessageExts
41
+ extend ::Google::Protobuf::MessageExts::ClassMethods
42
+ end
43
+
44
+ # Request for UpdateControl method.
45
+ # @!attribute [rw] control
46
+ # @return [::Google::Cloud::Retail::V2::Control]
47
+ # Required. The Control to update.
48
+ # @!attribute [rw] update_mask
49
+ # @return [::Google::Protobuf::FieldMask]
50
+ # Indicates which fields in the provided
51
+ # {::Google::Cloud::Retail::V2::Control Control} to update. The following are NOT
52
+ # supported:
53
+ #
54
+ # * {::Google::Cloud::Retail::V2::Control#name Control.name}
55
+ #
56
+ # If not set or empty, all supported fields are updated.
57
+ class UpdateControlRequest
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # Request for DeleteControl method.
63
+ # @!attribute [rw] name
64
+ # @return [::String]
65
+ # Required. The resource name of the Control to delete. Format:
66
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
67
+ class DeleteControlRequest
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+ end
71
+
72
+ # Request for GetControl method.
73
+ # @!attribute [rw] name
74
+ # @return [::String]
75
+ # Required. The resource name of the Control to get. Format:
76
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
77
+ class GetControlRequest
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # Request for ListControls method.
83
+ # @!attribute [rw] parent
84
+ # @return [::String]
85
+ # Required. The catalog resource name. Format:
86
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
87
+ # @!attribute [rw] page_size
88
+ # @return [::Integer]
89
+ # Optional. Maximum number of results to return. If unspecified, defaults
90
+ # to 50. Max allowed value is 1000.
91
+ # @!attribute [rw] page_token
92
+ # @return [::String]
93
+ # Optional. A page token, received from a previous `ListControls` call.
94
+ # Provide this to retrieve the subsequent page.
95
+ # @!attribute [rw] filter
96
+ # @return [::String]
97
+ # Optional. A filter to apply on the list results. Supported features:
98
+ #
99
+ # * List all the products under the parent branch if
100
+ # {::Google::Cloud::Retail::V2::ListControlsRequest#filter filter} is unset.
101
+ # * List controls that are used in a single ServingConfig:
102
+ # 'serving_config = "boosted_home_page_cvr"'
103
+ class ListControlsRequest
104
+ include ::Google::Protobuf::MessageExts
105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
106
+ end
107
+
108
+ # Response for ListControls method.
109
+ # @!attribute [rw] controls
110
+ # @return [::Array<::Google::Cloud::Retail::V2::Control>]
111
+ # All the Controls for a given catalog.
112
+ # @!attribute [rw] next_page_token
113
+ # @return [::String]
114
+ # Pagination token, if not returned indicates the last page.
115
+ class ListControlsResponse
116
+ include ::Google::Protobuf::MessageExts
117
+ extend ::Google::Protobuf::MessageExts::ClassMethods
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end
@@ -22,7 +22,6 @@ module Google
22
22
  module Retail
23
23
  module V2
24
24
  # Google Cloud Storage location for input content.
25
- # format.
26
25
  # @!attribute [rw] input_uris
27
26
  # @return [::Array<::String>]
28
27
  # Required. Google Cloud Storage URIs to input files. URI can be up to
@@ -54,11 +53,13 @@ module Google
54
53
  #
55
54
  # Supported values for control imports:
56
55
  #
57
- # * 'control' (default): One JSON [Control][] per line.
56
+ # * `control` (default): One JSON {::Google::Cloud::Retail::V2::Control Control}
57
+ # per line.
58
58
  #
59
59
  # Supported values for catalog attribute imports:
60
60
  #
61
- # * 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
61
+ # * `catalog_attribute` (default): One CSV
62
+ # {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute} per line.
62
63
  class GcsSource
63
64
  include ::Google::Protobuf::MessageExts
64
65
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -69,9 +70,8 @@ module Google
69
70
  # @return [::Google::Type::Date]
70
71
  # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
71
72
  #
72
- # Only supported when
73
- # {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
74
- # is set to `FULL`.
73
+ # Only supported in
74
+ # {::Google::Cloud::Retail::V2::ImportProductsRequest ImportProductsRequest}.
75
75
  # @!attribute [rw] project_id
76
76
  # @return [::String]
77
77
  # The project ID (can be project # or ID) that the BigQuery source is in with
@@ -109,8 +109,7 @@ module Google
109
109
  # * `user_event_ga360`:
110
110
  # The schema is available here:
111
111
  # https://support.google.com/analytics/answer/3437719.
112
- # * `user_event_ga4`: This feature is in private preview. Please contact the
113
- # support team for importing Google Analytics 4 events.
112
+ # * `user_event_ga4`:
114
113
  # The schema is available here:
115
114
  # https://support.google.com/analytics/answer/7029846.
116
115
  #
@@ -148,7 +147,7 @@ module Google
148
147
  # @!attribute [rw] gcs_prefix
149
148
  # @return [::String]
150
149
  # Google Cloud Storage prefix for import errors. This must be an empty,
151
- # existing Cloud Storage directory. Import errors will be written to
150
+ # existing Cloud Storage directory. Import errors are written to
152
151
  # sharded files in this directory, one per line, as a JSON-encoded
153
152
  # `google.rpc.Status` message.
154
153
  class ImportErrorsConfig
@@ -175,8 +174,8 @@ module Google
175
174
  # The desired location of errors incurred during the Import.
176
175
  # @!attribute [rw] update_mask
177
176
  # @return [::Google::Protobuf::FieldMask]
178
- # Indicates which fields in the provided imported 'products' to update. If
179
- # not set, will by default update all fields.
177
+ # Indicates which fields in the provided imported `products` to update. If
178
+ # not set, all fields are updated.
180
179
  # @!attribute [rw] reconciliation_mode
181
180
  # @return [::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode]
182
181
  # The mode of reconciliation between existing products and the products to be
@@ -185,21 +184,16 @@ module Google
185
184
  # @!attribute [rw] notification_pubsub_topic
186
185
  # @return [::String]
187
186
  # Full Pub/Sub topic name for receiving notification. If this field is set,
188
- # when the import is finished, a notification will be sent to
189
- # specified Pub/Sub topic. The message data will be JSON string of a
187
+ # when the import is finished, a notification is sent to
188
+ # specified Pub/Sub topic. The message data is JSON string of a
190
189
  # {::Google::Longrunning::Operation Operation}.
191
190
  #
192
191
  # Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
193
192
  # to be within the same project as
194
193
  # {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
195
- # Make sure that both
196
- # `cloud-retail-customer-data-access@system.gserviceaccount.com` and
197
- # `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
198
- # have the `pubsub.topics.publish` IAM permission on the topic.
199
- #
200
- # Only supported when
201
- # {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
202
- # is set to `FULL`.
194
+ # Make sure that `service-<project
195
+ # number>@gcp-sa-retail.iam.gserviceaccount.com` has the
196
+ # `pubsub.topics.publish` IAM permission on the topic.
203
197
  class ImportProductsRequest
204
198
  include ::Google::Protobuf::MessageExts
205
199
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -215,15 +209,6 @@ module Google
215
209
 
216
210
  # Calculates diff and replaces the entire product dataset. Existing
217
211
  # products may be deleted if they are not present in the source location.
218
- #
219
- # Can only be set while using
220
- # {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}. And the BigQuery
221
- # dataset must be created in the data location "us (multiple regions in
222
- # United States)", otherwise a PERMISSION_DENIED error is thrown.
223
- #
224
- # Add the IAM permission "BigQuery Data Viewer" for
225
- # cloud-retail-customer-data-access@system.gserviceaccount.com before
226
- # using this feature otherwise an error is thrown.
227
212
  FULL = 2
228
213
  end
229
214
  end
@@ -256,8 +241,8 @@ module Google
256
241
  # @!attribute [rw] notification_pubsub_topic
257
242
  # @return [::String]
258
243
  # Pub/Sub topic for receiving notification. If this field is set,
259
- # when the import is finished, a notification will be sent to
260
- # specified Pub/Sub topic. The message data will be JSON string of a
244
+ # when the import is finished, a notification is sent to
245
+ # specified Pub/Sub topic. The message data is JSON string of a
261
246
  # {::Google::Longrunning::Operation Operation}.
262
247
  # Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
263
248
  class ImportCompletionDataRequest
@@ -308,7 +293,7 @@ module Google
308
293
  extend ::Google::Protobuf::MessageExts::ClassMethods
309
294
  end
310
295
 
311
- # Metadata related to the progress of the Import operation. This will be
296
+ # Metadata related to the progress of the Import operation. This is
312
297
  # returned by the google.longrunning.Operation.metadata field.
313
298
  # @!attribute [rw] create_time
314
299
  # @return [::Google::Protobuf::Timestamp]
@@ -329,8 +314,8 @@ module Google
329
314
  # @!attribute [rw] notification_pubsub_topic
330
315
  # @return [::String]
331
316
  # Pub/Sub topic for receiving notification. If this field is set,
332
- # when the import is finished, a notification will be sent to
333
- # specified Pub/Sub topic. The message data will be JSON string of a
317
+ # when the import is finished, a notification is sent to
318
+ # specified Pub/Sub topic. The message data is JSON string of a
334
319
  # {::Google::Longrunning::Operation Operation}.
335
320
  # Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
336
321
  class ImportMetadata
@@ -25,14 +25,19 @@ module Google
25
25
  # @!attribute [rw] placement
26
26
  # @return [::String]
27
27
  # Required. Full resource name of the format:
28
- # \\{name=projects/*/locations/global/catalogs/default_catalog/placements/*}
29
- # The ID of the Recommendations AI placement. Before you can request
30
- # predictions from your model, you must create at least one placement for it.
31
- # For more information, see [Managing
32
- # placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
28
+ # `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
29
+ # or
30
+ # `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
31
+ # We recommend using the `servingConfigs` resource. `placements` is a legacy
32
+ # resource.
33
+ # The ID of the Recommendations AI serving config or placement.
34
+ # Before you can request predictions from your model, you must create at
35
+ # least one serving config or placement for it. For more information, see
36
+ # [Managing serving configurations]
37
+ # (https://cloud.google.com/retail/docs/manage-configs).
33
38
  #
34
- # The full list of available placements can be seen at
35
- # https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
39
+ # The full list of available serving configs can be seen at
40
+ # https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
36
41
  # @!attribute [rw] user_event
37
42
  # @return [::Google::Cloud::Retail::V2::UserEvent]
38
43
  # Required. Context about the user, what they are looking at and what action
@@ -51,13 +56,13 @@ module Google
51
56
  # {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
52
57
  # @!attribute [rw] page_size
53
58
  # @return [::Integer]
54
- # Maximum number of results to return per page. Set this property
55
- # to the number of prediction results needed. If zero, the service will
56
- # choose a reasonable default. The maximum allowed value is 100. Values
57
- # above 100 will be coerced to 100.
59
+ # Maximum number of results to return. Set this property to the number of
60
+ # prediction results needed. If zero, the service will choose a reasonable
61
+ # default. The maximum allowed value is 100. Values above 100 will be coerced
62
+ # to 100.
58
63
  # @!attribute [rw] page_token
59
64
  # @return [::String]
60
- # The previous PredictResponse.next_page_token.
65
+ # This field is not used; leave it unset.
61
66
  # @!attribute [rw] filter
62
67
  # @return [::String]
63
68
  # Filter for restricting prediction results with a length limit of 5,000
@@ -89,6 +94,14 @@ module Google
89
94
  # receive empty results instead.
90
95
  # Note that the API will never return items with storageStatus of "EXPIRED"
91
96
  # or "DELETED" regardless of filter choices.
97
+ #
98
+ # If `filterSyntaxV2` is set to true under the `params` field, then
99
+ # attribute-based expressions are expected instead of the above described
100
+ # tag-based syntax. Examples:
101
+ #
102
+ # * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
103
+ # * (availability: ANY("IN_STOCK")) AND
104
+ # (colors: ANY("Red") OR categories: ANY("Phones"))
92
105
  # @!attribute [rw] validate_only
93
106
  # @return [::Boolean]
94
107
  # Use validate only mode for this prediction query. If set to true, a
@@ -122,6 +135,8 @@ module Google
122
135
  # 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
123
136
  # request-level control and adjusts prediction results based on product
124
137
  # category.
138
+ # * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
139
+ # field is interpreteted according to the new, attribute-based syntax.
125
140
  # @!attribute [rw] labels
126
141
  # @return [::Google::Protobuf::Map{::String => ::String}]
127
142
  # The labels applied to a resource must meet the following requirements:
@@ -114,7 +114,7 @@ module Google
114
114
  # Non-existent product ids are allowed.
115
115
  # The {::Google::Cloud::Retail::V2::Product#type type} of the members must be
116
116
  # either {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} or
117
- # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT} otherwise and
117
+ # {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT} otherwise an
118
118
  # INVALID_ARGUMENT error is thrown. Should not set it for other types. A
119
119
  # maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is
120
120
  # return.
@@ -474,6 +474,12 @@ module Google
474
474
  # Note: This field is OUTPUT_ONLY for
475
475
  # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}.
476
476
  # Do not set this field in API requests.
477
+ # @!attribute [r] local_inventories
478
+ # @return [::Array<::Google::Cloud::Retail::V2::LocalInventory>]
479
+ # Output only. A list of local inventories specific to different places.
480
+ #
481
+ # This is only available for users who have Retail Search enabled, and it can
482
+ # be managed by [AddLocalInventories][] and [RemoveLocalInventories][] APIs.
477
483
  class Product
478
484
  include ::Google::Protobuf::MessageExts
479
485
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -21,7 +21,9 @@ module Google
21
21
  module Cloud
22
22
  module Retail
23
23
  module V2
24
- # Request message for [CreateProduct][] method.
24
+ # Request message for
25
+ # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
26
+ # method.
25
27
  # @!attribute [rw] parent
26
28
  # @return [::String]
27
29
  # Required. The parent catalog resource name, such as
@@ -51,7 +53,9 @@ module Google
51
53
  extend ::Google::Protobuf::MessageExts::ClassMethods
52
54
  end
53
55
 
54
- # Request message for [GetProduct][] method.
56
+ # Request message for
57
+ # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
58
+ # method.
55
59
  # @!attribute [rw] name
56
60
  # @return [::String]
57
61
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -69,7 +73,9 @@ module Google
69
73
  extend ::Google::Protobuf::MessageExts::ClassMethods
70
74
  end
71
75
 
72
- # Request message for [UpdateProduct][] method.
76
+ # Request message for
77
+ # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
78
+ # method.
73
79
  # @!attribute [rw] product
74
80
  # @return [::Google::Cloud::Retail::V2::Product]
75
81
  # Required. The product to update/create.
@@ -106,7 +112,9 @@ module Google
106
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
107
113
  end
108
114
 
109
- # Request message for [DeleteProduct][] method.
115
+ # Request message for
116
+ # {::Google::Cloud::Retail::V2::ProductService::Client#delete_product ProductService.DeleteProduct}
117
+ # method.
110
118
  # @!attribute [rw] name
111
119
  # @return [::String]
112
120
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -238,11 +246,14 @@ module Google
238
246
  extend ::Google::Protobuf::MessageExts::ClassMethods
239
247
  end
240
248
 
241
- # Request message for [SetInventory][] method.
249
+ # Request message for
250
+ # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
251
+ # method.
242
252
  # @!attribute [rw] inventory
243
253
  # @return [::Google::Cloud::Retail::V2::Product]
244
254
  # Required. The inventory information to update. The allowable fields to
245
255
  # update are:
256
+ #
246
257
  # * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
247
258
  # * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
248
259
  # * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
@@ -250,8 +261,9 @@ module Google
250
261
  # The updated inventory fields must be specified in
251
262
  # {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
252
263
  #
253
- # If [SetInventoryRequest.inventory.name][] is empty or invalid, an
254
- # INVALID_ARGUMENT error is returned.
264
+ # If
265
+ # {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
266
+ # is empty or invalid, an INVALID_ARGUMENT error is returned.
255
267
  #
256
268
  # If the caller does not have permission to update the
257
269
  # {::Google::Cloud::Retail::V2::Product Product} named in
@@ -274,7 +286,8 @@ module Google
274
286
  # * Adds "fulfillment_info" in
275
287
  # {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
276
288
  # * Specifies only the desired fulfillment types and corresponding place IDs
277
- # to update in [SetInventoryRequest.inventory.fulfillment_info][]
289
+ # to update in
290
+ # {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
278
291
  #
279
292
  # The caller can clear all place IDs from a subset of fulfillment types in
280
293
  # the following ways:
@@ -282,9 +295,9 @@ module Google
282
295
  # * Adds "fulfillment_info" in
283
296
  # {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
284
297
  # * Specifies only the desired fulfillment types to clear in
285
- # [SetInventoryRequest.inventory.fulfillment_info][]
298
+ # {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
286
299
  # * Checks that only the desired fulfillment info types have empty
287
- # [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
300
+ # {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
288
301
  #
289
302
  # The last update time is recorded for the following inventory fields:
290
303
  # * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
@@ -293,7 +306,9 @@ module Google
293
306
  # * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
294
307
  #
295
308
  # If a full overwrite of inventory information while ignoring timestamps is
296
- # needed, [UpdateProduct][] should be invoked instead.
309
+ # needed,
310
+ # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
311
+ # should be invoked instead.
297
312
  # @!attribute [rw] set_mask
298
313
  # @return [::Google::Protobuf::FieldMask]
299
314
  # Indicates which inventory fields in the provided
@@ -323,14 +338,16 @@ module Google
323
338
 
324
339
  # Metadata related to the progress of the SetInventory operation.
325
340
  # Currently empty because there is no meaningful metadata populated from the
326
- # [SetInventory][] method.
341
+ # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
342
+ # method.
327
343
  class SetInventoryMetadata
328
344
  include ::Google::Protobuf::MessageExts
329
345
  extend ::Google::Protobuf::MessageExts::ClassMethods
330
346
  end
331
347
 
332
348
  # Response of the SetInventoryRequest. Currently empty because
333
- # there is no meaningful response populated from the [SetInventory][]
349
+ # there is no meaningful response populated from the
350
+ # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
334
351
  # method.
335
352
  class SetInventoryResponse
336
353
  include ::Google::Protobuf::MessageExts
@@ -369,7 +386,8 @@ module Google
369
386
  # If this field is set to an invalid value other than these, an
370
387
  # INVALID_ARGUMENT error is returned.
371
388
  #
372
- # This field directly corresponds to [Product.fulfillment_info.type][].
389
+ # This field directly corresponds to
390
+ # {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
373
391
  # @!attribute [rw] place_ids
374
392
  # @return [::Array<::String>]
375
393
  # Required. The IDs for this
@@ -494,7 +512,9 @@ module Google
494
512
  extend ::Google::Protobuf::MessageExts::ClassMethods
495
513
  end
496
514
 
497
- # Request message for [RemoveLocalInventories][] method.
515
+ # Request message for
516
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
517
+ # method.
498
518
  # @!attribute [rw] product
499
519
  # @return [::String]
500
520
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -528,21 +548,27 @@ module Google
528
548
 
529
549
  # Metadata related to the progress of the RemoveLocalInventories operation.
530
550
  # Currently empty because there is no meaningful metadata populated from the
531
- # [RemoveLocalInventories][] method.
551
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
552
+ # method.
532
553
  class RemoveLocalInventoriesMetadata
533
554
  include ::Google::Protobuf::MessageExts
534
555
  extend ::Google::Protobuf::MessageExts::ClassMethods
535
556
  end
536
557
 
537
- # Response of the [RemoveLocalInventories][] API. Currently empty because
538
- # there is no meaningful response populated from the [RemoveLocalInventories][]
558
+ # Response of the
559
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
560
+ # API. Currently empty because there is no meaningful response populated from
561
+ # the
562
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
539
563
  # method.
540
564
  class RemoveLocalInventoriesResponse
541
565
  include ::Google::Protobuf::MessageExts
542
566
  extend ::Google::Protobuf::MessageExts::ClassMethods
543
567
  end
544
568
 
545
- # Request message for [RemoveFulfillmentPlaces][] method.
569
+ # Request message for
570
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
571
+ # method.
546
572
  # @!attribute [rw] product
547
573
  # @return [::String]
548
574
  # Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
@@ -606,14 +632,16 @@ module Google
606
632
 
607
633
  # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
608
634
  # Currently empty because there is no meaningful metadata populated from the
609
- # [RemoveFulfillmentPlaces][] method.
635
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
636
+ # method.
610
637
  class RemoveFulfillmentPlacesMetadata
611
638
  include ::Google::Protobuf::MessageExts
612
639
  extend ::Google::Protobuf::MessageExts::ClassMethods
613
640
  end
614
641
 
615
642
  # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
616
- # is no meaningful response populated from the [RemoveFulfillmentPlaces][]
643
+ # is no meaningful response populated from the
644
+ # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
617
645
  # method.
618
646
  class RemoveFulfillmentPlacesResponse
619
647
  include ::Google::Protobuf::MessageExts