Package com.google.cloud.recommender.v1beta1

Class ListRecommendationsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.recommender.v1beta1.ListRecommendationsRequest
All Implemented Interfaces:
ListRecommendationsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListRecommendationsRequest extends com.google.protobuf.GeneratedMessage implements ListRecommendationsRequestOrBuilder
 Request for the `ListRecommendations` method.
Protobuf type google.cloud.recommender.v1beta1.ListRecommendationsRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListRecommendationsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListRecommendationsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface ListRecommendationsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface ListRecommendationsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListRecommendationsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getFilter

      public 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;
      Specified by:
      getFilter in interface ListRecommendationsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListRecommendationsRequestOrBuilder
      Returns:
      The bytes for filter.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListRecommendationsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListRecommendationsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListRecommendationsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListRecommendationsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListRecommendationsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListRecommendationsRequest.Builder newBuilder()

    • newBuilder

      public static ListRecommendationsRequest.Builder newBuilder(ListRecommendationsRequest prototype)

    • toBuilder

      public ListRecommendationsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListRecommendationsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListRecommendationsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListRecommendationsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListRecommendationsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListRecommendationsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder