class Google::Cloud::Recommender::V1::Recommender::Client
Client
for the Recommender
service.
Provides insights and recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.
Attributes
@private
Public Class Methods
Configure the Recommender
Client
class.
See {::Google::Cloud::Recommender::V1::Recommender::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Recommender clients ::Google::Cloud::Recommender::V1::Recommender::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 59 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Recommender", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.list_insights.timeout = 60.0 default_config.rpcs.list_insights.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_insight.timeout = 60.0 default_config.rpcs.get_insight.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.mark_insight_accepted.timeout = 60.0 default_config.rpcs.list_recommendations.timeout = 60.0 default_config.rpcs.list_recommendations.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.get_recommendation.timeout = 60.0 default_config.rpcs.get_recommendation.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.mark_recommendation_claimed.timeout = 60.0 default_config.rpcs.mark_recommendation_succeeded.timeout = 60.0 default_config.rpcs.mark_recommendation_failed.timeout = 60.0 default_config end yield @configure if block_given? @configure end
Create a new Recommender
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Recommender::V1::Recommender::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Recommender::V1::Recommender::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Recommender
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 140 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/recommender/v1/recommender_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @recommender_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Recommender::V1::Recommender::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the Recommender
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::Recommender::V1::Recommender::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 119 def configure yield @config if block_given? @config end
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
@overload get_insight
(request, options = nil)
Pass arguments to `get_insight` via a request object, either of type {::Google::Cloud::Recommender::V1::GetInsightRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::GetInsightRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_insight
(name: nil)
Pass arguments to `get_insight` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the insight.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Insight] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Insight]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 300 def get_insight request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::GetInsightRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_insight.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_insight.timeout, metadata: metadata, retry_policy: @config.rpcs.get_insight.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :get_insight, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
@overload get_recommendation
(request, options = nil)
Pass arguments to `get_recommendation` via a request object, either of type {::Google::Cloud::Recommender::V1::GetRecommendationRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::GetRecommendationRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_recommendation
(name: nil)
Pass arguments to `get_recommendation` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the recommendation.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Recommendation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Recommendation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 539 def get_recommendation request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::GetRecommendationRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_recommendation.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_recommendation.timeout, metadata: metadata, retry_policy: @config.rpcs.get_recommendation.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :get_recommendation, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists insights for a Cloud
project. Requires the recommender.*.list IAM permission for the specified insight type.
@overload list_insights
(request, options = nil)
Pass arguments to `list_insights` via a request object, either of type {::Google::Cloud::Recommender::V1::ListInsightsRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::ListInsightsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_insights
(parent: nil, page_size: nil, page_token: nil, filter: nil)
Pass arguments to `list_insights` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] 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 page_size [::Integer] 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 page_token [::String] 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 filter [::String] Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE"
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Insight>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Insight>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 230 def list_insights request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::ListInsightsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_insights.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_insights.timeout, metadata: metadata, retry_policy: @config.rpcs.list_insights.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :list_insights, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recommender_stub, :list_insights, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists recommendations for a Cloud
project. Requires the recommender.*.list IAM permission for the specified recommender.
@overload list_recommendations
(request, options = nil)
Pass arguments to `list_recommendations` via a request object, either of type {::Google::Cloud::Recommender::V1::ListRecommendationsRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::ListRecommendationsRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_recommendations
(parent: nil, page_size: nil, page_token: nil, filter: nil)
Pass arguments to `list_recommendations` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param parent [::String] 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 page_size [::Integer] 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 page_token [::String] 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 filter [::String] Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Recommendation>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Recommender::V1::Recommendation>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 469 def list_recommendations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::ListRecommendationsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_recommendations.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_recommendations.timeout, metadata: metadata, retry_policy: @config.rpcs.list_recommendations.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :list_recommendations, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @recommender_stub, :list_recommendations, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
@overload mark_insight_accepted
(request, options = nil)
Pass arguments to `mark_insight_accepted` via a request object, either of type {::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload mark_insight_accepted
(name: nil, state_metadata: nil, etag: nil)
Pass arguments to `mark_insight_accepted` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the insight. @param state_metadata [::Hash{::String => ::String}] Optional. State properties user wish to include with this state. Full replace of the current state_metadata. @param etag [::String] Required. Fingerprint of the Insight. Provides optimistic locking.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Insight] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Insight]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 378 def mark_insight_accepted request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::MarkInsightAcceptedRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.mark_insight_accepted.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.mark_insight_accepted.timeout, metadata: metadata, retry_policy: @config.rpcs.mark_insight_accepted.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :mark_insight_accepted, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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, SUCCEEDED, FAILED, or ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
@overload mark_recommendation_claimed
(request, options = nil)
Pass arguments to `mark_recommendation_claimed` via a request object, either of type {::Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload mark_recommendation_claimed
(name: nil, state_metadata: nil, etag: nil)
Pass arguments to `mark_recommendation_claimed` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the recommendation. @param state_metadata [::Hash{::String => ::String}] State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/. @param etag [::String] Required. Fingerprint of the Recommendation. Provides optimistic locking.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Recommendation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Recommendation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 623 def mark_recommendation_claimed request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::MarkRecommendationClaimedRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.mark_recommendation_claimed.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.mark_recommendation_claimed.timeout, metadata: metadata, retry_policy: @config.rpcs.mark_recommendation_claimed.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :mark_recommendation_claimed, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
@overload mark_recommendation_failed
(request, options = nil)
Pass arguments to `mark_recommendation_failed` via a request object, either of type {::Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload mark_recommendation_failed
(name: nil, state_metadata: nil, etag: nil)
Pass arguments to `mark_recommendation_failed` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the recommendation. @param state_metadata [::Hash{::String => ::String}] State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/. @param etag [::String] Required. Fingerprint of the Recommendation. Provides optimistic locking.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Recommendation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Recommendation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 793 def mark_recommendation_failed request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::MarkRecommendationFailedRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.mark_recommendation_failed.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.mark_recommendation_failed.timeout, metadata: metadata, retry_policy: @config.rpcs.mark_recommendation_failed.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :mark_recommendation_failed, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
@overload mark_recommendation_succeeded
(request, options = nil)
Pass arguments to `mark_recommendation_succeeded` via a request object, either of type {::Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest} or an equivalent Hash. @param request [::Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload mark_recommendation_succeeded
(name: nil, state_metadata: nil, etag: nil)
Pass arguments to `mark_recommendation_succeeded` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). @param name [::String] Required. Name of the recommendation. @param state_metadata [::Hash{::String => ::String}] State properties to include with this state. Overwrites any existing `state_metadata`. Keys must match the regex /^[a-z0-9][a-z0-9_.-]\\{0,62}$/. Values must match the regex /^[a-zA-Z0-9_./-]\\{0,255}$/. @param etag [::String] Required. Fingerprint of the Recommendation. Provides optimistic locking.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Recommender::V1::Recommendation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Recommender::V1::Recommendation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/recommender/v1/recommender/client.rb, line 708 def mark_recommendation_succeeded request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Recommender::V1::MarkRecommendationSucceededRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.mark_recommendation_succeeded.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Recommender::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.mark_recommendation_succeeded.timeout, metadata: metadata, retry_policy: @config.rpcs.mark_recommendation_succeeded.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @recommender_stub.call_rpc :mark_recommendation_succeeded, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end