diff --git a/api_names_out.yaml b/api_names_out.yaml index e393c5e7e..db4f8f16d 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -133531,6 +133531,50 @@ "/recommender:v1beta1/recommender.billingAccounts.locations.recommenders.recommendations.markFailed/name": name "/recommender:v1beta1/recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded": mark_billing_account_location_recommender_recommendation_succeeded "/recommender:v1beta1/recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded/name": name +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.get": get_folder_location_insight_type_insight +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.get/name": name +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.list": list_folder_location_insight_type_insights +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.list/filter": filter +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.list/pageSize": page_size +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.list/pageToken": page_token +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.list/parent": parent +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.markAccepted": mark_folder_location_insight_type_insight_accepted +"/recommender:v1beta1/recommender.folders.locations.insightTypes.insights.markAccepted/name": name +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.get": get_folder_location_recommender_recommendation +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.get/name": name +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.list": list_folder_location_recommender_recommendations +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.list/filter": filter +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.list/pageSize": page_size +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.list/pageToken": page_token +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.list/parent": parent +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markClaimed": mark_folder_location_recommender_recommendation_claimed +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markClaimed/name": name +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markFailed": mark_folder_location_recommender_recommendation_failed +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markFailed/name": name +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markSucceeded": mark_folder_location_recommender_recommendation_succeeded +"/recommender:v1beta1/recommender.folders.locations.recommenders.recommendations.markSucceeded/name": name +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.get": get_organization_location_insight_type_insight +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.get/name": name +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.list": list_organization_location_insight_type_insights +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.list/filter": filter +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.list/pageSize": page_size +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.list/pageToken": page_token +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.list/parent": parent +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.markAccepted": mark_organization_location_insight_type_insight_accepted +"/recommender:v1beta1/recommender.organizations.locations.insightTypes.insights.markAccepted/name": name +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.get": get_organization_location_recommender_recommendation +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.get/name": name +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.list": list_organization_location_recommender_recommendations +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.list/filter": filter +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.list/pageSize": page_size +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.list/pageToken": page_token +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.list/parent": parent +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markClaimed": mark_organization_location_recommender_recommendation_claimed +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markClaimed/name": name +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markFailed": mark_organization_location_recommender_recommendation_failed +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markFailed/name": name +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markSucceeded": mark_organization_location_recommender_recommendation_succeeded +"/recommender:v1beta1/recommender.organizations.locations.recommenders.recommendations.markSucceeded/name": name "/recommender:v1beta1/recommender.projects.locations.insightTypes.insights.get": get_project_location_insight_type_insight "/recommender:v1beta1/recommender.projects.locations.insightTypes.insights.get/name": name "/recommender:v1beta1/recommender.projects.locations.insightTypes.insights.list": list_project_location_insight_type_insights diff --git a/generated/google-apis-recommender_v1beta1/CHANGELOG.md b/generated/google-apis-recommender_v1beta1/CHANGELOG.md index 7ea736fdf..d063ce6f6 100644 --- a/generated/google-apis-recommender_v1beta1/CHANGELOG.md +++ b/generated/google-apis-recommender_v1beta1/CHANGELOG.md @@ -1,5 +1,10 @@ # Release history for google-apis-recommender_v1beta1 +### v0.2.0 (2021-01-21) + +* Regenerated from discovery document revision 20210118 +* Regenerated using generator version 0.1.2 + ### v0.1.0 (2021-01-07) * Regenerated using generator version 0.1.1 diff --git a/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/gem_version.rb b/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/gem_version.rb index f47776544..6ed7ac58b 100644 --- a/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/gem_version.rb +++ b/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/gem_version.rb @@ -16,13 +16,13 @@ module Google module Apis module RecommenderV1beta1 # Version of the google-apis-recommender_v1beta1 gem - GEM_VERSION = "0.1.0" + GEM_VERSION = "0.2.0" # Version of the code generator used to generate this client - GENERATOR_VERSION = "0.1.1" + GENERATOR_VERSION = "0.1.2" # Revision of the discovery document this client was generated from - REVISION = "20201204" + REVISION = "20210118" end end end diff --git a/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/service.rb b/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/service.rb index ee13317b4..ada68d819 100644 --- a/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/service.rb +++ b/generated/google-apis-recommender_v1beta1/lib/google/apis/recommender_v1beta1/service.rb @@ -366,6 +366,640 @@ module Google execute_or_queue_command(command, &block) end + # Gets the requested insight. Requires the recommender.*.get IAM permission for + # the specified insight type. + # @param [String] name + # Required. Name of the insight. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_folder_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists insights for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified insight type. + # @param [String] parent + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ + # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https:/ + # /cloud.google.com/recommender/docs/insights/insight-types. + # @param [String] filter + # Optional. Filter expression to restrict the insights returned. Supported + # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. + # @param [String] page_token + # Optional. If present, retrieves the next batch of results from the preceding + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical + # to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_folder_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/insights', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Insight State as Accepted. Users can use this method to indicate to + # the Recommender API that they have applied some action based on the insight. + # This stops the insight content from being updated. MarkInsightAccepted can be + # applied to insights in ACTIVE state. Requires the recommender.*.update IAM + # permission for the specified insight. + # @param [String] name + # Required. Name of the insight. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest] google_cloud_recommender_v1beta1_mark_insight_accepted_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markAccepted', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_insight_accepted_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the requested recommendation. Requires the recommender.*.get IAM + # permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_folder_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified recommender. + # @param [String] parent + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ + # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https:// + # cloud.google.com/recommender/docs/recommenders. + # @param [String] filter + # Filter expression to restrict the recommendations returned. Supported filter + # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state: + # "FAILED" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. + # @param [String] page_token + # Optional. If present, retrieves the next batch of results from the preceding + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical + # to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_folder_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/recommendations', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Claimed. Users can use this method to + # indicate to the Recommender API that they are starting to apply the + # recommendation themselves. This stops the recommendation content from being + # updated. Associated insights are frozen and placed in the ACCEPTED state. + # MarkRecommendationClaimed can be applied to recommendations in CLAIMED or + # ACTIVE state. Requires the recommender.*.update IAM permission for the + # specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest] google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markClaimed', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Failed. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation failed. This stops the recommendation content + # from being updated. Associated insights are frozen and placed in the ACCEPTED + # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM + # permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest] google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markFailed', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Succeeded. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation was successful. This stops the recommendation + # content from being updated. Associated insights are frozen and placed in the + # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations + # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*. + # update IAM permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest] google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markSucceeded', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the requested insight. Requires the recommender.*.get IAM permission for + # the specified insight type. + # @param [String] name + # Required. Name of the insight. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists insights for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified insight type. + # @param [String] parent + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ + # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https:/ + # /cloud.google.com/recommender/docs/insights/insight-types. + # @param [String] filter + # Optional. Filter expression to restrict the insights returned. Supported + # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. + # @param [String] page_token + # Optional. If present, retrieves the next batch of results from the preceding + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical + # to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/insights', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListInsightsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Insight State as Accepted. Users can use this method to indicate to + # the Recommender API that they have applied some action based on the insight. + # This stops the insight content from being updated. MarkInsightAccepted can be + # applied to insights in ACTIVE state. Requires the recommender.*.update IAM + # permission for the specified insight. + # @param [String] name + # Required. Name of the insight. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest] google_cloud_recommender_v1beta1_mark_insight_accepted_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markAccepted', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_insight_accepted_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the requested recommendation. Requires the recommender.*.get IAM + # permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified recommender. + # @param [String] parent + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ + # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https:// + # cloud.google.com/recommender/docs/recommenders. + # @param [String] filter + # Filter expression to restrict the recommendations returned. Supported filter + # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state: + # "FAILED" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. + # @param [String] page_token + # Optional. If present, retrieves the next batch of results from the preceding + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical + # to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/recommendations', options) + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1ListRecommendationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Claimed. Users can use this method to + # indicate to the Recommender API that they are starting to apply the + # recommendation themselves. This stops the recommendation content from being + # updated. Associated insights are frozen and placed in the ACCEPTED state. + # MarkRecommendationClaimed can be applied to recommendations in CLAIMED or + # ACTIVE state. Requires the recommender.*.update IAM permission for the + # specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest] google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markClaimed', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Failed. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation failed. This stops the recommendation content + # from being updated. Associated insights are frozen and placed in the ACCEPTED + # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM + # permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest] google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markFailed', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Marks the Recommendation State as Succeeded. Users can use this method to + # indicate to the Recommender API that they have applied the recommendation + # themselves, and the operation was successful. This stops the recommendation + # content from being updated. Associated insights are frozen and placed in the + # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations + # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*. + # update IAM permission for the specified recommender. + # @param [String] name + # Required. Name of the recommendation. + # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest] google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + 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) + command = make_simple_command(:post, 'v1beta1/{+name}:markSucceeded', options) + command.request_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest::Representation + command.request_object = google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object + command.response_representation = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation::Representation + command.response_class = Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the requested insight. Requires the recommender.*.get IAM permission for # the specified insight type. # @param [String] name diff --git a/generated/google-apis-recommender_v1beta1/synth.metadata b/generated/google-apis-recommender_v1beta1/synth.metadata index 0232f5169..98cc4553b 100644 --- a/generated/google-apis-recommender_v1beta1/synth.metadata +++ b/generated/google-apis-recommender_v1beta1/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "6090200f4cdab3152a40bef1456aafefadb3b667" + "sha": "3bc8667260d47c9295352865c9bcc653283b03ce" } } ]