google-apis-retail_v2alpha 0.25.0 → 0.29.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -124,10 +124,7 @@ module Google
|
|
124
124
|
end
|
125
125
|
|
126
126
|
# Get which branch is currently default branch set by CatalogService.
|
127
|
-
# SetDefaultBranch method under a specified parent catalog.
|
128
|
-
# available for users who have Retail Search enabled. Please submit a form [here]
|
129
|
-
# (https://cloud.google.com/contact) to contact cloud sales if you are
|
130
|
-
# interested in using Retail Search.
|
127
|
+
# SetDefaultBranch method under a specified parent catalog.
|
131
128
|
# @param [String] catalog
|
132
129
|
# The parent catalog resource name, such as `projects/*/locations/global/
|
133
130
|
# catalogs/default_catalog`.
|
@@ -256,9 +253,7 @@ module Google
|
|
256
253
|
# PredictionService will only return product IDs from branch `newBranch`. *
|
257
254
|
# SearchService will only return product IDs from branch `newBranch` (if branch
|
258
255
|
# is not explicitly set). * UserEventService will only join events with products
|
259
|
-
# from branch `newBranch`.
|
260
|
-
# Retail Search enabled. Please submit a form [here](https://cloud.google.com/
|
261
|
-
# contact) to contact cloud sales if you are interested in using Retail Search.
|
256
|
+
# from branch `newBranch`.
|
262
257
|
# @param [String] catalog
|
263
258
|
# Full resource name of the catalog, such as `projects/*/locations/global/
|
264
259
|
# catalogs/default_catalog`.
|
@@ -859,6 +854,197 @@ module Google
|
|
859
854
|
execute_or_queue_command(command, &block)
|
860
855
|
end
|
861
856
|
|
857
|
+
# Creates a Control. If the Control to create already exists, an ALREADY_EXISTS
|
858
|
+
# error is returned.
|
859
|
+
# @param [String] parent
|
860
|
+
# Required. Full resource name of parent catalog. Format: projects/`
|
861
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`
|
862
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] google_cloud_retail_v2alpha_control_object
|
863
|
+
# @param [String] control_id
|
864
|
+
# Required. The ID to use for the Control, which will become the final component
|
865
|
+
# of the Control's resource name. This value should be 4-63 characters, and
|
866
|
+
# valid characters are /a-z-_/.
|
867
|
+
# @param [String] fields
|
868
|
+
# Selector specifying which fields to include in a partial response.
|
869
|
+
# @param [String] quota_user
|
870
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
871
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
872
|
+
# @param [Google::Apis::RequestOptions] options
|
873
|
+
# Request-specific options
|
874
|
+
#
|
875
|
+
# @yield [result, err] Result & error if block supplied
|
876
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
|
877
|
+
# @yieldparam err [StandardError] error object if request failed
|
878
|
+
#
|
879
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
|
880
|
+
#
|
881
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
882
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
883
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
884
|
+
def create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
885
|
+
command = make_simple_command(:post, 'v2alpha/{+parent}/controls', options)
|
886
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
|
887
|
+
command.request_object = google_cloud_retail_v2alpha_control_object
|
888
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
|
889
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
|
890
|
+
command.params['parent'] = parent unless parent.nil?
|
891
|
+
command.query['controlId'] = control_id unless control_id.nil?
|
892
|
+
command.query['fields'] = fields unless fields.nil?
|
893
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
894
|
+
execute_or_queue_command(command, &block)
|
895
|
+
end
|
896
|
+
|
897
|
+
# Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error
|
898
|
+
# is returned.
|
899
|
+
# @param [String] name
|
900
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
901
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
902
|
+
# control_id`
|
903
|
+
# @param [String] fields
|
904
|
+
# Selector specifying which fields to include in a partial response.
|
905
|
+
# @param [String] quota_user
|
906
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
907
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
908
|
+
# @param [Google::Apis::RequestOptions] options
|
909
|
+
# Request-specific options
|
910
|
+
#
|
911
|
+
# @yield [result, err] Result & error if block supplied
|
912
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
|
913
|
+
# @yieldparam err [StandardError] error object if request failed
|
914
|
+
#
|
915
|
+
# @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
|
916
|
+
#
|
917
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
918
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
919
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
920
|
+
def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
921
|
+
command = make_simple_command(:delete, 'v2alpha/{+name}', options)
|
922
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
|
923
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
|
924
|
+
command.params['name'] = name unless name.nil?
|
925
|
+
command.query['fields'] = fields unless fields.nil?
|
926
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
927
|
+
execute_or_queue_command(command, &block)
|
928
|
+
end
|
929
|
+
|
930
|
+
# Gets a Control.
|
931
|
+
# @param [String] name
|
932
|
+
# Required. The resource name of the Control to delete. Format: projects/`
|
933
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
|
934
|
+
# control_id`
|
935
|
+
# @param [String] fields
|
936
|
+
# Selector specifying which fields to include in a partial response.
|
937
|
+
# @param [String] quota_user
|
938
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
939
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
940
|
+
# @param [Google::Apis::RequestOptions] options
|
941
|
+
# Request-specific options
|
942
|
+
#
|
943
|
+
# @yield [result, err] Result & error if block supplied
|
944
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
|
945
|
+
# @yieldparam err [StandardError] error object if request failed
|
946
|
+
#
|
947
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
|
948
|
+
#
|
949
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
950
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
951
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
952
|
+
def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
|
953
|
+
command = make_simple_command(:get, 'v2alpha/{+name}', options)
|
954
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
|
955
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
|
956
|
+
command.params['name'] = name unless name.nil?
|
957
|
+
command.query['fields'] = fields unless fields.nil?
|
958
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
959
|
+
execute_or_queue_command(command, &block)
|
960
|
+
end
|
961
|
+
|
962
|
+
# Lists all Controls linked to this catalog.
|
963
|
+
# @param [String] parent
|
964
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
965
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
966
|
+
# @param [String] filter
|
967
|
+
# Optional. A filter to apply on the list results. Supported features: * List
|
968
|
+
# all the products under the parent branch if filter is unset. * List controls
|
969
|
+
# that are used in a single ServingConfig: 'serving_config = "
|
970
|
+
# boosted_home_page_cvr"'
|
971
|
+
# @param [Fixnum] page_size
|
972
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 50.
|
973
|
+
# Max allowed value is 1000.
|
974
|
+
# @param [String] page_token
|
975
|
+
# Optional. A page token, received from a previous `ListControls` call. Provide
|
976
|
+
# this to retrieve the subsequent page.
|
977
|
+
# @param [String] fields
|
978
|
+
# Selector specifying which fields to include in a partial response.
|
979
|
+
# @param [String] quota_user
|
980
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
981
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
982
|
+
# @param [Google::Apis::RequestOptions] options
|
983
|
+
# Request-specific options
|
984
|
+
#
|
985
|
+
# @yield [result, err] Result & error if block supplied
|
986
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse] parsed result object
|
987
|
+
# @yieldparam err [StandardError] error object if request failed
|
988
|
+
#
|
989
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse]
|
990
|
+
#
|
991
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
992
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
993
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
994
|
+
def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
995
|
+
command = make_simple_command(:get, 'v2alpha/{+parent}/controls', options)
|
996
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse::Representation
|
997
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse
|
998
|
+
command.params['parent'] = parent unless parent.nil?
|
999
|
+
command.query['filter'] = filter unless filter.nil?
|
1000
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1001
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1002
|
+
command.query['fields'] = fields unless fields.nil?
|
1003
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1004
|
+
execute_or_queue_command(command, &block)
|
1005
|
+
end
|
1006
|
+
|
1007
|
+
# Updates a Control. Control cannot be set to a different oneof field, if so an
|
1008
|
+
# INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
|
1009
|
+
# NOT_FOUND error is returned.
|
1010
|
+
# @param [String] name
|
1011
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
1012
|
+
# controls/*
|
1013
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] google_cloud_retail_v2alpha_control_object
|
1014
|
+
# @param [String] update_mask
|
1015
|
+
# Indicates which fields in the provided Control to update. The following are
|
1016
|
+
# NOT supported: * Control.name If not set or empty, all supported fields are
|
1017
|
+
# updated.
|
1018
|
+
# @param [String] fields
|
1019
|
+
# Selector specifying which fields to include in a partial response.
|
1020
|
+
# @param [String] quota_user
|
1021
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1022
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1023
|
+
# @param [Google::Apis::RequestOptions] options
|
1024
|
+
# Request-specific options
|
1025
|
+
#
|
1026
|
+
# @yield [result, err] Result & error if block supplied
|
1027
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl] parsed result object
|
1028
|
+
# @yieldparam err [StandardError] error object if request failed
|
1029
|
+
#
|
1030
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl]
|
1031
|
+
#
|
1032
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1033
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1034
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1035
|
+
def patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1036
|
+
command = make_simple_command(:patch, 'v2alpha/{+name}', options)
|
1037
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
|
1038
|
+
command.request_object = google_cloud_retail_v2alpha_control_object
|
1039
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
|
1040
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
|
1041
|
+
command.params['name'] = name unless name.nil?
|
1042
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1043
|
+
command.query['fields'] = fields unless fields.nil?
|
1044
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1045
|
+
execute_or_queue_command(command, &block)
|
1046
|
+
end
|
1047
|
+
|
862
1048
|
# Gets the latest state of a long-running operation. Clients can use this method
|
863
1049
|
# to poll the operation result at intervals as recommended by the API service.
|
864
1050
|
# @param [String] name
|
@@ -1013,6 +1199,267 @@ module Google
|
|
1013
1199
|
execute_or_queue_command(command, &block)
|
1014
1200
|
end
|
1015
1201
|
|
1202
|
+
# Enables a Control on the specified ServingConfig. The control is added in the
|
1203
|
+
# last position of the list of controls it belongs to (e.g. if it's a facet spec
|
1204
|
+
# control it will be applied in the last position of servingConfig.facetSpecIds)
|
1205
|
+
# Returns a ALREADY_EXISTS error if the control has already been applied.
|
1206
|
+
# Returns a FAILED_PRECONDITION error if the addition could exceed maximum
|
1207
|
+
# number of control allowed for that type of control.
|
1208
|
+
# @param [String] serving_config
|
1209
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1210
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1211
|
+
# serving_config_id`
|
1212
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest] google_cloud_retail_v2alpha_add_control_request_object
|
1213
|
+
# @param [String] fields
|
1214
|
+
# Selector specifying which fields to include in a partial response.
|
1215
|
+
# @param [String] quota_user
|
1216
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1217
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1218
|
+
# @param [Google::Apis::RequestOptions] options
|
1219
|
+
# Request-specific options
|
1220
|
+
#
|
1221
|
+
# @yield [result, err] Result & error if block supplied
|
1222
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
|
1223
|
+
# @yieldparam err [StandardError] error object if request failed
|
1224
|
+
#
|
1225
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
|
1226
|
+
#
|
1227
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1228
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1229
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1230
|
+
def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1231
|
+
command = make_simple_command(:post, 'v2alpha/{+servingConfig}:addControl', options)
|
1232
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest::Representation
|
1233
|
+
command.request_object = google_cloud_retail_v2alpha_add_control_request_object
|
1234
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1235
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
|
1236
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1237
|
+
command.query['fields'] = fields unless fields.nil?
|
1238
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1239
|
+
execute_or_queue_command(command, &block)
|
1240
|
+
end
|
1241
|
+
|
1242
|
+
# Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
|
1243
|
+
# Catalog, otherwise a FAILED_PRECONDITION error is returned.
|
1244
|
+
# @param [String] parent
|
1245
|
+
# Required. Full resource name of parent. Format: projects/`project_number`/
|
1246
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1247
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] google_cloud_retail_v2alpha_serving_config_object
|
1248
|
+
# @param [String] serving_config_id
|
1249
|
+
# Required. The ID to use for the ServingConfig, which will become the final
|
1250
|
+
# component of the ServingConfig's resource name. This value should be 4-63
|
1251
|
+
# characters, and valid characters are /a-z-_/.
|
1252
|
+
# @param [String] fields
|
1253
|
+
# Selector specifying which fields to include in a partial response.
|
1254
|
+
# @param [String] quota_user
|
1255
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1256
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1257
|
+
# @param [Google::Apis::RequestOptions] options
|
1258
|
+
# Request-specific options
|
1259
|
+
#
|
1260
|
+
# @yield [result, err] Result & error if block supplied
|
1261
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
|
1262
|
+
# @yieldparam err [StandardError] error object if request failed
|
1263
|
+
#
|
1264
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
|
1265
|
+
#
|
1266
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1267
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1268
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1269
|
+
def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1270
|
+
command = make_simple_command(:post, 'v2alpha/{+parent}/servingConfigs', options)
|
1271
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1272
|
+
command.request_object = google_cloud_retail_v2alpha_serving_config_object
|
1273
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1274
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
|
1275
|
+
command.params['parent'] = parent unless parent.nil?
|
1276
|
+
command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil?
|
1277
|
+
command.query['fields'] = fields unless fields.nil?
|
1278
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1279
|
+
execute_or_queue_command(command, &block)
|
1280
|
+
end
|
1281
|
+
|
1282
|
+
# Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
|
1283
|
+
# not exist.
|
1284
|
+
# @param [String] name
|
1285
|
+
# Required. The resource name of the ServingConfig to delete. Format: projects/`
|
1286
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1287
|
+
# serving_config_id`
|
1288
|
+
# @param [String] fields
|
1289
|
+
# Selector specifying which fields to include in a partial response.
|
1290
|
+
# @param [String] quota_user
|
1291
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1292
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1293
|
+
# @param [Google::Apis::RequestOptions] options
|
1294
|
+
# Request-specific options
|
1295
|
+
#
|
1296
|
+
# @yield [result, err] Result & error if block supplied
|
1297
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
|
1298
|
+
# @yieldparam err [StandardError] error object if request failed
|
1299
|
+
#
|
1300
|
+
# @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
|
1301
|
+
#
|
1302
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1303
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1304
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1305
|
+
def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1306
|
+
command = make_simple_command(:delete, 'v2alpha/{+name}', options)
|
1307
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
|
1308
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
|
1309
|
+
command.params['name'] = name unless name.nil?
|
1310
|
+
command.query['fields'] = fields unless fields.nil?
|
1311
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1312
|
+
execute_or_queue_command(command, &block)
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
1316
|
+
# exist.
|
1317
|
+
# @param [String] name
|
1318
|
+
# Required. The resource name of the ServingConfig to get. Format: projects/`
|
1319
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1320
|
+
# serving_config_id`
|
1321
|
+
# @param [String] fields
|
1322
|
+
# Selector specifying which fields to include in a partial response.
|
1323
|
+
# @param [String] quota_user
|
1324
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1325
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1326
|
+
# @param [Google::Apis::RequestOptions] options
|
1327
|
+
# Request-specific options
|
1328
|
+
#
|
1329
|
+
# @yield [result, err] Result & error if block supplied
|
1330
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
|
1331
|
+
# @yieldparam err [StandardError] error object if request failed
|
1332
|
+
#
|
1333
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
|
1334
|
+
#
|
1335
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1336
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1337
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1338
|
+
def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1339
|
+
command = make_simple_command(:get, 'v2alpha/{+name}', options)
|
1340
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1341
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
|
1342
|
+
command.params['name'] = name unless name.nil?
|
1343
|
+
command.query['fields'] = fields unless fields.nil?
|
1344
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1345
|
+
execute_or_queue_command(command, &block)
|
1346
|
+
end
|
1347
|
+
|
1348
|
+
# Lists all ServingConfigs linked to this catalog.
|
1349
|
+
# @param [String] parent
|
1350
|
+
# Required. The catalog resource name. Format: projects/`project_number`/
|
1351
|
+
# locations/`location_id`/catalogs/`catalog_id`
|
1352
|
+
# @param [Fixnum] page_size
|
1353
|
+
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
1354
|
+
# If a value greater than 100 is provided, at most 100 results are returned.
|
1355
|
+
# @param [String] page_token
|
1356
|
+
# Optional. A page token, received from a previous `ListServingConfigs` call.
|
1357
|
+
# Provide this to retrieve the subsequent page.
|
1358
|
+
# @param [String] fields
|
1359
|
+
# Selector specifying which fields to include in a partial response.
|
1360
|
+
# @param [String] quota_user
|
1361
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1362
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1363
|
+
# @param [Google::Apis::RequestOptions] options
|
1364
|
+
# Request-specific options
|
1365
|
+
#
|
1366
|
+
# @yield [result, err] Result & error if block supplied
|
1367
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse] parsed result object
|
1368
|
+
# @yieldparam err [StandardError] error object if request failed
|
1369
|
+
#
|
1370
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse]
|
1371
|
+
#
|
1372
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1373
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1374
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1375
|
+
def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1376
|
+
command = make_simple_command(:get, 'v2alpha/{+parent}/servingConfigs', options)
|
1377
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse::Representation
|
1378
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse
|
1379
|
+
command.params['parent'] = parent unless parent.nil?
|
1380
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1381
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1382
|
+
command.query['fields'] = fields unless fields.nil?
|
1383
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1384
|
+
execute_or_queue_command(command, &block)
|
1385
|
+
end
|
1386
|
+
|
1387
|
+
# Updates a ServingConfig.
|
1388
|
+
# @param [String] name
|
1389
|
+
# Immutable. Fully qualified name projects/*/locations/global/catalogs/*/
|
1390
|
+
# servingConfig/*
|
1391
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] google_cloud_retail_v2alpha_serving_config_object
|
1392
|
+
# @param [String] update_mask
|
1393
|
+
# Indicates which fields in the provided ServingConfig to update. The following
|
1394
|
+
# are NOT supported: * ServingConfig.name If not set, all supported fields are
|
1395
|
+
# updated.
|
1396
|
+
# @param [String] fields
|
1397
|
+
# Selector specifying which fields to include in a partial response.
|
1398
|
+
# @param [String] quota_user
|
1399
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1400
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1401
|
+
# @param [Google::Apis::RequestOptions] options
|
1402
|
+
# Request-specific options
|
1403
|
+
#
|
1404
|
+
# @yield [result, err] Result & error if block supplied
|
1405
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
|
1406
|
+
# @yieldparam err [StandardError] error object if request failed
|
1407
|
+
#
|
1408
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
|
1409
|
+
#
|
1410
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1411
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1412
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1413
|
+
def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1414
|
+
command = make_simple_command(:patch, 'v2alpha/{+name}', options)
|
1415
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1416
|
+
command.request_object = google_cloud_retail_v2alpha_serving_config_object
|
1417
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1418
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
|
1419
|
+
command.params['name'] = name unless name.nil?
|
1420
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1421
|
+
command.query['fields'] = fields unless fields.nil?
|
1422
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1423
|
+
execute_or_queue_command(command, &block)
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# Disables a Control on the specified ServingConfig. The control is removed from
|
1427
|
+
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1428
|
+
# the ServingConfig.
|
1429
|
+
# @param [String] serving_config
|
1430
|
+
# Required. The source ServingConfig resource name . Format: projects/`
|
1431
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
|
1432
|
+
# serving_config_id`
|
1433
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest] google_cloud_retail_v2alpha_remove_control_request_object
|
1434
|
+
# @param [String] fields
|
1435
|
+
# Selector specifying which fields to include in a partial response.
|
1436
|
+
# @param [String] quota_user
|
1437
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1438
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1439
|
+
# @param [Google::Apis::RequestOptions] options
|
1440
|
+
# Request-specific options
|
1441
|
+
#
|
1442
|
+
# @yield [result, err] Result & error if block supplied
|
1443
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig] parsed result object
|
1444
|
+
# @yieldparam err [StandardError] error object if request failed
|
1445
|
+
#
|
1446
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig]
|
1447
|
+
#
|
1448
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1449
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1450
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1451
|
+
def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1452
|
+
command = make_simple_command(:post, 'v2alpha/{+servingConfig}:removeControl', options)
|
1453
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest::Representation
|
1454
|
+
command.request_object = google_cloud_retail_v2alpha_remove_control_request_object
|
1455
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
|
1456
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
|
1457
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1458
|
+
command.query['fields'] = fields unless fields.nil?
|
1459
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1460
|
+
execute_or_queue_command(command, &block)
|
1461
|
+
end
|
1462
|
+
|
1016
1463
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1017
1464
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1018
1465
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1285,6 +1732,83 @@ module Google
|
|
1285
1732
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1286
1733
|
execute_or_queue_command(command, &block)
|
1287
1734
|
end
|
1735
|
+
|
1736
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
1737
|
+
# to poll the operation result at intervals as recommended by the API service.
|
1738
|
+
# @param [String] name
|
1739
|
+
# The name of the operation resource.
|
1740
|
+
# @param [String] fields
|
1741
|
+
# Selector specifying which fields to include in a partial response.
|
1742
|
+
# @param [String] quota_user
|
1743
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1744
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1745
|
+
# @param [Google::Apis::RequestOptions] options
|
1746
|
+
# Request-specific options
|
1747
|
+
#
|
1748
|
+
# @yield [result, err] Result & error if block supplied
|
1749
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
1750
|
+
# @yieldparam err [StandardError] error object if request failed
|
1751
|
+
#
|
1752
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
1753
|
+
#
|
1754
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1755
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1756
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1757
|
+
def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
1758
|
+
command = make_simple_command(:get, 'v2alpha/{+name}', options)
|
1759
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
1760
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
1761
|
+
command.params['name'] = name unless name.nil?
|
1762
|
+
command.query['fields'] = fields unless fields.nil?
|
1763
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1764
|
+
execute_or_queue_command(command, &block)
|
1765
|
+
end
|
1766
|
+
|
1767
|
+
# Lists operations that match the specified filter in the request. If the server
|
1768
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
1769
|
+
# binding allows API services to override the binding to use different resource
|
1770
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
1771
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
1772
|
+
# service configuration. For backwards compatibility, the default name includes
|
1773
|
+
# the operations collection id, however overriding users must ensure the name
|
1774
|
+
# binding is the parent resource, without the operations collection id.
|
1775
|
+
# @param [String] name
|
1776
|
+
# The name of the operation's parent resource.
|
1777
|
+
# @param [String] filter
|
1778
|
+
# The standard list filter.
|
1779
|
+
# @param [Fixnum] page_size
|
1780
|
+
# The standard list page size.
|
1781
|
+
# @param [String] page_token
|
1782
|
+
# The standard list page token.
|
1783
|
+
# @param [String] fields
|
1784
|
+
# Selector specifying which fields to include in a partial response.
|
1785
|
+
# @param [String] quota_user
|
1786
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1787
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1788
|
+
# @param [Google::Apis::RequestOptions] options
|
1789
|
+
# Request-specific options
|
1790
|
+
#
|
1791
|
+
# @yield [result, err] Result & error if block supplied
|
1792
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
1793
|
+
# @yieldparam err [StandardError] error object if request failed
|
1794
|
+
#
|
1795
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse]
|
1796
|
+
#
|
1797
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1798
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1799
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1800
|
+
def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1801
|
+
command = make_simple_command(:get, 'v2alpha/{+name}/operations', options)
|
1802
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
|
1803
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse
|
1804
|
+
command.params['name'] = name unless name.nil?
|
1805
|
+
command.query['filter'] = filter unless filter.nil?
|
1806
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1807
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1808
|
+
command.query['fields'] = fields unless fields.nil?
|
1809
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1810
|
+
execute_or_queue_command(command, &block)
|
1811
|
+
end
|
1288
1812
|
|
1289
1813
|
protected
|
1290
1814
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.29.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-02-14 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.29.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|