Reference documentation and code samples for the Recommender V1 Client class ListRecommendationsRequest.
Request for the ListRecommendations method.
Generated from protobuf message google.cloud.recommender.v1.ListRecommendationsRequest
Namespace
Google \ Cloud \ Recommender \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ page_size
int
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
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.
↳ filter
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)
getParent
Required. The container resource on which to execute the request.
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
Type
Description
int
setPageSize
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
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
Type
Description
string
setPageToken
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Recommender V1 Client - Class ListRecommendationsRequest (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-recommender/latest/V1.ListRecommendationsRequest)\n- [2.0.4](/php/docs/reference/cloud-recommender/2.0.4/V1.ListRecommendationsRequest)\n- [1.11.5](/php/docs/reference/cloud-recommender/1.11.5/V1.ListRecommendationsRequest)\n- [1.10.0](/php/docs/reference/cloud-recommender/1.10.0/V1.ListRecommendationsRequest)\n- [1.9.1](/php/docs/reference/cloud-recommender/1.9.1/V1.ListRecommendationsRequest)\n- [1.8.2](/php/docs/reference/cloud-recommender/1.8.2/V1.ListRecommendationsRequest)\n- [1.7.8](/php/docs/reference/cloud-recommender/1.7.8/V1.ListRecommendationsRequest) \nReference documentation and code samples for the Recommender V1 Client class ListRecommendationsRequest.\n\nRequest for the `ListRecommendations` method.\n\nGenerated from protobuf message `google.cloud.recommender.v1.ListRecommendationsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Recommender \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The container resource on which to execute the request.\n\nAcceptable formats:\n\n- `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: \u003chttps://cloud.google.com/about/locations/\u003e RECOMMENDER_ID refers to supported recommenders: \u003chttps://cloud.google.com/recommender/docs/recommenders\u003e.\n\n### setParent\n\nRequired. The container resource on which to execute the request.\n\nAcceptable formats:\n\n- `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`\n- `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: \u003chttps://cloud.google.com/about/locations/\u003e RECOMMENDER_ID refers to supported recommenders: \u003chttps://cloud.google.com/recommender/docs/recommenders\u003e.\n\n### getPageSize\n\nOptional. The maximum number of results to return from this request.\n\nNon-positive values are ignored. If not specified, the server will\ndetermine the number of results to return.\n\n### setPageSize\n\nOptional. The maximum number of results to return from this request.\n\nNon-positive values are ignored. If not specified, the server will\ndetermine the number of results to return.\n\n### getPageToken\n\nOptional. If present, retrieves the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters must be identical to those in the previous call.\n\n### setPageToken\n\nOptional. If present, retrieves the next batch of results from the\npreceding call to this method. `page_token` must be the value of\n`next_page_token` from the previous response. The values of other method\nparameters must be identical to those in the previous call.\n\n### getFilter\n\nFilter expression to restrict the recommendations returned. Supported\nfilter fields:\n\n- `state_info.state`\n- `recommenderSubtype`\n- `priority`\n- `targetResources` Examples:\n- `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`\n- `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`\n- `priority = P1 OR priority = P2`\n- `targetResources :\n //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`\n- `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters.\n\n(These expressions are based on the filter language described at\n\u003chttps://google.aip.dev/160\u003e)\n\n### setFilter\n\nFilter expression to restrict the recommendations returned. Supported\nfilter fields:\n\n- `state_info.state`\n- `recommenderSubtype`\n- `priority`\n- `targetResources` Examples:\n- `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`\n- `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`\n- `priority = P1 OR priority = P2`\n- `targetResources :\n //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`\n- `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters.\n\n(These expressions are based on the filter language described at\n\u003chttps://google.aip.dev/160\u003e)\n\n### static::build\n\n### static::buildFromParentFilter"]]
