Package com.google.cloud.recommender.v1beta1

Interface ListRecommendationsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListRecommendationsRequest, ListRecommendationsRequest.Builder
@Generated public interface ListRecommendationsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Filter expression to restrict the recommendations returned.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter expression to restrict the recommendations returned.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • getPageSize

      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:
      The pageSize.

    • getPageToken

      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:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.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:
      The bytes for pageToken.

    • getFilter

      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:
      The filter.

    • getFilterBytes

      com.google.protobuf.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:
      The bytes for filter.