Class: Google::Cloud::Recommender::V1::ListRecommendationsRequest

Inherits:

Object

• Object
• Google::Cloud::Recommender::V1::ListRecommendationsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/recommender/v1/recommender_service.rb

Overview

Request for the ListRecommendations method.

Instance Attribute Summary

• #filter ⇒ ::String

  Filter expression to restrict the recommendations returned.

• #page_size ⇒ ::Integer

  Optional.

• #page_token ⇒ ::String

  Optional.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

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

Returns:

• (::String) —

  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)

# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 198

class ListRecommendationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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

Returns:

• (::Integer) —

  Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 198

class ListRecommendationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

Returns:

• (::String) —

  Optional. If present, retrieves the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters must be identical to those in the previous call.

# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 198

class ListRecommendationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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

Returns:

• (::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.

# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 198

class ListRecommendationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end