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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED".

Returns:

  • (::String) —

    Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"



134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 134

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.



134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 134

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.



134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 134

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:

1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",

LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

Returns:



134
135
136
137
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 134

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