Class: Google::Apis::RecommenderV1::RecommenderService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/recommender_v1/service.rb

Overview

Recommender API

Examples:

require 'google/apis/recommender_v1'

Recommender = Google::Apis::RecommenderV1 # Alias the module
service = Recommender::RecommenderService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://recommender.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RecommenderService

Returns a new instance of RecommenderService.



47
48
49
50
51
52
 
# File 'lib/google/apis/recommender_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-recommender_v1',
        client_version: Google::Apis::RecommenderV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/recommender_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/google/apis/recommender_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#get_billing_account_location_insight_type_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

Parameters:

  • name (String) —

    Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[ LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[ BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



80
81
82
83
84
85
86
87
88
 
# File 'lib/google/apis/recommender_v1/service.rb', line 80

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  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

#get_billing_account_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



153
154
155
156
157
158
159
160
161
 
# File 'lib/google/apis/recommender_v1/service.rb', line 153

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#get_billing_account_location_recommender_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Parameters:

  • name (String) —

    Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION] /recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



288
289
290
291
292
293
294
295
296
 
# File 'lib/google/apis/recommender_v1/service.rb', line 288

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  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

#get_billing_account_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



360
361
362
363
364
365
366
367
368
 
# File 'lib/google/apis/recommender_v1/service.rb', line 360

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#get_folder_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



606
607
608
609
610
611
612
613
614
 
# File 'lib/google/apis/recommender_v1/service.rb', line 606

def get_folder_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#get_folder_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



736
737
738
739
740
741
742
743
744
 
# File 'lib/google/apis/recommender_v1/service.rb', line 736

def get_folder_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#get_organization_location_insight_type_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

Parameters:

  • name (String) —

    Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[ LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[ BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



987
988
989
990
991
992
993
994
995
 
# File 'lib/google/apis/recommender_v1/service.rb', line 987

def get_organization_location_insight_type_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  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

#get_organization_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1060

def get_organization_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#get_organization_location_recommender_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Parameters:

  • name (String) —

    Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION] /recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1195
1196
1197
1198
1199
1200
1201
1202
1203
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1195

def get_organization_location_recommender_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  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

#get_organization_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1267

def get_organization_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#get_project_location_insight_type_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

Parameters:

  • name (String) —

    Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[ LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[ BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1518

def get_project_location_insight_type_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  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

#get_project_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1591

def get_project_location_insight_type_insight(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#get_project_location_recommender_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Parameters:

  • name (String) —

    Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/ config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION] /recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1726
1727
1728
1729
1730
1731
1732
1733
1734
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1726

def get_project_location_recommender_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  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

#get_project_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1798
1799
1800
1801
1802
1803
1804
1805
1806
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1798

def get_project_location_recommender_recommendation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#list_billing_account_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse

Lists insights for the specified Cloud Resource. Requires the recommender.*. list IAM permission for the specified insight type.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Optional. Filter expression to restrict the insights returned. Supported filter fields: * stateInfo.state * insightSubtype * severity * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * insightSubtype = PERMISSIONS_USAGE * severity = CRITICAL OR severity = HIGH * targetResources : //compute.googleapis.com/projects/1234/ zones/us-central1-a/instances/instance-1 * stateInfo.state = ACTIVE AND ( severity = CRITICAL OR severity = HIGH) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/google/apis/recommender_v1/service.rb', line 212

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/insights', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
  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

#list_billing_account_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Filter expression to restrict the recommendations returned. Supported filter fields: * state_info.state * recommenderSubtype * priority * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE * priority = P1 OR priority = P2 * targetResources : // compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1

    • stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)
  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/google/apis/recommender_v1/service.rb', line 418

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/recommendations', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
  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

#list_folder_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse

Lists insights for the specified Cloud Resource. Requires the recommender.*. list IAM permission for the specified insight type.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Optional. Filter expression to restrict the insights returned. Supported filter fields: * stateInfo.state * insightSubtype * severity * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * insightSubtype = PERMISSIONS_USAGE * severity = CRITICAL OR severity = HIGH * targetResources : //compute.googleapis.com/projects/1234/ zones/us-central1-a/instances/instance-1 * stateInfo.state = ACTIVE AND ( severity = CRITICAL OR severity = HIGH) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/google/apis/recommender_v1/service.rb', line 665

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, 'v1/{+parent}/insights', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
  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

#list_folder_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Filter expression to restrict the recommendations returned. Supported filter fields: * state_info.state * recommenderSubtype * priority * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE * priority = P1 OR priority = P2 * targetResources : // compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1

    • stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)
  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/google/apis/recommender_v1/service.rb', line 794

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, 'v1/{+parent}/recommendations', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
  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

#list_organization_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse

Lists insights for the specified Cloud Resource. Requires the recommender.*. list IAM permission for the specified insight type.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Optional. Filter expression to restrict the insights returned. Supported filter fields: * stateInfo.state * insightSubtype * severity * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * insightSubtype = PERMISSIONS_USAGE * severity = CRITICAL OR severity = HIGH * targetResources : //compute.googleapis.com/projects/1234/ zones/us-central1-a/instances/instance-1 * stateInfo.state = ACTIVE AND ( severity = CRITICAL OR severity = HIGH) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1119

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, 'v1/{+parent}/insights', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
  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

#list_organization_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Filter expression to restrict the recommendations returned. Supported filter fields: * state_info.state * recommenderSubtype * priority * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE * priority = P1 OR priority = P2 * targetResources : // compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1

    • stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)
  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1325

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, 'v1/{+parent}/recommendations', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
  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

#list_project_location_insight_type_insights(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse

Lists insights for the specified Cloud Resource. Requires the recommender.*. list IAM permission for the specified insight type.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[ INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Optional. Filter expression to restrict the insights returned. Supported filter fields: * stateInfo.state * insightSubtype * severity * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * insightSubtype = PERMISSIONS_USAGE * severity = CRITICAL OR severity = HIGH * targetResources : //compute.googleapis.com/projects/1234/ zones/us-central1-a/instances/instance-1 * stateInfo.state = ACTIVE AND ( severity = CRITICAL OR severity = HIGH) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1650

def list_project_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, 'v1/{+parent}/insights', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListInsightsResponse
  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

#list_project_location_recommender_recommendations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters:

  • parent (String) —

    Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[ RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/ recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/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.

  • filter (String) (defaults to: nil) —

    Filter expression to restrict the recommendations returned. Supported filter fields: * state_info.state * recommenderSubtype * priority * targetResources Examples: * stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED * recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE * priority = P1 OR priority = P2 * targetResources : // compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1

    • stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2) The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)
  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1856

def list_project_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, 'v1/{+parent}/recommendations', options)
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1ListRecommendationsResponse
  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

#mark_billing_account_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

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.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • google_cloud_recommender_v1_mark_insight_accepted_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/recommender_v1/service.rb', line 250

def (name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#mark_billing_account_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_claimed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/apis/recommender_v1/service.rb', line 458

def (name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_billing_account_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_dismissed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/google/apis/recommender_v1/service.rb', line 495

def (name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markDismissed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_dismissed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_billing_account_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_failed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/google/apis/recommender_v1/service.rb', line 534

def (name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_billing_account_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_succeeded_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/google/apis/recommender_v1/service.rb', line 573

def (name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_folder_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

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.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • google_cloud_recommender_v1_mark_insight_accepted_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/google/apis/recommender_v1/service.rb', line 703

def mark_folder_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#mark_folder_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_claimed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/google/apis/recommender_v1/service.rb', line 834

def mark_folder_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_folder_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_dismissed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



871
872
873
874
875
876
877
878
879
880
881
 
# File 'lib/google/apis/recommender_v1/service.rb', line 871

def mark_folder_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markDismissed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_dismissed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_folder_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_failed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/google/apis/recommender_v1/service.rb', line 910

def mark_folder_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_folder_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_succeeded_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/google/apis/recommender_v1/service.rb', line 949

def mark_folder_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_organization_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

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.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • google_cloud_recommender_v1_mark_insight_accepted_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1157

def mark_organization_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#mark_organization_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_claimed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1365

def mark_organization_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_organization_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_dismissed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1402

def mark_organization_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markDismissed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_dismissed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_organization_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_failed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1441

def mark_organization_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_organization_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_succeeded_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1480

def mark_organization_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_project_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

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.

Parameters:

  • name (String) —

    Required. Name of the insight.

  • google_cloud_recommender_v1_mark_insight_accepted_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1688

def mark_project_location_insight_type_insight_accepted(name, google_cloud_recommender_v1_mark_insight_accepted_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markAccepted', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_insight_accepted_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight
  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

#mark_project_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_claimed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1896

def mark_project_location_recommender_recommendation_claimed(name, google_cloud_recommender_v1_mark_recommendation_claimed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markClaimed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_claimed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_project_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_dismissed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1933

def mark_project_location_recommender_recommendation_dismissed(name, google_cloud_recommender_v1_mark_recommendation_dismissed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markDismissed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationDismissedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_dismissed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_project_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_failed_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1972

def mark_project_location_recommender_recommendation_failed(name, google_cloud_recommender_v1_mark_recommendation_failed_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markFailed', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_failed_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#mark_project_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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.

Parameters:

  • name (String) —

    Required. Name of the recommendation.

  • google_cloud_recommender_v1_mark_recommendation_succeeded_request_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 
# File 'lib/google/apis/recommender_v1/service.rb', line 2011

def mark_project_location_recommender_recommendation_succeeded(name, google_cloud_recommender_v1_mark_recommendation_succeeded_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:markSucceeded', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest::Representation
  command.request_object = google_cloud_recommender_v1_mark_recommendation_succeeded_request_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation
  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

#update_billing_account_location_insight_type_config(name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Updates an InsightTypeConfig change. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • google_cloud_recommender_v1_insight_type_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/apis/recommender_v1/service.rb', line 118

def (name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.request_object = google_cloud_recommender_v1_insight_type_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_billing_account_location_recommender_config(name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Updates a Recommender Config. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • google_cloud_recommender_v1_recommender_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/google/apis/recommender_v1/service.rb', line 325

def (name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.request_object = google_cloud_recommender_v1_recommender_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_location_insight_type_config(name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Updates an InsightTypeConfig change. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • google_cloud_recommender_v1_insight_type_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1025

def update_organization_location_insight_type_config(name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.request_object = google_cloud_recommender_v1_insight_type_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_organization_location_recommender_config(name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Updates a Recommender Config. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • google_cloud_recommender_v1_recommender_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1232

def update_organization_location_recommender_config(name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.request_object = google_cloud_recommender_v1_recommender_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_insight_type_config(name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig

Updates an InsightTypeConfig change. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

  • google_cloud_recommender_v1_insight_type_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1556

def update_project_location_insight_type_config(name, google_cloud_recommender_v1_insight_type_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.request_object = google_cloud_recommender_v1_insight_type_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightTypeConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_recommender_config(name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig

Updates a Recommender Config. This will create a new revision of the config.

Parameters:

  • name (String) —

    Identifier. Name of recommender config. Eg, projects/[PROJECT_NUMBER]/ locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

  • google_cloud_recommender_v1_recommender_config_object (Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    The list of fields to be updated.

  • validate_only (Boolean) (defaults to: nil) —

    If true, validate the request and preview the change, but do not actually update it.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/google/apis/recommender_v1/service.rb', line 1763

def update_project_location_recommender_config(name, google_cloud_recommender_v1_recommender_config_object = nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.request_object = google_cloud_recommender_v1_recommender_config_object
  command.response_representation = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig::Representation
  command.response_class = Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommenderConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end