Package com.oracle.bmc.optimizer.requests

Class ListRecommendationsRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200606")
public class ListRecommendationsRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/optimizer/ListRecommendationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecommendationsRequest.

    • Constructor Detail

      • ListRecommendationsRequest

        public ListRecommendationsRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.

      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        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).

      • getCategoryId

        public String getCategoryId()
        The unique OCID associated with the category.

      • getCategoryName

        public String getCategoryName()
        Optional.

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

      • getChildTenancyIds

        public List<String> getChildTenancyIds()
        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.

      • getIncludeOrganization

        public Boolean getIncludeOrganization()
        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.

      • getName

        public String getName()
        Optional.

        A filter that returns results that match the name specified.

      • getLimit

        public Integer getLimit()
        The maximum number of items to return in a paginated “List” call.

      • getPage

        public String getPage()
        The value of the opc-next-page response header from the previous “List” call.

      • getSortOrder

        public SortOrder getSortOrder()
        The sort order to use, either ascending (ASC) or descending (DESC).

      • getSortBy

        public ListRecommendationsRequest.SortBy getSortBy()
        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.

      • getLifecycleState

        public LifecycleState getLifecycleState()
        A filter that returns results that match the lifecycle state specified.

      • getStatus

        public Status getStatus()
        A filter that returns recommendations that match the status specified.

      • getOpcRequestId

        public String getOpcRequestId()
        Unique Oracle-assigned identifier for the request.

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

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>