google-api-client 0.42.0 → 0.42.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +70 -0
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/admob_v1/service.rb +1 -1
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +28 -13
- data/generated/google/apis/billingbudgets_v1beta1/representations.rb +1 -0
- data/generated/google/apis/blogger_v3.rb +1 -1
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +111 -0
- data/generated/google/apis/chat_v1/representations.rb +50 -0
- data/generated/google/apis/chat_v1/service.rb +32 -0
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/service.rb +5 -2
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1/classes.rb +25 -0
- data/generated/google/apis/cloudidentity_v1beta1/representations.rb +15 -0
- data/generated/google/apis/cloudscheduler_v1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1/classes.rb +5 -5
- data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +5 -5
- data/generated/google/apis/cloudtrace_v1.rb +1 -1
- data/generated/google/apis/cloudtrace_v1/classes.rb +2 -3
- data/generated/google/apis/cloudtrace_v1/service.rb +1 -7
- data/generated/google/apis/cloudtrace_v2.rb +1 -1
- data/generated/google/apis/cloudtrace_v2/classes.rb +6 -5
- data/generated/google/apis/cloudtrace_v2/service.rb +3 -6
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +279 -0
- data/generated/google/apis/compute_beta/representations.rb +90 -0
- data/generated/google/apis/compute_beta/service.rb +257 -0
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +279 -0
- data/generated/google/apis/compute_v1/representations.rb +90 -0
- data/generated/google/apis/compute_v1/service.rb +257 -0
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +9 -0
- data/generated/google/apis/container_v1/representations.rb +1 -0
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +15 -0
- data/generated/google/apis/container_v1beta1/representations.rb +2 -0
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +2 -2
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +4 -4
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/customsearch_v1/service.rb +12 -2
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +3 -3
- data/generated/google/apis/dataflow_v1b3.rb +1 -1
- data/generated/google/apis/dataflow_v1b3/service.rb +2 -2
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +9 -9
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +9 -9
- data/generated/google/apis/datastore_v1.rb +1 -1
- data/generated/google/apis/datastore_v1/classes.rb +1 -1
- data/generated/google/apis/displayvideo_v1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/service.rb +2 -1
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dlp_v2/classes.rb +5 -2
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v2beta1.rb +4 -4
- data/generated/google/apis/dns_v2beta1/classes.rb +313 -162
- data/generated/google/apis/dns_v2beta1/service.rb +247 -180
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +66 -2
- data/generated/google/apis/drive_v2/representations.rb +22 -0
- data/generated/google/apis/drive_v2/service.rb +23 -10
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +65 -2
- data/generated/google/apis/drive_v3/representations.rb +22 -0
- data/generated/google/apis/drive_v3/service.rb +8 -5
- data/generated/google/apis/firestore_v1.rb +1 -1
- data/generated/google/apis/firestore_v1/classes.rb +152 -0
- data/generated/google/apis/firestore_v1/representations.rb +63 -0
- data/generated/google/apis/firestore_v1/service.rb +78 -0
- data/generated/google/apis/firestore_v1beta1.rb +1 -1
- data/generated/google/apis/firestore_v1beta1/classes.rb +152 -0
- data/generated/google/apis/firestore_v1beta1/representations.rb +63 -0
- data/generated/google/apis/firestore_v1beta1/service.rb +78 -0
- data/generated/google/apis/gmail_v1.rb +1 -1
- data/generated/google/apis/gmail_v1/classes.rb +53 -53
- data/generated/google/apis/gmail_v1/service.rb +72 -72
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/service.rb +48 -1
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/service.rb +60 -1
- data/generated/google/apis/iam_v1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +22 -3
- data/generated/google/apis/iam_v1/service.rb +18 -6
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +1 -1
- data/generated/google/apis/ml_v1.rb +1 -1
- data/generated/google/apis/ml_v1/classes.rb +17 -11
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +54 -30
- data/generated/google/apis/networkmanagement_v1.rb +1 -1
- data/generated/google/apis/networkmanagement_v1/classes.rb +6 -6
- data/generated/google/apis/networkmanagement_v1beta1.rb +1 -1
- data/generated/google/apis/networkmanagement_v1beta1/classes.rb +6 -6
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +2 -2
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +2 -2
- data/generated/google/apis/realtimebidding_v1.rb +1 -1
- data/generated/google/apis/recommendationengine_v1beta1.rb +36 -0
- data/generated/google/apis/recommendationengine_v1beta1/classes.rb +2015 -0
- data/generated/google/apis/recommendationengine_v1beta1/representations.rb +848 -0
- data/generated/google/apis/recommendationengine_v1beta1/service.rb +990 -0
- data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
- data/generated/google/apis/reseller_v1.rb +4 -3
- data/generated/google/apis/reseller_v1/classes.rb +219 -160
- data/generated/google/apis/reseller_v1/service.rb +247 -252
- data/generated/google/apis/run_v1.rb +2 -2
- data/generated/google/apis/run_v1/classes.rb +6 -1
- data/generated/google/apis/run_v1/service.rb +1 -1
- data/generated/google/apis/run_v1alpha1.rb +2 -2
- data/generated/google/apis/run_v1alpha1/service.rb +1 -1
- data/generated/google/apis/run_v1beta1.rb +2 -2
- data/generated/google/apis/run_v1beta1/service.rb +1 -1
- data/generated/google/apis/searchconsole_v1.rb +4 -3
- data/generated/google/apis/searchconsole_v1/service.rb +3 -2
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +2 -2
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +2 -2
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- data/generated/google/apis/servicecontrol_v1/classes.rb +6 -6
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +2 -2
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +2 -2
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +2 -2
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +2 -2
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +2 -2
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/sheets_v4/classes.rb +28 -28
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +2 -0
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +2 -0
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +2 -0
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +2 -2
- data/generated/google/apis/youtube_v3/service.rb +1 -0
- data/lib/google/apis/version.rb +1 -1
- metadata +7 -3
@@ -0,0 +1,990 @@
|
|
1
|
+
# Copyright 2015 Google Inc.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module RecommendationengineV1beta1
|
23
|
+
# Recommendations AI
|
24
|
+
#
|
25
|
+
# Recommendations AI service enables customers to build end-to-end personalized
|
26
|
+
# recommendation systems without requiring a high level of expertise in machine
|
27
|
+
# learning, recommendation system, or Google Cloud.
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
# require 'google/apis/recommendationengine_v1beta1'
|
31
|
+
#
|
32
|
+
# Recommendationengine = Google::Apis::RecommendationengineV1beta1 # Alias the module
|
33
|
+
# service = Recommendationengine::RecommendationsAIService.new
|
34
|
+
#
|
35
|
+
# @see https://cloud.google.com/recommendations/docs/
|
36
|
+
class RecommendationsAIService < Google::Apis::Core::BaseService
|
37
|
+
# @return [String]
|
38
|
+
# API key. Your API key identifies your project and provides you with API access,
|
39
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
40
|
+
attr_accessor :key
|
41
|
+
|
42
|
+
# @return [String]
|
43
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
44
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
45
|
+
attr_accessor :quota_user
|
46
|
+
|
47
|
+
def initialize
|
48
|
+
super('https://recommendationengine.googleapis.com/', '')
|
49
|
+
@batch_path = 'batch'
|
50
|
+
end
|
51
|
+
|
52
|
+
# Lists all the catalog configurations associated with the project.
|
53
|
+
# @param [String] parent
|
54
|
+
# Required. The account resource name with an associated location.
|
55
|
+
# @param [Fixnum] page_size
|
56
|
+
# Optional. Maximum number of results to return. If unspecified, defaults
|
57
|
+
# to 50. Max allowed value is 1000.
|
58
|
+
# @param [String] page_token
|
59
|
+
# Optional. A page token, received from a previous `ListCatalogs`
|
60
|
+
# call. Provide this to retrieve the subsequent page.
|
61
|
+
# @param [String] fields
|
62
|
+
# Selector specifying which fields to include in a partial response.
|
63
|
+
# @param [String] quota_user
|
64
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
65
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
66
|
+
# @param [Google::Apis::RequestOptions] options
|
67
|
+
# Request-specific options
|
68
|
+
#
|
69
|
+
# @yield [result, err] Result & error if block supplied
|
70
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogsResponse] parsed result object
|
71
|
+
# @yieldparam err [StandardError] error object if request failed
|
72
|
+
#
|
73
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogsResponse]
|
74
|
+
#
|
75
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
76
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
77
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
78
|
+
def list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
79
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/catalogs', options)
|
80
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogsResponse::Representation
|
81
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogsResponse
|
82
|
+
command.params['parent'] = parent unless parent.nil?
|
83
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
84
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
85
|
+
command.query['fields'] = fields unless fields.nil?
|
86
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
87
|
+
execute_or_queue_command(command, &block)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Updates the catalog configuration.
|
91
|
+
# @param [String] name
|
92
|
+
# The fully qualified resource name of the catalog.
|
93
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog] google_cloud_recommendationengine_v1beta1_catalog_object
|
94
|
+
# @param [String] update_mask
|
95
|
+
# Optional. Indicates which fields in the provided 'recommendation_model' to
|
96
|
+
# update. If not set, will only update the catalog_item_level_config field.
|
97
|
+
# @param [String] fields
|
98
|
+
# Selector specifying which fields to include in a partial response.
|
99
|
+
# @param [String] quota_user
|
100
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
101
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
102
|
+
# @param [Google::Apis::RequestOptions] options
|
103
|
+
# Request-specific options
|
104
|
+
#
|
105
|
+
# @yield [result, err] Result & error if block supplied
|
106
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog] parsed result object
|
107
|
+
# @yieldparam err [StandardError] error object if request failed
|
108
|
+
#
|
109
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog]
|
110
|
+
#
|
111
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
112
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
113
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
114
|
+
def patch_project_location_catalog(name, google_cloud_recommendationengine_v1beta1_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
115
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
116
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog::Representation
|
117
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_catalog_object
|
118
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog::Representation
|
119
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1Catalog
|
120
|
+
command.params['name'] = name unless name.nil?
|
121
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
122
|
+
command.query['fields'] = fields unless fields.nil?
|
123
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
124
|
+
execute_or_queue_command(command, &block)
|
125
|
+
end
|
126
|
+
|
127
|
+
# Creates a catalog item.
|
128
|
+
# @param [String] parent
|
129
|
+
# Required. The parent catalog resource name, such as
|
130
|
+
# "projects/*/locations/global/catalogs/default_catalog".
|
131
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
|
132
|
+
# @param [String] fields
|
133
|
+
# Selector specifying which fields to include in a partial response.
|
134
|
+
# @param [String] quota_user
|
135
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
136
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
137
|
+
# @param [Google::Apis::RequestOptions] options
|
138
|
+
# Request-specific options
|
139
|
+
#
|
140
|
+
# @yield [result, err] Result & error if block supplied
|
141
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] parsed result object
|
142
|
+
# @yieldparam err [StandardError] error object if request failed
|
143
|
+
#
|
144
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem]
|
145
|
+
#
|
146
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
147
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
148
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
149
|
+
def create_project_location_catalog_catalog_item(parent, google_cloud_recommendationengine_v1beta1_catalog_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
150
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/catalogItems', options)
|
151
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem::Representation
|
152
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_catalog_item_object
|
153
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem::Representation
|
154
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem
|
155
|
+
command.params['parent'] = parent unless parent.nil?
|
156
|
+
command.query['fields'] = fields unless fields.nil?
|
157
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
158
|
+
execute_or_queue_command(command, &block)
|
159
|
+
end
|
160
|
+
|
161
|
+
# Deletes a catalog item.
|
162
|
+
# @param [String] name
|
163
|
+
# Required. Full resource name of catalog item, such as
|
164
|
+
# "projects/*/locations/global/catalogs/default_catalog/catalogItems/
|
165
|
+
# some_catalog_item_id".
|
166
|
+
# @param [String] fields
|
167
|
+
# Selector specifying which fields to include in a partial response.
|
168
|
+
# @param [String] quota_user
|
169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
171
|
+
# @param [Google::Apis::RequestOptions] options
|
172
|
+
# Request-specific options
|
173
|
+
#
|
174
|
+
# @yield [result, err] Result & error if block supplied
|
175
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty] parsed result object
|
176
|
+
# @yieldparam err [StandardError] error object if request failed
|
177
|
+
#
|
178
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty]
|
179
|
+
#
|
180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
183
|
+
def delete_project_location_catalog_catalog_item(name, fields: nil, quota_user: nil, options: nil, &block)
|
184
|
+
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
185
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty::Representation
|
186
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty
|
187
|
+
command.params['name'] = name unless name.nil?
|
188
|
+
command.query['fields'] = fields unless fields.nil?
|
189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
190
|
+
execute_or_queue_command(command, &block)
|
191
|
+
end
|
192
|
+
|
193
|
+
# Gets a specific catalog item.
|
194
|
+
# @param [String] name
|
195
|
+
# Required. Full resource name of catalog item, such as
|
196
|
+
# "projects/*/locations/global/catalogs/default_catalog/catalogitems/
|
197
|
+
# some_catalog_item_id".
|
198
|
+
# @param [String] fields
|
199
|
+
# Selector specifying which fields to include in a partial response.
|
200
|
+
# @param [String] quota_user
|
201
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
202
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
203
|
+
# @param [Google::Apis::RequestOptions] options
|
204
|
+
# Request-specific options
|
205
|
+
#
|
206
|
+
# @yield [result, err] Result & error if block supplied
|
207
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] parsed result object
|
208
|
+
# @yieldparam err [StandardError] error object if request failed
|
209
|
+
#
|
210
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem]
|
211
|
+
#
|
212
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
213
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
214
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
215
|
+
def get_project_location_catalog_catalog_item(name, fields: nil, quota_user: nil, options: nil, &block)
|
216
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
217
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem::Representation
|
218
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem
|
219
|
+
command.params['name'] = name unless name.nil?
|
220
|
+
command.query['fields'] = fields unless fields.nil?
|
221
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
222
|
+
execute_or_queue_command(command, &block)
|
223
|
+
end
|
224
|
+
|
225
|
+
# Method for getting the catalog items associated with item group id.
|
226
|
+
# @param [String] parent
|
227
|
+
# Required. Parent resource name of group id item, such as
|
228
|
+
# "projects/*/locations/global/catalogs/default_catalog".
|
229
|
+
# @param [String] item_group_id
|
230
|
+
# Required. Catalog item identifier for prediction results.
|
231
|
+
# @param [String] fields
|
232
|
+
# Selector specifying which fields to include in a partial response.
|
233
|
+
# @param [String] quota_user
|
234
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
235
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
236
|
+
# @param [Google::Apis::RequestOptions] options
|
237
|
+
# Request-specific options
|
238
|
+
#
|
239
|
+
# @yield [result, err] Result & error if block supplied
|
240
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse] parsed result object
|
241
|
+
# @yieldparam err [StandardError] error object if request failed
|
242
|
+
#
|
243
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse]
|
244
|
+
#
|
245
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
246
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
247
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
248
|
+
def get_project_location_catalog_catalog_item_group_id_items(parent, item_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
249
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/catalogItems:groupIdItems', options)
|
250
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse::Representation
|
251
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1GetCatalogItemsWithItemGroupIdResponse
|
252
|
+
command.params['parent'] = parent unless parent.nil?
|
253
|
+
command.query['itemGroupId'] = item_group_id unless item_group_id.nil?
|
254
|
+
command.query['fields'] = fields unless fields.nil?
|
255
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
256
|
+
execute_or_queue_command(command, &block)
|
257
|
+
end
|
258
|
+
|
259
|
+
# Bulk import of multiple catalog items. Request processing may be
|
260
|
+
# synchronous. No partial updating supported. Non-existing items will be
|
261
|
+
# created.
|
262
|
+
# Operation.response is of type ImportResponse. Note that it is
|
263
|
+
# possible for a subset of the items to be successfully updated.
|
264
|
+
# @param [String] parent
|
265
|
+
# Required. "projects/1234/locations/global/catalogs/default_catalog"
|
266
|
+
# If no updateMask is specified, requires catalogItems.create permission.
|
267
|
+
# If updateMask is specified, requires catalogItems.update permission.
|
268
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest] google_cloud_recommendationengine_v1beta1_import_catalog_items_request_object
|
269
|
+
# @param [String] fields
|
270
|
+
# Selector specifying which fields to include in a partial response.
|
271
|
+
# @param [String] quota_user
|
272
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
273
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
274
|
+
# @param [Google::Apis::RequestOptions] options
|
275
|
+
# Request-specific options
|
276
|
+
#
|
277
|
+
# @yield [result, err] Result & error if block supplied
|
278
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
279
|
+
# @yieldparam err [StandardError] error object if request failed
|
280
|
+
#
|
281
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
282
|
+
#
|
283
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
284
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
285
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
286
|
+
def import_project_location_catalog_catalog_item(parent, google_cloud_recommendationengine_v1beta1_import_catalog_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
287
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/catalogItems:import', options)
|
288
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest::Representation
|
289
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_import_catalog_items_request_object
|
290
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
291
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
292
|
+
command.params['parent'] = parent unless parent.nil?
|
293
|
+
command.query['fields'] = fields unless fields.nil?
|
294
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
295
|
+
execute_or_queue_command(command, &block)
|
296
|
+
end
|
297
|
+
|
298
|
+
# Gets a list of catalog items.
|
299
|
+
# @param [String] parent
|
300
|
+
# Required. The parent catalog resource name, such as
|
301
|
+
# "projects/*/locations/global/catalogs/default_catalog".
|
302
|
+
# @param [String] filter
|
303
|
+
# Optional. A filter to apply on the list results.
|
304
|
+
# @param [Fixnum] page_size
|
305
|
+
# Optional. Maximum number of results to return per page. If zero, the
|
306
|
+
# service will choose a reasonable default.
|
307
|
+
# @param [String] page_token
|
308
|
+
# Optional. The previous ListCatalogItemsResponse.next_page_token.
|
309
|
+
# @param [String] fields
|
310
|
+
# Selector specifying which fields to include in a partial response.
|
311
|
+
# @param [String] quota_user
|
312
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
313
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
314
|
+
# @param [Google::Apis::RequestOptions] options
|
315
|
+
# Request-specific options
|
316
|
+
#
|
317
|
+
# @yield [result, err] Result & error if block supplied
|
318
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse] parsed result object
|
319
|
+
# @yieldparam err [StandardError] error object if request failed
|
320
|
+
#
|
321
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse]
|
322
|
+
#
|
323
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
324
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
325
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
326
|
+
def list_project_location_catalog_catalog_items(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
327
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/catalogItems', options)
|
328
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse::Representation
|
329
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse
|
330
|
+
command.params['parent'] = parent unless parent.nil?
|
331
|
+
command.query['filter'] = filter unless filter.nil?
|
332
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
333
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
334
|
+
command.query['fields'] = fields unless fields.nil?
|
335
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
336
|
+
execute_or_queue_command(command, &block)
|
337
|
+
end
|
338
|
+
|
339
|
+
# Updates a catalog item. Partial updating is supported. Non-existing
|
340
|
+
# items will be created.
|
341
|
+
# @param [String] name
|
342
|
+
# Required. Full resource name of catalog item, such as
|
343
|
+
# "projects/*/locations/global/catalogs/default_catalog/catalogItems/
|
344
|
+
# some_catalog_item_id".
|
345
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] google_cloud_recommendationengine_v1beta1_catalog_item_object
|
346
|
+
# @param [String] update_mask
|
347
|
+
# Optional. Indicates which fields in the provided 'item' to update. If not
|
348
|
+
# set, will by default update all fields.
|
349
|
+
# @param [String] fields
|
350
|
+
# Selector specifying which fields to include in a partial response.
|
351
|
+
# @param [String] quota_user
|
352
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
353
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
354
|
+
# @param [Google::Apis::RequestOptions] options
|
355
|
+
# Request-specific options
|
356
|
+
#
|
357
|
+
# @yield [result, err] Result & error if block supplied
|
358
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem] parsed result object
|
359
|
+
# @yieldparam err [StandardError] error object if request failed
|
360
|
+
#
|
361
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem]
|
362
|
+
#
|
363
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
364
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
365
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
366
|
+
def patch_project_location_catalog_catalog_item(name, google_cloud_recommendationengine_v1beta1_catalog_item_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
367
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
368
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem::Representation
|
369
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_catalog_item_object
|
370
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem::Representation
|
371
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CatalogItem
|
372
|
+
command.params['name'] = name unless name.nil?
|
373
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
374
|
+
command.query['fields'] = fields unless fields.nil?
|
375
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
376
|
+
execute_or_queue_command(command, &block)
|
377
|
+
end
|
378
|
+
|
379
|
+
# Gets the latest state of a long-running operation. Clients can use this
|
380
|
+
# method to poll the operation result at intervals as recommended by the API
|
381
|
+
# service.
|
382
|
+
# @param [String] name
|
383
|
+
# The name of the operation resource.
|
384
|
+
# @param [String] fields
|
385
|
+
# Selector specifying which fields to include in a partial response.
|
386
|
+
# @param [String] quota_user
|
387
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
388
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
389
|
+
# @param [Google::Apis::RequestOptions] options
|
390
|
+
# Request-specific options
|
391
|
+
#
|
392
|
+
# @yield [result, err] Result & error if block supplied
|
393
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
394
|
+
# @yieldparam err [StandardError] error object if request failed
|
395
|
+
#
|
396
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
397
|
+
#
|
398
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
399
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
400
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
401
|
+
def get_project_location_catalog_event_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
402
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
403
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
404
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
405
|
+
command.params['name'] = name unless name.nil?
|
406
|
+
command.query['fields'] = fields unless fields.nil?
|
407
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
408
|
+
execute_or_queue_command(command, &block)
|
409
|
+
end
|
410
|
+
|
411
|
+
# Lists operations that match the specified filter in the request. If the
|
412
|
+
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
413
|
+
# NOTE: the `name` binding allows API services to override the binding
|
414
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
415
|
+
# override the binding, API services can add a binding such as
|
416
|
+
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
417
|
+
# For backwards compatibility, the default name includes the operations
|
418
|
+
# collection id, however overriding users must ensure the name binding
|
419
|
+
# is the parent resource, without the operations collection id.
|
420
|
+
# @param [String] name
|
421
|
+
# The name of the operation's parent resource.
|
422
|
+
# @param [String] filter
|
423
|
+
# The standard list filter.
|
424
|
+
# @param [Fixnum] page_size
|
425
|
+
# The standard list page size.
|
426
|
+
# @param [String] page_token
|
427
|
+
# The standard list page token.
|
428
|
+
# @param [String] fields
|
429
|
+
# Selector specifying which fields to include in a partial response.
|
430
|
+
# @param [String] quota_user
|
431
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
432
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
433
|
+
# @param [Google::Apis::RequestOptions] options
|
434
|
+
# Request-specific options
|
435
|
+
#
|
436
|
+
# @yield [result, err] Result & error if block supplied
|
437
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse] parsed result object
|
438
|
+
# @yieldparam err [StandardError] error object if request failed
|
439
|
+
#
|
440
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse]
|
441
|
+
#
|
442
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
443
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
444
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
445
|
+
def list_project_location_catalog_event_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
446
|
+
command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
|
447
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse::Representation
|
448
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse
|
449
|
+
command.params['name'] = name unless name.nil?
|
450
|
+
command.query['filter'] = filter unless filter.nil?
|
451
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
452
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
453
|
+
command.query['fields'] = fields unless fields.nil?
|
454
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
455
|
+
execute_or_queue_command(command, &block)
|
456
|
+
end
|
457
|
+
|
458
|
+
# Makes a recommendation prediction. If using API Key based authentication,
|
459
|
+
# the API Key must be registered using the
|
460
|
+
# PredictionApiKeyRegistry
|
461
|
+
# service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
|
462
|
+
# @param [String] name
|
463
|
+
# Required. Full resource name of the format:
|
464
|
+
# `name=projects/*/locations/global/catalogs/default_catalog/eventStores/
|
465
|
+
# default_event_store/placements/*`
|
466
|
+
# The id of the recommendation engine placement. This id is used to identify
|
467
|
+
# the set of models that will be used to make the prediction.
|
468
|
+
# We currently support three placements with the following IDs by default:
|
469
|
+
# * `shopping_cart`: Predicts items frequently bought together with one or
|
470
|
+
# more catalog items in the same shopping session. Commonly displayed after
|
471
|
+
# `add-to-cart` events, on product detail pages, or on the shopping cart
|
472
|
+
# page.
|
473
|
+
# * `home_page`: Predicts the next product that a user will most likely
|
474
|
+
# engage with or purchase based on the shopping or viewing history of the
|
475
|
+
# specified `userId` or `visitorId`. For example - Recommendations for you.
|
476
|
+
# * `product_detail`: Predicts the next product that a user will most likely
|
477
|
+
# engage with or purchase. The prediction is based on the shopping or
|
478
|
+
# viewing history of the specified `userId` or `visitorId` and its
|
479
|
+
# relevance to a specified `CatalogItem`. Typically used on product detail
|
480
|
+
# pages. For example - More items like this.
|
481
|
+
# * `recently_viewed_default`: Returns up to 75 items recently viewed by the
|
482
|
+
# specified `userId` or `visitorId`, most recent ones first. Returns
|
483
|
+
# nothing if neither of them has viewed any items yet. For example -
|
484
|
+
# Recently viewed.
|
485
|
+
# The full list of available placements can be seen at
|
486
|
+
# https://console.cloud.google.com/recommendation/datafeeds/default_catalog/
|
487
|
+
# dashboard
|
488
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictRequest] google_cloud_recommendationengine_v1beta1_predict_request_object
|
489
|
+
# @param [String] fields
|
490
|
+
# Selector specifying which fields to include in a partial response.
|
491
|
+
# @param [String] quota_user
|
492
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
493
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
494
|
+
# @param [Google::Apis::RequestOptions] options
|
495
|
+
# Request-specific options
|
496
|
+
#
|
497
|
+
# @yield [result, err] Result & error if block supplied
|
498
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponse] parsed result object
|
499
|
+
# @yieldparam err [StandardError] error object if request failed
|
500
|
+
#
|
501
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponse]
|
502
|
+
#
|
503
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
504
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
505
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
506
|
+
def predict_project_location_catalog_event_store_placement(name, google_cloud_recommendationengine_v1beta1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
507
|
+
command = make_simple_command(:post, 'v1beta1/{+name}:predict', options)
|
508
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictRequest::Representation
|
509
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_predict_request_object
|
510
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponse::Representation
|
511
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponse
|
512
|
+
command.params['name'] = name unless name.nil?
|
513
|
+
command.query['fields'] = fields unless fields.nil?
|
514
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
515
|
+
execute_or_queue_command(command, &block)
|
516
|
+
end
|
517
|
+
|
518
|
+
# Register an API key for use with predict method.
|
519
|
+
# @param [String] parent
|
520
|
+
# Required. The parent resource path.
|
521
|
+
# "projects/*/locations/global/catalogs/default_catalog/eventStores/
|
522
|
+
# default_event_store".
|
523
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest] google_cloud_recommendationengine_v1beta1_create_prediction_api_key_registration_request_object
|
524
|
+
# @param [String] fields
|
525
|
+
# Selector specifying which fields to include in a partial response.
|
526
|
+
# @param [String] quota_user
|
527
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
528
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
529
|
+
# @param [Google::Apis::RequestOptions] options
|
530
|
+
# Request-specific options
|
531
|
+
#
|
532
|
+
# @yield [result, err] Result & error if block supplied
|
533
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration] parsed result object
|
534
|
+
# @yieldparam err [StandardError] error object if request failed
|
535
|
+
#
|
536
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration]
|
537
|
+
#
|
538
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
539
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
540
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
541
|
+
def create_project_location_catalog_event_store_prediction_api_key_registration(parent, google_cloud_recommendationengine_v1beta1_create_prediction_api_key_registration_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
542
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/predictionApiKeyRegistrations', options)
|
543
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest::Representation
|
544
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_create_prediction_api_key_registration_request_object
|
545
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration::Representation
|
546
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration
|
547
|
+
command.params['parent'] = parent unless parent.nil?
|
548
|
+
command.query['fields'] = fields unless fields.nil?
|
549
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
550
|
+
execute_or_queue_command(command, &block)
|
551
|
+
end
|
552
|
+
|
553
|
+
# Unregister an apiKey from using for predict method.
|
554
|
+
# @param [String] name
|
555
|
+
# Required. The API key to unregister including full resource path.
|
556
|
+
# "projects/*/locations/global/catalogs/default_catalog/eventStores/
|
557
|
+
# default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
|
558
|
+
# @param [String] fields
|
559
|
+
# Selector specifying which fields to include in a partial response.
|
560
|
+
# @param [String] quota_user
|
561
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
562
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
563
|
+
# @param [Google::Apis::RequestOptions] options
|
564
|
+
# Request-specific options
|
565
|
+
#
|
566
|
+
# @yield [result, err] Result & error if block supplied
|
567
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty] parsed result object
|
568
|
+
# @yieldparam err [StandardError] error object if request failed
|
569
|
+
#
|
570
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty]
|
571
|
+
#
|
572
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
573
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
574
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
575
|
+
def delete_project_location_catalog_event_store_prediction_api_key_registration(name, fields: nil, quota_user: nil, options: nil, &block)
|
576
|
+
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
577
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty::Representation
|
578
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleProtobufEmpty
|
579
|
+
command.params['name'] = name unless name.nil?
|
580
|
+
command.query['fields'] = fields unless fields.nil?
|
581
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
582
|
+
execute_or_queue_command(command, &block)
|
583
|
+
end
|
584
|
+
|
585
|
+
# List the registered apiKeys for use with predict method.
|
586
|
+
# @param [String] parent
|
587
|
+
# Required. The parent placement resource name such as
|
588
|
+
# "projects/1234/locations/global/catalogs/default_catalog/eventStores/
|
589
|
+
# default_event_store"
|
590
|
+
# @param [Fixnum] page_size
|
591
|
+
# Optional. Maximum number of results to return per page. If unset, the
|
592
|
+
# service will choose a reasonable default.
|
593
|
+
# @param [String] page_token
|
594
|
+
# Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.
|
595
|
+
# @param [String] fields
|
596
|
+
# Selector specifying which fields to include in a partial response.
|
597
|
+
# @param [String] quota_user
|
598
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
599
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
600
|
+
# @param [Google::Apis::RequestOptions] options
|
601
|
+
# Request-specific options
|
602
|
+
#
|
603
|
+
# @yield [result, err] Result & error if block supplied
|
604
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse] parsed result object
|
605
|
+
# @yieldparam err [StandardError] error object if request failed
|
606
|
+
#
|
607
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse]
|
608
|
+
#
|
609
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
610
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
611
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
612
|
+
def list_project_location_catalog_event_store_prediction_api_key_registrations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
613
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/predictionApiKeyRegistrations', options)
|
614
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse::Representation
|
615
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse
|
616
|
+
command.params['parent'] = parent unless parent.nil?
|
617
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
618
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
619
|
+
command.query['fields'] = fields unless fields.nil?
|
620
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
621
|
+
execute_or_queue_command(command, &block)
|
622
|
+
end
|
623
|
+
|
624
|
+
# Writes a single user event from the browser. This uses a GET request to
|
625
|
+
# due to browser restriction of POST-ing to a 3rd party domain.
|
626
|
+
# This method is used only by the Recommendations AI JavaScript pixel.
|
627
|
+
# Users should not call this method directly.
|
628
|
+
# @param [String] parent
|
629
|
+
# Required. The parent eventStore name, such as
|
630
|
+
# "projects/1234/locations/global/catalogs/default_catalog/eventStores/
|
631
|
+
# default_event_store".
|
632
|
+
# @param [Fixnum] ets
|
633
|
+
# Optional. The event timestamp in milliseconds. This prevents browser caching
|
634
|
+
# of
|
635
|
+
# otherwise identical get requests. The name is abbreviated to reduce the
|
636
|
+
# payload bytes.
|
637
|
+
# @param [String] uri
|
638
|
+
# Optional. The url including cgi-parameters but excluding the hash fragment.
|
639
|
+
# The URL
|
640
|
+
# must be truncated to 1.5K bytes to conservatively be under the 2K bytes.
|
641
|
+
# This is often more useful than the referer url, because many browsers only
|
642
|
+
# send the domain for 3rd party requests.
|
643
|
+
# @param [String] user_event
|
644
|
+
# Required. URL encoded UserEvent proto.
|
645
|
+
# @param [String] fields
|
646
|
+
# Selector specifying which fields to include in a partial response.
|
647
|
+
# @param [String] quota_user
|
648
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
649
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
650
|
+
# @param [Google::Apis::RequestOptions] options
|
651
|
+
# Request-specific options
|
652
|
+
#
|
653
|
+
# @yield [result, err] Result & error if block supplied
|
654
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleApiHttpBody] parsed result object
|
655
|
+
# @yieldparam err [StandardError] error object if request failed
|
656
|
+
#
|
657
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleApiHttpBody]
|
658
|
+
#
|
659
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
660
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
661
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
662
|
+
def collect_project_location_catalog_event_store_user_event(parent, ets: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
|
663
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/userEvents:collect', options)
|
664
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleApiHttpBody::Representation
|
665
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleApiHttpBody
|
666
|
+
command.params['parent'] = parent unless parent.nil?
|
667
|
+
command.query['ets'] = ets unless ets.nil?
|
668
|
+
command.query['uri'] = uri unless uri.nil?
|
669
|
+
command.query['userEvent'] = user_event unless user_event.nil?
|
670
|
+
command.query['fields'] = fields unless fields.nil?
|
671
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
672
|
+
execute_or_queue_command(command, &block)
|
673
|
+
end
|
674
|
+
|
675
|
+
# Bulk import of User events. Request processing might be
|
676
|
+
# synchronous. Events that already exist are skipped.
|
677
|
+
# Use this method for backfilling historical user events.
|
678
|
+
# Operation.response is of type ImportResponse. Note that it is
|
679
|
+
# possible for a subset of the items to be successfully inserted.
|
680
|
+
# Operation.metadata is of type ImportMetadata.
|
681
|
+
# @param [String] parent
|
682
|
+
# Required. "projects/1234/locations/global/catalogs/default_catalog/eventStores/
|
683
|
+
# default_event_store"
|
684
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest] google_cloud_recommendationengine_v1beta1_import_user_events_request_object
|
685
|
+
# @param [String] fields
|
686
|
+
# Selector specifying which fields to include in a partial response.
|
687
|
+
# @param [String] quota_user
|
688
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
689
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
690
|
+
# @param [Google::Apis::RequestOptions] options
|
691
|
+
# Request-specific options
|
692
|
+
#
|
693
|
+
# @yield [result, err] Result & error if block supplied
|
694
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
695
|
+
# @yieldparam err [StandardError] error object if request failed
|
696
|
+
#
|
697
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
698
|
+
#
|
699
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
700
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
701
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
702
|
+
def import_project_location_catalog_event_store_user_event(parent, google_cloud_recommendationengine_v1beta1_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
703
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/userEvents:import', options)
|
704
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest::Representation
|
705
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_import_user_events_request_object
|
706
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
707
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
708
|
+
command.params['parent'] = parent unless parent.nil?
|
709
|
+
command.query['fields'] = fields unless fields.nil?
|
710
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
711
|
+
execute_or_queue_command(command, &block)
|
712
|
+
end
|
713
|
+
|
714
|
+
# Gets a list of user events within a time range, with potential filtering.
|
715
|
+
# The method does not list unjoined user events.
|
716
|
+
# Unjoined user event definition: when a user event is ingested from
|
717
|
+
# Recommendations AI User Event APIs, the catalog item included in the user
|
718
|
+
# event is connected with the current catalog. If a catalog item of the
|
719
|
+
# ingested event is not in the current catalog, it could lead to degraded
|
720
|
+
# model quality. This is called an unjoined event.
|
721
|
+
# @param [String] parent
|
722
|
+
# Required. The parent eventStore resource name, such as
|
723
|
+
# "projects/*/locations/*/catalogs/default_catalog/eventStores/
|
724
|
+
# default_event_store".
|
725
|
+
# @param [String] filter
|
726
|
+
# Optional. Filtering expression to specify restrictions over
|
727
|
+
# returned events. This is a sequence of terms, where each term applies some
|
728
|
+
# kind of a restriction to the returned user events. Use this expression to
|
729
|
+
# restrict results to a specific time range, or filter events by eventType.
|
730
|
+
# eg: eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems
|
731
|
+
# eventTime<"2012-04-23T18:25:43.511Z" eventType=search
|
732
|
+
# We expect only 3 types of fields:
|
733
|
+
# * eventTime: this can be specified a maximum of 2 times, once with a
|
734
|
+
# less than operator and once with a greater than operator. The
|
735
|
+
# eventTime restrict should result in one contiguous valid eventTime
|
736
|
+
# range.
|
737
|
+
# * eventType: only 1 eventType restriction can be specified.
|
738
|
+
# * eventsMissingCatalogItems: specififying this will restrict results
|
739
|
+
# to events for which catalog items were not found in the catalog. The
|
740
|
+
# default behavior is to return only those events for which catalog
|
741
|
+
# items were found.
|
742
|
+
# Some examples of valid filters expressions:
|
743
|
+
# * Example 1: eventTime > "2012-04-23T18:25:43.511Z"
|
744
|
+
# eventTime < "2012-04-23T18:30:43.511Z"
|
745
|
+
# * Example 2: eventTime > "2012-04-23T18:25:43.511Z"
|
746
|
+
# eventType = detail-page-view
|
747
|
+
# * Example 3: eventsMissingCatalogItems
|
748
|
+
# eventType = search eventTime < "2018-04-23T18:30:43.511Z"
|
749
|
+
# * Example 4: eventTime > "2012-04-23T18:25:43.511Z"
|
750
|
+
# * Example 5: eventType = search
|
751
|
+
# * Example 6: eventsMissingCatalogItems
|
752
|
+
# @param [Fixnum] page_size
|
753
|
+
# Optional. Maximum number of results to return per page. If zero, the
|
754
|
+
# service will choose a reasonable default.
|
755
|
+
# @param [String] page_token
|
756
|
+
# Optional. The previous ListUserEventsResponse.next_page_token.
|
757
|
+
# @param [String] fields
|
758
|
+
# Selector specifying which fields to include in a partial response.
|
759
|
+
# @param [String] quota_user
|
760
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
761
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
762
|
+
# @param [Google::Apis::RequestOptions] options
|
763
|
+
# Request-specific options
|
764
|
+
#
|
765
|
+
# @yield [result, err] Result & error if block supplied
|
766
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListUserEventsResponse] parsed result object
|
767
|
+
# @yieldparam err [StandardError] error object if request failed
|
768
|
+
#
|
769
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListUserEventsResponse]
|
770
|
+
#
|
771
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
772
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
773
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
774
|
+
def list_project_location_catalog_event_store_user_events(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
775
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/userEvents', options)
|
776
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListUserEventsResponse::Representation
|
777
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1ListUserEventsResponse
|
778
|
+
command.params['parent'] = parent unless parent.nil?
|
779
|
+
command.query['filter'] = filter unless filter.nil?
|
780
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
781
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
782
|
+
command.query['fields'] = fields unless fields.nil?
|
783
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
784
|
+
execute_or_queue_command(command, &block)
|
785
|
+
end
|
786
|
+
|
787
|
+
# Deletes permanently all user events specified by the filter provided.
|
788
|
+
# Depending on the number of events specified by the filter, this operation
|
789
|
+
# could take hours or days to complete. To test a filter, use the list
|
790
|
+
# command first.
|
791
|
+
# @param [String] parent
|
792
|
+
# Required. The resource name of the event_store under which the events are
|
793
|
+
# created. The format is
|
794
|
+
# "projects/$`projectId`/locations/global/catalogs/$`catalogId`/eventStores/$`
|
795
|
+
# eventStoreId`"
|
796
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest] google_cloud_recommendationengine_v1beta1_purge_user_events_request_object
|
797
|
+
# @param [String] fields
|
798
|
+
# Selector specifying which fields to include in a partial response.
|
799
|
+
# @param [String] quota_user
|
800
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
801
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
802
|
+
# @param [Google::Apis::RequestOptions] options
|
803
|
+
# Request-specific options
|
804
|
+
#
|
805
|
+
# @yield [result, err] Result & error if block supplied
|
806
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
807
|
+
# @yieldparam err [StandardError] error object if request failed
|
808
|
+
#
|
809
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
810
|
+
#
|
811
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
812
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
813
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
814
|
+
def purge_project_location_catalog_event_store_user_event(parent, google_cloud_recommendationengine_v1beta1_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
815
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/userEvents:purge', options)
|
816
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest::Representation
|
817
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_purge_user_events_request_object
|
818
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
819
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
820
|
+
command.params['parent'] = parent unless parent.nil?
|
821
|
+
command.query['fields'] = fields unless fields.nil?
|
822
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
823
|
+
execute_or_queue_command(command, &block)
|
824
|
+
end
|
825
|
+
|
826
|
+
# Triggers a user event rejoin operation with latest catalog data. Events
|
827
|
+
# will not be annotated with detailed catalog information if catalog item is
|
828
|
+
# missing at the time the user event is ingested, and these events are stored
|
829
|
+
# as unjoined events with a limited usage on training and serving. This API
|
830
|
+
# can be used to trigger a 'join' operation on specified events with latest
|
831
|
+
# version of catalog items. It can also be used to correct events joined with
|
832
|
+
# wrong catalog items.
|
833
|
+
# @param [String] parent
|
834
|
+
# Required. Full resource name of user event, such as
|
835
|
+
# "projects/*/locations/*/catalogs/default_catalog/eventStores/
|
836
|
+
# default_event_store".
|
837
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest] google_cloud_recommendationengine_v1beta1_rejoin_user_events_request_object
|
838
|
+
# @param [String] fields
|
839
|
+
# Selector specifying which fields to include in a partial response.
|
840
|
+
# @param [String] quota_user
|
841
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
842
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
843
|
+
# @param [Google::Apis::RequestOptions] options
|
844
|
+
# Request-specific options
|
845
|
+
#
|
846
|
+
# @yield [result, err] Result & error if block supplied
|
847
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
848
|
+
# @yieldparam err [StandardError] error object if request failed
|
849
|
+
#
|
850
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
851
|
+
#
|
852
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
853
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
854
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
855
|
+
def rejoin_project_location_catalog_event_store_user_event(parent, google_cloud_recommendationengine_v1beta1_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
856
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/userEvents:rejoin', options)
|
857
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest::Representation
|
858
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_rejoin_user_events_request_object
|
859
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
860
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
861
|
+
command.params['parent'] = parent unless parent.nil?
|
862
|
+
command.query['fields'] = fields unless fields.nil?
|
863
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
864
|
+
execute_or_queue_command(command, &block)
|
865
|
+
end
|
866
|
+
|
867
|
+
# Writes a single user event.
|
868
|
+
# @param [String] parent
|
869
|
+
# Required. The parent eventStore resource name, such as
|
870
|
+
# "projects/1234/locations/global/catalogs/default_catalog/eventStores/
|
871
|
+
# default_event_store".
|
872
|
+
# @param [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent] google_cloud_recommendationengine_v1beta1_user_event_object
|
873
|
+
# @param [String] fields
|
874
|
+
# Selector specifying which fields to include in a partial response.
|
875
|
+
# @param [String] quota_user
|
876
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
877
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
878
|
+
# @param [Google::Apis::RequestOptions] options
|
879
|
+
# Request-specific options
|
880
|
+
#
|
881
|
+
# @yield [result, err] Result & error if block supplied
|
882
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent] parsed result object
|
883
|
+
# @yieldparam err [StandardError] error object if request failed
|
884
|
+
#
|
885
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent]
|
886
|
+
#
|
887
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
888
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
889
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
890
|
+
def write_project_location_catalog_event_store_user_event(parent, google_cloud_recommendationengine_v1beta1_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
891
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/userEvents:write', options)
|
892
|
+
command.request_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent::Representation
|
893
|
+
command.request_object = google_cloud_recommendationengine_v1beta1_user_event_object
|
894
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent::Representation
|
895
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent
|
896
|
+
command.params['parent'] = parent unless parent.nil?
|
897
|
+
command.query['fields'] = fields unless fields.nil?
|
898
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
899
|
+
execute_or_queue_command(command, &block)
|
900
|
+
end
|
901
|
+
|
902
|
+
# Gets the latest state of a long-running operation. Clients can use this
|
903
|
+
# method to poll the operation result at intervals as recommended by the API
|
904
|
+
# service.
|
905
|
+
# @param [String] name
|
906
|
+
# The name of the operation resource.
|
907
|
+
# @param [String] fields
|
908
|
+
# Selector specifying which fields to include in a partial response.
|
909
|
+
# @param [String] quota_user
|
910
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
911
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
912
|
+
# @param [Google::Apis::RequestOptions] options
|
913
|
+
# Request-specific options
|
914
|
+
#
|
915
|
+
# @yield [result, err] Result & error if block supplied
|
916
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation] parsed result object
|
917
|
+
# @yieldparam err [StandardError] error object if request failed
|
918
|
+
#
|
919
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation]
|
920
|
+
#
|
921
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
922
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
923
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
924
|
+
def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
925
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
926
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation::Representation
|
927
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningOperation
|
928
|
+
command.params['name'] = name unless name.nil?
|
929
|
+
command.query['fields'] = fields unless fields.nil?
|
930
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
931
|
+
execute_or_queue_command(command, &block)
|
932
|
+
end
|
933
|
+
|
934
|
+
# Lists operations that match the specified filter in the request. If the
|
935
|
+
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
936
|
+
# NOTE: the `name` binding allows API services to override the binding
|
937
|
+
# to use different resource name schemes, such as `users/*/operations`. To
|
938
|
+
# override the binding, API services can add a binding such as
|
939
|
+
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
940
|
+
# For backwards compatibility, the default name includes the operations
|
941
|
+
# collection id, however overriding users must ensure the name binding
|
942
|
+
# is the parent resource, without the operations collection id.
|
943
|
+
# @param [String] name
|
944
|
+
# The name of the operation's parent resource.
|
945
|
+
# @param [String] filter
|
946
|
+
# The standard list filter.
|
947
|
+
# @param [Fixnum] page_size
|
948
|
+
# The standard list page size.
|
949
|
+
# @param [String] page_token
|
950
|
+
# The standard list page token.
|
951
|
+
# @param [String] fields
|
952
|
+
# Selector specifying which fields to include in a partial response.
|
953
|
+
# @param [String] quota_user
|
954
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
955
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
956
|
+
# @param [Google::Apis::RequestOptions] options
|
957
|
+
# Request-specific options
|
958
|
+
#
|
959
|
+
# @yield [result, err] Result & error if block supplied
|
960
|
+
# @yieldparam result [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse] parsed result object
|
961
|
+
# @yieldparam err [StandardError] error object if request failed
|
962
|
+
#
|
963
|
+
# @return [Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse]
|
964
|
+
#
|
965
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
966
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
967
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
968
|
+
def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
969
|
+
command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
|
970
|
+
command.response_representation = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse::Representation
|
971
|
+
command.response_class = Google::Apis::RecommendationengineV1beta1::GoogleLongrunningListOperationsResponse
|
972
|
+
command.params['name'] = name unless name.nil?
|
973
|
+
command.query['filter'] = filter unless filter.nil?
|
974
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
975
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
976
|
+
command.query['fields'] = fields unless fields.nil?
|
977
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
978
|
+
execute_or_queue_command(command, &block)
|
979
|
+
end
|
980
|
+
|
981
|
+
protected
|
982
|
+
|
983
|
+
def apply_command_defaults(command)
|
984
|
+
command.query['key'] = key unless key.nil?
|
985
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
986
|
+
end
|
987
|
+
end
|
988
|
+
end
|
989
|
+
end
|
990
|
+
end
|