Package com.oracle.bmc.disasterrecovery.requests

Class ListDrPlansRequest

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

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

    • Constructor Detail

      • ListDrPlansRequest

        public ListDrPlansRequest()

    • Method Detail

      • getDrProtectionGroupId

        public String getDrProtectionGroupId()
        The OCID of the DR protection group.

        Mandatory query param.

        Example: ocid1.drprotectiongroup.oc1..uniqueID

      • getLifecycleState

        public DrPlanLifecycleState getLifecycleState()
        A filter to return only DR plans that match the given lifecycle state.

      • getDrPlanId

        public String getDrPlanId()
        The OCID of the DR plan.

        Example: ocid1.drplan.oc1..uniqueID

      • getDrPlanType

        public DrPlanType getDrPlanType()
        The DR plan type.

      • getDisplayName

        public String getDisplayName()
        A filter to return only resources that match the given display name.

        Example: MyResourceDisplayName

      • getLimit

        public Integer getLimit()
        For list pagination.

        The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 1000 is the maximum.

        For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

        Example: 100

      • 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

      • getSortOrder

        public SortOrder getSortOrder()
        The sort order to use, either ‘asc’ or ‘desc’.

      • getSortBy

        public ListDrPlansRequest.SortBy getSortBy()
        The field to sort by.

        Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        Example: MyResourceDisplayName

      • getOpcRequestId

        public String getOpcRequestId()
        The client request ID for tracing.

      • getLifecycleSubState

        public DrPlanLifecycleSubState getLifecycleSubState()
        A filter to return only DR plans that match the given lifecycle sub-state.

      • builder

        public static ListDrPlansRequest.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>