Package com.oracle.bmc.events.requests

Class ListRulesRequest

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

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

    • Constructor Detail

      • ListRulesRequest

        public ListRulesRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to which this rule belongs.

      • getLimit

        public Integer getLimit()
        The maximum number of items to return.

        1 is the minimum, 50 is the maximum. Default: 10

      • getPage

        public String getPage()
        For list pagination.

        The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

      • getLifecycleState

        public Rule.LifecycleState getLifecycleState()
        A filter to return only rules that match the lifecycle state in this parameter.

        Example: Creating

      • getDisplayName

        public String getDisplayName()
        A filter to return only rules with descriptions that match the displayName string in this parameter.

        Example: "This rule sends a notification upon completion of DbaaS backup."

      • getSortBy

        public ListRulesRequest.SortBy getSortBy()
        Specifies the attribute with which to sort the rules.

        Default: timeCreated

        **TIME_CREATED:** Sorts by timeCreated. * **DISPLAY_NAME:** Sorts by displayName. * **ID:** Sorts by id.

      • getSortOrder

        public ListRulesRequest.SortOrder getSortOrder()
        Specifies sort order.

        **ASC:** Ascending sort order. * **DESC:** Descending sort order.

      • getOpcRequestId

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

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

      • builder

        public static ListRulesRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request object

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