Recommender V1 API - Class Google::Cloud::Recommender::V1::ListRecommendationsRequest (v1.0.1)

Reference documentation and code samples for the Recommender V1 API class Google::Cloud::Recommender::V1::ListRecommendationsRequest.

Request for the ListRecommendations method.

Inherits

def filter() -> ::String

Returns

def filter=(value) -> ::String

Parameter

value (::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

def page_size() -> ::Integer

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.

def page_size=(value) -> ::Integer

Parameter

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

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.

def page_token() -> ::String

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.

def page_token=(value) -> ::String

Parameter

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

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.

def parent() -> ::String

Returns

def parent=(value) -> ::String

Parameter

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

Returns