google-apis-recommender_v1beta1 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a187d465cf3856424a891e6e66582c2c0a1066083f90a9406f89e0d9279ef4a0
4
- data.tar.gz: 798a30c5a9e75ac8035dbdd042978707a0a330b5988fcc8a12c293b8f9d814e2
3
+ metadata.gz: 25dec2821b6ec36ccca411acdc7d8c4b26774f45852dde8bad515f91d47c211b
4
+ data.tar.gz: bcbd232a6bd285adae3b14f6609220acaba6ac2eef04d92219fac74822eecd18
5
5
  SHA512:
6
- metadata.gz: b72fe996c4a83430f92073ada9722102a5a2f85d33df069ee500f6e05f7e781f4d96ad0331af79c249dba65f850407cf2337cf5180ecbbc7bda44bcb5c99bbf1
7
- data.tar.gz: 2242083e90a57b7b6e23ebf04b448758575b69657d5ebe6555dbcab9d289306e26a32df01995f26236c59df866478d0375be81c0ea19e5442422be4d73fc9e11
6
+ metadata.gz: 0f54c82c3f84260df6631a1f1189e65328264a97a49eb07c24c04e3302c675677c443a039026779b2f54f8a1beaed9c76614a1ba6992245d1e4fe43de65a3b39
7
+ data.tar.gz: 8aaad3b5d2883dca68448aaf5c35d7d1aeba9d6384ca97616ae7d53621580ce2e254094c48d532fd14968464d67e465fcd79e1d4c0f38222cca1d76f68bed941
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-recommender_v1beta1
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 RecommenderV1beta1
18
18
  # Version of the google-apis-recommender_v1beta1 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 = "20201204"
25
+ REVISION = "20210118"
26
26
  end
27
27
  end
28
28
  end
@@ -366,6 +366,640 @@ module Google
366
366
  execute_or_queue_command(command, &block)
367
367
  end
368
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object
383
+ # @yieldparam err [StandardError] error object if request failed
384
+ #
385
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight]
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, 'v1beta1/{+name}', options)
392
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation
393
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] parsed result object
430
+ # @yieldparam err [StandardError] error object if request failed
431
+ #
432
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse]
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, 'v1beta1/{+parent}/insights', options)
439
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse::Representation
440
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object
468
+ # @yieldparam err [StandardError] error object if request failed
469
+ #
470
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight]
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_v1beta1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
476
+ command = make_simple_command(:post, 'v1beta1/{+name}:markAccepted', options)
477
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest::Representation
478
+ command.request_object = google_cloud_recommender_v1beta1_mark_insight_accepted_request_object
479
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation
480
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
501
+ # @yieldparam err [StandardError] error object if request failed
502
+ #
503
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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, 'v1beta1/{+name}', options)
510
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
511
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] parsed result object
549
+ # @yieldparam err [StandardError] error object if request failed
550
+ #
551
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse]
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, 'v1beta1/{+parent}/recommendations', options)
558
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse::Representation
559
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse
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 or
574
+ # ACTIVE state. Requires the recommender.*.update IAM permission for the
575
+ # specified recommender.
576
+ # @param [String] name
577
+ # Required. Name of the recommendation.
578
+ # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
589
+ # @yieldparam err [StandardError] error object if request failed
590
+ #
591
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
597
+ command = make_simple_command(:post, 'v1beta1/{+name}:markClaimed', options)
598
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest::Representation
599
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object
600
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
601
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
628
+ # @yieldparam err [StandardError] error object if request failed
629
+ #
630
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
636
+ command = make_simple_command(:post, 'v1beta1/{+name}:markFailed', options)
637
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest::Representation
638
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object
639
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
640
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
667
+ # @yieldparam err [StandardError] error object if request failed
668
+ #
669
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
675
+ command = make_simple_command(:post, 'v1beta1/{+name}:markSucceeded', options)
676
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest::Representation
677
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object
678
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
679
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object
700
+ # @yieldparam err [StandardError] error object if request failed
701
+ #
702
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight]
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, 'v1beta1/{+name}', options)
709
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation
710
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] parsed result object
747
+ # @yieldparam err [StandardError] error object if request failed
748
+ #
749
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse]
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, 'v1beta1/{+parent}/insights', options)
756
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse::Representation
757
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object
785
+ # @yieldparam err [StandardError] error object if request failed
786
+ #
787
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight]
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_v1beta1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
793
+ command = make_simple_command(:post, 'v1beta1/{+name}:markAccepted', options)
794
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest::Representation
795
+ command.request_object = google_cloud_recommender_v1beta1_mark_insight_accepted_request_object
796
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation
797
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
818
+ # @yieldparam err [StandardError] error object if request failed
819
+ #
820
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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, 'v1beta1/{+name}', options)
827
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
828
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] parsed result object
866
+ # @yieldparam err [StandardError] error object if request failed
867
+ #
868
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse]
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, 'v1beta1/{+parent}/recommendations', options)
875
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse::Representation
876
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse
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 or
891
+ # ACTIVE state. Requires the recommender.*.update IAM permission for the
892
+ # specified recommender.
893
+ # @param [String] name
894
+ # Required. Name of the recommendation.
895
+ # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
906
+ # @yieldparam err [StandardError] error object if request failed
907
+ #
908
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
914
+ command = make_simple_command(:post, 'v1beta1/{+name}:markClaimed', options)
915
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest::Representation
916
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object
917
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
918
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
945
+ # @yieldparam err [StandardError] error object if request failed
946
+ #
947
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
953
+ command = make_simple_command(:post, 'v1beta1/{+name}:markFailed', options)
954
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest::Representation
955
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object
956
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
957
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest] google_cloud_recommender_v1beta1_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::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object
984
+ # @yieldparam err [StandardError] error object if request failed
985
+ #
986
+ # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation]
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_v1beta1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
992
+ command = make_simple_command(:post, 'v1beta1/{+name}:markSucceeded', options)
993
+ command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest::Representation
994
+ command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object
995
+ command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation
996
+ command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation
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
+
369
1003
  # Gets the requested insight. Requires the recommender.*.get IAM permission for
370
1004
  # the specified insight type.
371
1005
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-recommender_v1beta1
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_v1beta1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-recommender_v1beta1/v0.1.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-recommender_v1beta1/v0.2.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-recommender_v1beta1
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 V1beta1