google-apis-recommender_v1 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 14fd323be59984e99e9863b90528ec5f4b1a4b25c907b3ce568c44cf0876ca2b
4
- data.tar.gz: 3ee8667cd09dfe5baaaab2034f255d44d68eac79e79591b33a84b3280186b792
3
+ metadata.gz: 65a8b5c7cd2f3e0df4f704594e4d7f3abcd1a7dd3d91bea245c75fd673e31dd0
4
+ data.tar.gz: b1a3a9d3787c71221d25f86540b14363c239082cd4f2f221b6a84fe72e86fac2
5
5
  SHA512:
6
- metadata.gz: 28b68f982ba69a6e0d468b67c0a6e7ed8a5a4484747e2567fb761bf2ed50de0a3303e3a9358f5f25717f7b0b4cd3018723dc0a10d976e8fb8a22595f3fed5dfb
7
- data.tar.gz: 5726184f06e1b87f4f831fc901e429b1d12034cdaff75c56a2bc0a4a8dc4d9d3010dba5611ff53e3191340849d84ade9c5d792cc4da147585ed1b0722f4696d6
6
+ metadata.gz: 319c64f7f91fc8d42dd5422b79d1d60331ed7c53889702f13e2f1e1eba24081bef1d09fcc8b565217ec30c56b88e0ac636dd1e5287c185ef38ed835c4a46c71c
7
+ data.tar.gz: 3fa4f2a6794666039e466cfd5ba24868f1a45d623b1074faad9d858205ca559451cfc8757cf1022f1323fdba881e3edc2c547122e1370f2f994fbb40829c935f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-recommender_v1
2
2
 
3
+ ### v0.2.0 (2021-01-21)
4
+
5
+ * Regenerated from discovery document revision 20210118
6
+ * Regenerated using generator version 0.1.2
7
+
3
8
  ### v0.1.0 (2021-01-07)
4
9
 
5
10
  * Regenerated using generator version 0.1.1
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RecommenderV1
18
18
  # Version of the google-apis-recommender_v1 gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.2.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.1.2"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201113"
25
+ REVISION = "20210118"
26
26
  end
27
27
  end
28
28
  end
@@ -49,6 +49,957 @@ module Google
49
49
  @batch_path = 'batch'
50
50
  end
51
51
 
52
+ # Gets the requested insight. Requires the recommender.*.get IAM permission for
53
+ # the specified insight type.
54
+ # @param [String] name
55
+ # Required. Name of the insight.
56
+ # @param [String] fields
57
+ # Selector specifying which fields to include in a partial response.
58
+ # @param [String] quota_user
59
+ # Available to use for quota purposes for server-side applications. Can be any
60
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
61
+ # @param [Google::Apis::RequestOptions] options
62
+ # Request-specific options
63
+ #
64
+ # @yield [result, err] Result & error if block supplied
65
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
66
+ # @yieldparam err [StandardError] error object if request failed
67
+ #
68
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
69
+ #
70
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
71
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
72
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
73
+ def get_billing_account_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
74
+ command = make_simple_command(:get, 'v1/{+name}', options)
75
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
76
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
77
+ command.params['name'] = name unless name.nil?
78
+ command.query['fields'] = fields unless fields.nil?
79
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
80
+ execute_or_queue_command(command, &block)
81
+ end
82
+
83
+ # Lists insights for a Cloud project. Requires the recommender.*.list IAM
84
+ # permission for the specified insight type.
85
+ # @param [String] parent
86
+ # Required. The container resource on which to execute the request. Acceptable
87
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[
88
+ # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
89
+ # com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https:/
90
+ # /cloud.google.com/recommender/docs/insights/insight-types.)
91
+ # @param [String] filter
92
+ # Optional. Filter expression to restrict the insights returned. Supported
93
+ # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
94
+ # @param [Fixnum] page_size
95
+ # Optional. The maximum number of results to return from this request. Non-
96
+ # positive values are ignored. If not specified, the server will determine the
97
+ # number of results to return.
98
+ # @param [String] page_token
99
+ # Optional. If present, retrieves the next batch of results from the preceding
100
+ # call to this method. `page_token` must be the value of `next_page_token` from
101
+ # the previous response. The values of other method parameters must be identical
102
+ # to those in the previous call.
103
+ # @param [String] fields
104
+ # Selector specifying which fields to include in a partial response.
105
+ # @param [String] quota_user
106
+ # Available to use for quota purposes for server-side applications. Can be any
107
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
108
+ # @param [Google::Apis::RequestOptions] options
109
+ # Request-specific options
110
+ #
111
+ # @yield [result, err] Result & error if block supplied
112
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse] parsed result object
113
+ # @yieldparam err [StandardError] error object if request failed
114
+ #
115
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse]
116
+ #
117
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
118
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
119
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
120
+ def list_billing_account_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
121
+ command = make_simple_command(:get, 'v1/{+parent}/insights', options)
122
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
123
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
124
+ command.params['parent'] = parent unless parent.nil?
125
+ command.query['filter'] = filter unless filter.nil?
126
+ command.query['pageSize'] = page_size unless page_size.nil?
127
+ command.query['pageToken'] = page_token unless page_token.nil?
128
+ command.query['fields'] = fields unless fields.nil?
129
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
130
+ execute_or_queue_command(command, &block)
131
+ end
132
+
133
+ # Marks the Insight State as Accepted. Users can use this method to indicate to
134
+ # the Recommender API that they have applied some action based on the insight.
135
+ # This stops the insight content from being updated. MarkInsightAccepted can be
136
+ # applied to insights in ACTIVE state. Requires the recommender.*.update IAM
137
+ # permission for the specified insight.
138
+ # @param [String] name
139
+ # Required. Name of the insight.
140
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest] google_cloud_recommender_v1_mark_insight_accepted_request_object
141
+ # @param [String] fields
142
+ # Selector specifying which fields to include in a partial response.
143
+ # @param [String] quota_user
144
+ # Available to use for quota purposes for server-side applications. Can be any
145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
146
+ # @param [Google::Apis::RequestOptions] options
147
+ # Request-specific options
148
+ #
149
+ # @yield [result, err] Result & error if block supplied
150
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
151
+ # @yieldparam err [StandardError] error object if request failed
152
+ #
153
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
154
+ #
155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
158
+ def mark_billing_account_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
159
+ command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
160
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
161
+ command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
162
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
163
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
164
+ command.params['name'] = name unless name.nil?
165
+ command.query['fields'] = fields unless fields.nil?
166
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
167
+ execute_or_queue_command(command, &block)
168
+ end
169
+
170
+ # Gets the requested recommendation. Requires the recommender.*.get IAM
171
+ # permission for the specified recommender.
172
+ # @param [String] name
173
+ # Required. Name of the recommendation.
174
+ # @param [String] fields
175
+ # Selector specifying which fields to include in a partial response.
176
+ # @param [String] quota_user
177
+ # Available to use for quota purposes for server-side applications. Can be any
178
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
179
+ # @param [Google::Apis::RequestOptions] options
180
+ # Request-specific options
181
+ #
182
+ # @yield [result, err] Result & error if block supplied
183
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
184
+ # @yieldparam err [StandardError] error object if request failed
185
+ #
186
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
187
+ #
188
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
189
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
190
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
191
+ def get_billing_account_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
192
+ command = make_simple_command(:get, 'v1/{+name}', options)
193
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
194
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
195
+ command.params['name'] = name unless name.nil?
196
+ command.query['fields'] = fields unless fields.nil?
197
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
198
+ execute_or_queue_command(command, &block)
199
+ end
200
+
201
+ # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM
202
+ # permission for the specified recommender.
203
+ # @param [String] parent
204
+ # Required. The container resource on which to execute the request. Acceptable
205
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[
206
+ # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
207
+ # com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://
208
+ # cloud.google.com/recommender/docs/recommenders.
209
+ # @param [String] filter
210
+ # Filter expression to restrict the recommendations returned. Supported filter
211
+ # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:
212
+ # "FAILED"
213
+ # @param [Fixnum] page_size
214
+ # Optional. The maximum number of results to return from this request. Non-
215
+ # positive values are ignored. If not specified, the server will determine the
216
+ # number of results to return.
217
+ # @param [String] page_token
218
+ # Optional. If present, retrieves the next batch of results from the preceding
219
+ # call to this method. `page_token` must be the value of `next_page_token` from
220
+ # the previous response. The values of other method parameters must be identical
221
+ # to those in the previous call.
222
+ # @param [String] fields
223
+ # Selector specifying which fields to include in a partial response.
224
+ # @param [String] quota_user
225
+ # Available to use for quota purposes for server-side applications. Can be any
226
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
227
+ # @param [Google::Apis::RequestOptions] options
228
+ # Request-specific options
229
+ #
230
+ # @yield [result, err] Result & error if block supplied
231
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] parsed result object
232
+ # @yieldparam err [StandardError] error object if request failed
233
+ #
234
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse]
235
+ #
236
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
237
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
238
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
239
+ def list_billing_account_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
240
+ command = make_simple_command(:get, 'v1/{+parent}/recommendations', options)
241
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
242
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
243
+ command.params['parent'] = parent unless parent.nil?
244
+ command.query['filter'] = filter unless filter.nil?
245
+ command.query['pageSize'] = page_size unless page_size.nil?
246
+ command.query['pageToken'] = page_token unless page_token.nil?
247
+ command.query['fields'] = fields unless fields.nil?
248
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
249
+ execute_or_queue_command(command, &block)
250
+ end
251
+
252
+ # Marks the Recommendation State as Claimed. Users can use this method to
253
+ # indicate to the Recommender API that they are starting to apply the
254
+ # recommendation themselves. This stops the recommendation content from being
255
+ # updated. Associated insights are frozen and placed in the ACCEPTED state.
256
+ # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
257
+ # SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM
258
+ # permission for the specified recommender.
259
+ # @param [String] name
260
+ # Required. Name of the recommendation.
261
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_request_object
262
+ # @param [String] fields
263
+ # Selector specifying which fields to include in a partial response.
264
+ # @param [String] quota_user
265
+ # Available to use for quota purposes for server-side applications. Can be any
266
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
267
+ # @param [Google::Apis::RequestOptions] options
268
+ # Request-specific options
269
+ #
270
+ # @yield [result, err] Result & error if block supplied
271
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
272
+ # @yieldparam err [StandardError] error object if request failed
273
+ #
274
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
275
+ #
276
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
277
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
278
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
279
+ def mark_billing_account_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
280
+ command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
281
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
282
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
283
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
284
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
285
+ command.params['name'] = name unless name.nil?
286
+ command.query['fields'] = fields unless fields.nil?
287
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
288
+ execute_or_queue_command(command, &block)
289
+ end
290
+
291
+ # Marks the Recommendation State as Failed. Users can use this method to
292
+ # indicate to the Recommender API that they have applied the recommendation
293
+ # themselves, and the operation failed. This stops the recommendation content
294
+ # from being updated. Associated insights are frozen and placed in the ACCEPTED
295
+ # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE,
296
+ # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM
297
+ # permission for the specified recommender.
298
+ # @param [String] name
299
+ # Required. Name of the recommendation.
300
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_request_object
301
+ # @param [String] fields
302
+ # Selector specifying which fields to include in a partial response.
303
+ # @param [String] quota_user
304
+ # Available to use for quota purposes for server-side applications. Can be any
305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
306
+ # @param [Google::Apis::RequestOptions] options
307
+ # Request-specific options
308
+ #
309
+ # @yield [result, err] Result & error if block supplied
310
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
311
+ # @yieldparam err [StandardError] error object if request failed
312
+ #
313
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
314
+ #
315
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
316
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
317
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
318
+ def mark_billing_account_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
319
+ command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
320
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
321
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
322
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
323
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
324
+ command.params['name'] = name unless name.nil?
325
+ command.query['fields'] = fields unless fields.nil?
326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
327
+ execute_or_queue_command(command, &block)
328
+ end
329
+
330
+ # Marks the Recommendation State as Succeeded. Users can use this method to
331
+ # indicate to the Recommender API that they have applied the recommendation
332
+ # themselves, and the operation was successful. This stops the recommendation
333
+ # content from being updated. Associated insights are frozen and placed in the
334
+ # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations
335
+ # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.
336
+ # update IAM permission for the specified recommender.
337
+ # @param [String] name
338
+ # Required. Name of the recommendation.
339
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
340
+ # @param [String] fields
341
+ # Selector specifying which fields to include in a partial response.
342
+ # @param [String] quota_user
343
+ # Available to use for quota purposes for server-side applications. Can be any
344
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
345
+ # @param [Google::Apis::RequestOptions] options
346
+ # Request-specific options
347
+ #
348
+ # @yield [result, err] Result & error if block supplied
349
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
350
+ # @yieldparam err [StandardError] error object if request failed
351
+ #
352
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
353
+ #
354
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
355
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
356
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
357
+ def mark_billing_account_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
358
+ command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
359
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
360
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
361
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
362
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
363
+ command.params['name'] = name unless name.nil?
364
+ command.query['fields'] = fields unless fields.nil?
365
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
366
+ execute_or_queue_command(command, &block)
367
+ end
368
+
369
+ # Gets the requested insight. Requires the recommender.*.get IAM permission for
370
+ # the specified insight type.
371
+ # @param [String] name
372
+ # Required. Name of the insight.
373
+ # @param [String] fields
374
+ # Selector specifying which fields to include in a partial response.
375
+ # @param [String] quota_user
376
+ # Available to use for quota purposes for server-side applications. Can be any
377
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
378
+ # @param [Google::Apis::RequestOptions] options
379
+ # Request-specific options
380
+ #
381
+ # @yield [result, err] Result & error if block supplied
382
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
383
+ # @yieldparam err [StandardError] error object if request failed
384
+ #
385
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
386
+ #
387
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
388
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
389
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
390
+ def get_folder_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
391
+ command = make_simple_command(:get, 'v1/{+name}', options)
392
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
393
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
394
+ command.params['name'] = name unless name.nil?
395
+ command.query['fields'] = fields unless fields.nil?
396
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
397
+ execute_or_queue_command(command, &block)
398
+ end
399
+
400
+ # Lists insights for a Cloud project. Requires the recommender.*.list IAM
401
+ # permission for the specified insight type.
402
+ # @param [String] parent
403
+ # Required. The container resource on which to execute the request. Acceptable
404
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[
405
+ # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
406
+ # com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https:/
407
+ # /cloud.google.com/recommender/docs/insights/insight-types.)
408
+ # @param [String] filter
409
+ # Optional. Filter expression to restrict the insights returned. Supported
410
+ # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
411
+ # @param [Fixnum] page_size
412
+ # Optional. The maximum number of results to return from this request. Non-
413
+ # positive values are ignored. If not specified, the server will determine the
414
+ # number of results to return.
415
+ # @param [String] page_token
416
+ # Optional. If present, retrieves the next batch of results from the preceding
417
+ # call to this method. `page_token` must be the value of `next_page_token` from
418
+ # the previous response. The values of other method parameters must be identical
419
+ # to those in the previous call.
420
+ # @param [String] fields
421
+ # Selector specifying which fields to include in a partial response.
422
+ # @param [String] quota_user
423
+ # Available to use for quota purposes for server-side applications. Can be any
424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
425
+ # @param [Google::Apis::RequestOptions] options
426
+ # Request-specific options
427
+ #
428
+ # @yield [result, err] Result & error if block supplied
429
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse] parsed result object
430
+ # @yieldparam err [StandardError] error object if request failed
431
+ #
432
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse]
433
+ #
434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
437
+ def list_folder_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
438
+ command = make_simple_command(:get, 'v1/{+parent}/insights', options)
439
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
440
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
441
+ command.params['parent'] = parent unless parent.nil?
442
+ command.query['filter'] = filter unless filter.nil?
443
+ command.query['pageSize'] = page_size unless page_size.nil?
444
+ command.query['pageToken'] = page_token unless page_token.nil?
445
+ command.query['fields'] = fields unless fields.nil?
446
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
447
+ execute_or_queue_command(command, &block)
448
+ end
449
+
450
+ # Marks the Insight State as Accepted. Users can use this method to indicate to
451
+ # the Recommender API that they have applied some action based on the insight.
452
+ # This stops the insight content from being updated. MarkInsightAccepted can be
453
+ # applied to insights in ACTIVE state. Requires the recommender.*.update IAM
454
+ # permission for the specified insight.
455
+ # @param [String] name
456
+ # Required. Name of the insight.
457
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest] google_cloud_recommender_v1_mark_insight_accepted_request_object
458
+ # @param [String] fields
459
+ # Selector specifying which fields to include in a partial response.
460
+ # @param [String] quota_user
461
+ # Available to use for quota purposes for server-side applications. Can be any
462
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
463
+ # @param [Google::Apis::RequestOptions] options
464
+ # Request-specific options
465
+ #
466
+ # @yield [result, err] Result & error if block supplied
467
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
468
+ # @yieldparam err [StandardError] error object if request failed
469
+ #
470
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
471
+ #
472
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
473
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
474
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
475
+ def mark_folder_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
476
+ command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
477
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
478
+ command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
479
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
480
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
481
+ command.params['name'] = name unless name.nil?
482
+ command.query['fields'] = fields unless fields.nil?
483
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
484
+ execute_or_queue_command(command, &block)
485
+ end
486
+
487
+ # Gets the requested recommendation. Requires the recommender.*.get IAM
488
+ # permission for the specified recommender.
489
+ # @param [String] name
490
+ # Required. Name of the recommendation.
491
+ # @param [String] fields
492
+ # Selector specifying which fields to include in a partial response.
493
+ # @param [String] quota_user
494
+ # Available to use for quota purposes for server-side applications. Can be any
495
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
496
+ # @param [Google::Apis::RequestOptions] options
497
+ # Request-specific options
498
+ #
499
+ # @yield [result, err] Result & error if block supplied
500
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
501
+ # @yieldparam err [StandardError] error object if request failed
502
+ #
503
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
504
+ #
505
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
506
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
507
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
508
+ def get_folder_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
509
+ command = make_simple_command(:get, 'v1/{+name}', options)
510
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
511
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
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
+ # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM
519
+ # permission for the specified recommender.
520
+ # @param [String] parent
521
+ # Required. The container resource on which to execute the request. Acceptable
522
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[
523
+ # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
524
+ # com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://
525
+ # cloud.google.com/recommender/docs/recommenders.
526
+ # @param [String] filter
527
+ # Filter expression to restrict the recommendations returned. Supported filter
528
+ # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:
529
+ # "FAILED"
530
+ # @param [Fixnum] page_size
531
+ # Optional. The maximum number of results to return from this request. Non-
532
+ # positive values are ignored. If not specified, the server will determine the
533
+ # number of results to return.
534
+ # @param [String] page_token
535
+ # Optional. If present, retrieves the next batch of results from the preceding
536
+ # call to this method. `page_token` must be the value of `next_page_token` from
537
+ # the previous response. The values of other method parameters must be identical
538
+ # to those in the previous call.
539
+ # @param [String] fields
540
+ # Selector specifying which fields to include in a partial response.
541
+ # @param [String] quota_user
542
+ # Available to use for quota purposes for server-side applications. Can be any
543
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
544
+ # @param [Google::Apis::RequestOptions] options
545
+ # Request-specific options
546
+ #
547
+ # @yield [result, err] Result & error if block supplied
548
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] parsed result object
549
+ # @yieldparam err [StandardError] error object if request failed
550
+ #
551
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse]
552
+ #
553
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
554
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
555
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
556
+ def list_folder_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
557
+ command = make_simple_command(:get, 'v1/{+parent}/recommendations', options)
558
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
559
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
560
+ command.params['parent'] = parent unless parent.nil?
561
+ command.query['filter'] = filter unless filter.nil?
562
+ command.query['pageSize'] = page_size unless page_size.nil?
563
+ command.query['pageToken'] = page_token unless page_token.nil?
564
+ command.query['fields'] = fields unless fields.nil?
565
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
566
+ execute_or_queue_command(command, &block)
567
+ end
568
+
569
+ # Marks the Recommendation State as Claimed. Users can use this method to
570
+ # indicate to the Recommender API that they are starting to apply the
571
+ # recommendation themselves. This stops the recommendation content from being
572
+ # updated. Associated insights are frozen and placed in the ACCEPTED state.
573
+ # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
574
+ # SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM
575
+ # permission for the specified recommender.
576
+ # @param [String] name
577
+ # Required. Name of the recommendation.
578
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_request_object
579
+ # @param [String] fields
580
+ # Selector specifying which fields to include in a partial response.
581
+ # @param [String] quota_user
582
+ # Available to use for quota purposes for server-side applications. Can be any
583
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
584
+ # @param [Google::Apis::RequestOptions] options
585
+ # Request-specific options
586
+ #
587
+ # @yield [result, err] Result & error if block supplied
588
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
589
+ # @yieldparam err [StandardError] error object if request failed
590
+ #
591
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
592
+ #
593
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
594
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
595
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
596
+ def mark_folder_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
597
+ command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
598
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
599
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
600
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
601
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
602
+ command.params['name'] = name unless name.nil?
603
+ command.query['fields'] = fields unless fields.nil?
604
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
605
+ execute_or_queue_command(command, &block)
606
+ end
607
+
608
+ # Marks the Recommendation State as Failed. Users can use this method to
609
+ # indicate to the Recommender API that they have applied the recommendation
610
+ # themselves, and the operation failed. This stops the recommendation content
611
+ # from being updated. Associated insights are frozen and placed in the ACCEPTED
612
+ # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE,
613
+ # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM
614
+ # permission for the specified recommender.
615
+ # @param [String] name
616
+ # Required. Name of the recommendation.
617
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_request_object
618
+ # @param [String] fields
619
+ # Selector specifying which fields to include in a partial response.
620
+ # @param [String] quota_user
621
+ # Available to use for quota purposes for server-side applications. Can be any
622
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
623
+ # @param [Google::Apis::RequestOptions] options
624
+ # Request-specific options
625
+ #
626
+ # @yield [result, err] Result & error if block supplied
627
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
628
+ # @yieldparam err [StandardError] error object if request failed
629
+ #
630
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
631
+ #
632
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
633
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
634
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
635
+ def mark_folder_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
636
+ command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
637
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
638
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
639
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
640
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
641
+ command.params['name'] = name unless name.nil?
642
+ command.query['fields'] = fields unless fields.nil?
643
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
644
+ execute_or_queue_command(command, &block)
645
+ end
646
+
647
+ # Marks the Recommendation State as Succeeded. Users can use this method to
648
+ # indicate to the Recommender API that they have applied the recommendation
649
+ # themselves, and the operation was successful. This stops the recommendation
650
+ # content from being updated. Associated insights are frozen and placed in the
651
+ # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations
652
+ # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.
653
+ # update IAM permission for the specified recommender.
654
+ # @param [String] name
655
+ # Required. Name of the recommendation.
656
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
657
+ # @param [String] fields
658
+ # Selector specifying which fields to include in a partial response.
659
+ # @param [String] quota_user
660
+ # Available to use for quota purposes for server-side applications. Can be any
661
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
662
+ # @param [Google::Apis::RequestOptions] options
663
+ # Request-specific options
664
+ #
665
+ # @yield [result, err] Result & error if block supplied
666
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
667
+ # @yieldparam err [StandardError] error object if request failed
668
+ #
669
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
670
+ #
671
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
672
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
673
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
674
+ def mark_folder_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
675
+ command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
676
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
677
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
678
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
679
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
680
+ command.params['name'] = name unless name.nil?
681
+ command.query['fields'] = fields unless fields.nil?
682
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
683
+ execute_or_queue_command(command, &block)
684
+ end
685
+
686
+ # Gets the requested insight. Requires the recommender.*.get IAM permission for
687
+ # the specified insight type.
688
+ # @param [String] name
689
+ # Required. Name of the insight.
690
+ # @param [String] fields
691
+ # Selector specifying which fields to include in a partial response.
692
+ # @param [String] quota_user
693
+ # Available to use for quota purposes for server-side applications. Can be any
694
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
695
+ # @param [Google::Apis::RequestOptions] options
696
+ # Request-specific options
697
+ #
698
+ # @yield [result, err] Result & error if block supplied
699
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
700
+ # @yieldparam err [StandardError] error object if request failed
701
+ #
702
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
703
+ #
704
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
705
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
706
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
707
+ def get_organization_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
708
+ command = make_simple_command(:get, 'v1/{+name}', options)
709
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
710
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
711
+ command.params['name'] = name unless name.nil?
712
+ command.query['fields'] = fields unless fields.nil?
713
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
714
+ execute_or_queue_command(command, &block)
715
+ end
716
+
717
+ # Lists insights for a Cloud project. Requires the recommender.*.list IAM
718
+ # permission for the specified insight type.
719
+ # @param [String] parent
720
+ # Required. The container resource on which to execute the request. Acceptable
721
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[
722
+ # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
723
+ # com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https:/
724
+ # /cloud.google.com/recommender/docs/insights/insight-types.)
725
+ # @param [String] filter
726
+ # Optional. Filter expression to restrict the insights returned. Supported
727
+ # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
728
+ # @param [Fixnum] page_size
729
+ # Optional. The maximum number of results to return from this request. Non-
730
+ # positive values are ignored. If not specified, the server will determine the
731
+ # number of results to return.
732
+ # @param [String] page_token
733
+ # Optional. If present, retrieves the next batch of results from the preceding
734
+ # call to this method. `page_token` must be the value of `next_page_token` from
735
+ # the previous response. The values of other method parameters must be identical
736
+ # to those in the previous call.
737
+ # @param [String] fields
738
+ # Selector specifying which fields to include in a partial response.
739
+ # @param [String] quota_user
740
+ # Available to use for quota purposes for server-side applications. Can be any
741
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
742
+ # @param [Google::Apis::RequestOptions] options
743
+ # Request-specific options
744
+ #
745
+ # @yield [result, err] Result & error if block supplied
746
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse] parsed result object
747
+ # @yieldparam err [StandardError] error object if request failed
748
+ #
749
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse]
750
+ #
751
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
752
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
753
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
754
+ def list_organization_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
755
+ command = make_simple_command(:get, 'v1/{+parent}/insights', options)
756
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
757
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
758
+ command.params['parent'] = parent unless parent.nil?
759
+ command.query['filter'] = filter unless filter.nil?
760
+ command.query['pageSize'] = page_size unless page_size.nil?
761
+ command.query['pageToken'] = page_token unless page_token.nil?
762
+ command.query['fields'] = fields unless fields.nil?
763
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
764
+ execute_or_queue_command(command, &block)
765
+ end
766
+
767
+ # Marks the Insight State as Accepted. Users can use this method to indicate to
768
+ # the Recommender API that they have applied some action based on the insight.
769
+ # This stops the insight content from being updated. MarkInsightAccepted can be
770
+ # applied to insights in ACTIVE state. Requires the recommender.*.update IAM
771
+ # permission for the specified insight.
772
+ # @param [String] name
773
+ # Required. Name of the insight.
774
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest] google_cloud_recommender_v1_mark_insight_accepted_request_object
775
+ # @param [String] fields
776
+ # Selector specifying which fields to include in a partial response.
777
+ # @param [String] quota_user
778
+ # Available to use for quota purposes for server-side applications. Can be any
779
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
780
+ # @param [Google::Apis::RequestOptions] options
781
+ # Request-specific options
782
+ #
783
+ # @yield [result, err] Result & error if block supplied
784
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight] parsed result object
785
+ # @yieldparam err [StandardError] error object if request failed
786
+ #
787
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight]
788
+ #
789
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
790
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
791
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
792
+ def mark_organization_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
793
+ command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
794
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
795
+ command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
796
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
797
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
798
+ command.params['name'] = name unless name.nil?
799
+ command.query['fields'] = fields unless fields.nil?
800
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
801
+ execute_or_queue_command(command, &block)
802
+ end
803
+
804
+ # Gets the requested recommendation. Requires the recommender.*.get IAM
805
+ # permission for the specified recommender.
806
+ # @param [String] name
807
+ # Required. Name of the recommendation.
808
+ # @param [String] fields
809
+ # Selector specifying which fields to include in a partial response.
810
+ # @param [String] quota_user
811
+ # Available to use for quota purposes for server-side applications. Can be any
812
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
813
+ # @param [Google::Apis::RequestOptions] options
814
+ # Request-specific options
815
+ #
816
+ # @yield [result, err] Result & error if block supplied
817
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
818
+ # @yieldparam err [StandardError] error object if request failed
819
+ #
820
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
821
+ #
822
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
823
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
824
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
825
+ def get_organization_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
826
+ command = make_simple_command(:get, 'v1/{+name}', options)
827
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
828
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
829
+ command.params['name'] = name unless name.nil?
830
+ command.query['fields'] = fields unless fields.nil?
831
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
832
+ execute_or_queue_command(command, &block)
833
+ end
834
+
835
+ # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM
836
+ # permission for the specified recommender.
837
+ # @param [String] parent
838
+ # Required. The container resource on which to execute the request. Acceptable
839
+ # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[
840
+ # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google.
841
+ # com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://
842
+ # cloud.google.com/recommender/docs/recommenders.
843
+ # @param [String] filter
844
+ # Filter expression to restrict the recommendations returned. Supported filter
845
+ # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:
846
+ # "FAILED"
847
+ # @param [Fixnum] page_size
848
+ # Optional. The maximum number of results to return from this request. Non-
849
+ # positive values are ignored. If not specified, the server will determine the
850
+ # number of results to return.
851
+ # @param [String] page_token
852
+ # Optional. If present, retrieves the next batch of results from the preceding
853
+ # call to this method. `page_token` must be the value of `next_page_token` from
854
+ # the previous response. The values of other method parameters must be identical
855
+ # to those in the previous call.
856
+ # @param [String] fields
857
+ # Selector specifying which fields to include in a partial response.
858
+ # @param [String] quota_user
859
+ # Available to use for quota purposes for server-side applications. Can be any
860
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
861
+ # @param [Google::Apis::RequestOptions] options
862
+ # Request-specific options
863
+ #
864
+ # @yield [result, err] Result & error if block supplied
865
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse] parsed result object
866
+ # @yieldparam err [StandardError] error object if request failed
867
+ #
868
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse]
869
+ #
870
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
871
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
872
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
873
+ def list_organization_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
874
+ command = make_simple_command(:get, 'v1/{+parent}/recommendations', options)
875
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
876
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
877
+ command.params['parent'] = parent unless parent.nil?
878
+ command.query['filter'] = filter unless filter.nil?
879
+ command.query['pageSize'] = page_size unless page_size.nil?
880
+ command.query['pageToken'] = page_token unless page_token.nil?
881
+ command.query['fields'] = fields unless fields.nil?
882
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
883
+ execute_or_queue_command(command, &block)
884
+ end
885
+
886
+ # Marks the Recommendation State as Claimed. Users can use this method to
887
+ # indicate to the Recommender API that they are starting to apply the
888
+ # recommendation themselves. This stops the recommendation content from being
889
+ # updated. Associated insights are frozen and placed in the ACCEPTED state.
890
+ # MarkRecommendationClaimed can be applied to recommendations in CLAIMED,
891
+ # SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM
892
+ # permission for the specified recommender.
893
+ # @param [String] name
894
+ # Required. Name of the recommendation.
895
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_request_object
896
+ # @param [String] fields
897
+ # Selector specifying which fields to include in a partial response.
898
+ # @param [String] quota_user
899
+ # Available to use for quota purposes for server-side applications. Can be any
900
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
901
+ # @param [Google::Apis::RequestOptions] options
902
+ # Request-specific options
903
+ #
904
+ # @yield [result, err] Result & error if block supplied
905
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
906
+ # @yieldparam err [StandardError] error object if request failed
907
+ #
908
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
909
+ #
910
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
911
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
912
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
913
+ def mark_organization_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
914
+ command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
915
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
916
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
917
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
918
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
919
+ command.params['name'] = name unless name.nil?
920
+ command.query['fields'] = fields unless fields.nil?
921
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
922
+ execute_or_queue_command(command, &block)
923
+ end
924
+
925
+ # Marks the Recommendation State as Failed. Users can use this method to
926
+ # indicate to the Recommender API that they have applied the recommendation
927
+ # themselves, and the operation failed. This stops the recommendation content
928
+ # from being updated. Associated insights are frozen and placed in the ACCEPTED
929
+ # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE,
930
+ # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM
931
+ # permission for the specified recommender.
932
+ # @param [String] name
933
+ # Required. Name of the recommendation.
934
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_request_object
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::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
945
+ # @yieldparam err [StandardError] error object if request failed
946
+ #
947
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
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 mark_organization_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
953
+ command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
954
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
955
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
956
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
957
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
958
+ command.params['name'] = name unless name.nil?
959
+ command.query['fields'] = fields unless fields.nil?
960
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
961
+ execute_or_queue_command(command, &block)
962
+ end
963
+
964
+ # Marks the Recommendation State as Succeeded. Users can use this method to
965
+ # indicate to the Recommender API that they have applied the recommendation
966
+ # themselves, and the operation was successful. This stops the recommendation
967
+ # content from being updated. Associated insights are frozen and placed in the
968
+ # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations
969
+ # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.
970
+ # update IAM permission for the specified recommender.
971
+ # @param [String] name
972
+ # Required. Name of the recommendation.
973
+ # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
974
+ # @param [String] fields
975
+ # Selector specifying which fields to include in a partial response.
976
+ # @param [String] quota_user
977
+ # Available to use for quota purposes for server-side applications. Can be any
978
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
979
+ # @param [Google::Apis::RequestOptions] options
980
+ # Request-specific options
981
+ #
982
+ # @yield [result, err] Result & error if block supplied
983
+ # @yieldparam result [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation] parsed result object
984
+ # @yieldparam err [StandardError] error object if request failed
985
+ #
986
+ # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation]
987
+ #
988
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
989
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
990
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
991
+ def mark_organization_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
992
+ command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
993
+ command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
994
+ command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
995
+ command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
996
+ command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
997
+ command.params['name'] = name unless name.nil?
998
+ command.query['fields'] = fields unless fields.nil?
999
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1000
+ execute_or_queue_command(command, &block)
1001
+ end
1002
+
52
1003
  # Gets the requested insight. Requires the recommender.*.get IAM permission for
53
1004
  # the specified insight type.
54
1005
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-recommender_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.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: 2021-01-08 00:00:00.000000000 Z
11
+ date: 2021-02-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommender_v1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-recommender_v1/v0.1.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-recommender_v1/v0.2.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommender_v1
57
57
  post_install_message:
58
58
  rdoc_options: []
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  requirements: []
72
- rubygems_version: 3.1.4
72
+ rubygems_version: 3.2.6
73
73
  signing_key:
74
74
  specification_version: 4
75
75
  summary: Simple REST client for Recommender API V1