Package com.oracle.bmc.fleetappsmanagement.requests

Class ListOnboardingsRequest

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

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

    • Constructor Detail

      • ListOnboardingsRequest

        public ListOnboardingsRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The ID of the compartment in which to list resources.

        Empty only if the resource OCID query param is not specified.

      • getLifecycleState

        public Onboarding.LifecycleState getLifecycleState()
        A filter to return only resources whose lifecycleState matches the given lifecycleState.

      • getId

        public String getId()
        Unique identifier or OCID for listing a single onboarding by id.

        Either compartmentId or id must be provided.

      • getLimit

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

      • getPage

        public String getPage()
        A token representing the position at which to start retrieving results.

        This must come from the opc-next-page header field of a previous response.

      • getSortOrder

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

      • getSortBy

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

      • getOpcRequestId

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

      • builder

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