public interface ListRecommendationsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String 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)
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
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)
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. |