Package com.google.cloud.recommender.v1

Class ListRecommendationsRequest.Builder

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder>

      • mergeFrom

        public ListRecommendationsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListRecommendationsRequest.Builder>
        Throws:
        IOException

      • 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.

      • setParent

        public ListRecommendationsRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ListRecommendationsRequest.Builder clearParent()
         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:
        This builder for chaining.

      • setParentBytes

        public ListRecommendationsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • 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.

      • setPageSize

        public ListRecommendationsRequest.Builder setPageSize​(int value)
         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];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListRecommendationsRequest.Builder clearPageSize()
         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:
        This builder for chaining.

      • 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.

      • setPageToken

        public ListRecommendationsRequest.Builder setPageToken​(String value)
         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];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListRecommendationsRequest.Builder clearPageToken()
         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:
        This builder for chaining.

      • setPageTokenBytes

        public ListRecommendationsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • 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.

      • setFilter

        public ListRecommendationsRequest.Builder setFilter​(String value)
         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;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListRecommendationsRequest.Builder clearFilter()
         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:
        This builder for chaining.

      • setFilterBytes

        public ListRecommendationsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListRecommendationsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder>

      • mergeUnknownFields

        public final ListRecommendationsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListRecommendationsRequest.Builder>