Class ListRunbooksRequest


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

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

    • Constructor Detail

      • ListRunbooksRequest

        public ListRunbooksRequest()
    • Method Detail

      • getCompartmentId

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

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

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

        public String getId()
        A filter to return runbooks whose identifier matches the given identifier.
      • getType

        public Runbook.Type getType()
        A filter to return runbooks whose type matches the given type.
      • getRunbookRelevance

        public Runbook.RunbookRelevance getRunbookRelevance()
        A filter to return runbooks whose runbookRelevance matches the given runbookRelevance.
      • getPlatform

        public String getPlatform()
        A filter to return runbooks whose platform matches the given platform.
      • getOperation

        public String getOperation()
        A filter to return runbooks whose operation matches the given lifecycle operation.
      • 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 ListRunbooksRequest.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 ListRunbooksRequest.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>