Recommender V1 Client - Class ListRecommendationsRequest (2.0.3)

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.

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
Type	Description
`string`

setParent

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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

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

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
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
Type	Description
`string`

setFilter

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)

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

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. Please see RecommenderClient::recommenderName() for help formatting this field.

Returns
Type	Description
`ListRecommendationsRequest`

static::buildFromParentFilter

Parameters

Name Description

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]

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)

Returns
Type	Description
`ListRecommendationsRequest`