Interface ListRecommendationsRequestOrBuilder (2.45.0)

Version 2.45.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.7
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.5

public interface ListRecommendationsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Filter expression to restrict the recommendations returned. Supported filter fields:

• state_info.state

• recommenderSubtype

• priority

  Examples:

• stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED

• recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE

• priority = P1 OR priority = P2

• stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)

  (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Filter expression to restrict the recommendations returned. Supported filter fields:

• state_info.state

• recommenderSubtype

• priority

  Examples:

• stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED

• recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE

• priority = P1 OR priority = P2

• stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)

  (These expressions are based on the filter language described at https://google.aip.dev/160)

string filter = 5;

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int 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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String 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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String 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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.