Package com.oracle.bmc.optimizer.requests

Class ListRecommendationsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • compartmentId

        public ListRecommendationsRequest.Builder compartmentId​(String compartmentId)
        The OCID of the compartment.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder instance

      • compartmentIdInSubtree

        public ListRecommendationsRequest.Builder compartmentIdInSubtree​(Boolean compartmentIdInSubtree)
        When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of accessLevel.

        Can only be set to true when performing ListCompartments on the tenancy (root compartment).

        Parameters:
        compartmentIdInSubtree - the value to set
        Returns:
        this builder instance

      • categoryId

        public ListRecommendationsRequest.Builder categoryId​(String categoryId)
        The unique OCID associated with the category.
        Parameters:
        categoryId - the value to set
        Returns:
        this builder instance

      • categoryName

        public ListRecommendationsRequest.Builder categoryName​(String categoryName)
        Optional.

        A filter that returns results that match the category name specified.

        Parameters:
        categoryName - the value to set
        Returns:
        this builder instance

      • childTenancyIds

        public ListRecommendationsRequest.Builder childTenancyIds​(List<String> childTenancyIds)
        A list of child tenancies for which the respective data will be returned.

        Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.

        If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.

        It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.

        When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

        Parameters:
        childTenancyIds - the value to set
        Returns:
        this builder instance

      • childTenancyIds

        public ListRecommendationsRequest.Builder childTenancyIds​(String singularValue)
        Singular setter.

        A list of child tenancies for which the respective data will be returned. Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.

        If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.

        It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.

        When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

        Parameters:
        singularValue - the singular value to set
        Returns:
        this builder instance

      • includeOrganization

        public ListRecommendationsRequest.Builder includeOrganization​(Boolean includeOrganization)
        When set to true, the data for all child tenancies including the parent is returned.

        That is, if there is an organization with parent P and children A and B, to return the data for the parent P, child A and child B, this parameter value should be set to true.

        Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A.

        When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.

        Parameters:
        includeOrganization - the value to set
        Returns:
        this builder instance

      • name

        public ListRecommendationsRequest.Builder name​(String name)
        Optional.

        A filter that returns results that match the name specified.

        Parameters:
        name - the value to set
        Returns:
        this builder instance

      • limit

        public ListRecommendationsRequest.Builder limit​(Integer limit)
        The maximum number of items to return in a paginated “List” call.
        Parameters:
        limit - the value to set
        Returns:
        this builder instance

      • page

        public ListRecommendationsRequest.Builder page​(String page)
        The value of the opc-next-page response header from the previous “List” call.
        Parameters:
        page - the value to set
        Returns:
        this builder instance

      • sortOrder

        public ListRecommendationsRequest.Builder sortOrder​(SortOrder sortOrder)
        The sort order to use, either ascending (ASC) or descending (DESC).
        Parameters:
        sortOrder - the value to set
        Returns:
        this builder instance

      • sortBy

        public ListRecommendationsRequest.Builder sortBy​(ListRecommendationsRequest.SortBy sortBy)
        The field to sort by.

        You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.

        Parameters:
        sortBy - the value to set
        Returns:
        this builder instance

      • lifecycleState

        public ListRecommendationsRequest.Builder lifecycleState​(LifecycleState lifecycleState)
        A filter that returns results that match the lifecycle state specified.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder instance

      • status

        public ListRecommendationsRequest.Builder status​(Status status)
        A filter that returns recommendations that match the status specified.
        Parameters:
        status - the value to set
        Returns:
        this builder instance

      • opcRequestId

        public ListRecommendationsRequest.Builder opcRequestId​(String opcRequestId)
        Unique Oracle-assigned identifier for the request.

        If you need to contact Oracle about a particular request, please provide the request ID.

        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • invocationCallback

        public ListRecommendationsRequest.Builder invocationCallback​(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
        Set the invocation callback for the request to be built.
        Parameters:
        invocationCallback - the invocation callback to be set for the request
        Returns:
        this builder instance

      • retryConfiguration

        public ListRecommendationsRequest.Builder retryConfiguration​(RetryConfiguration retryConfiguration)
        Set the retry configuration for the request to be built.
        Parameters:
        retryConfiguration - the retry configuration to be used for the request
        Returns:
        this builder instance