Class ListAuditTrailsRequest


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

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

    • Constructor Detail

      • ListAuditTrailsRequest

        public ListAuditTrailsRequest()
    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        A filter to return only resources that match the specified compartment OCID.
      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        Default is false.

        When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the ‘accessLevel’ setting.

      • getAccessLevel

        public ListAuditTrailsRequest.AccessLevel getAccessLevel()
        Valid values are RESTRICTED and ACCESSIBLE.

        Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

      • getAuditTrailId

        public String getAuditTrailId()
        A optional filter to return only resources that match the specified id.
      • getDisplayName

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

        public String getTargetId()
        A filter to return only items related to a specific target OCID.
      • getLimit

        public Integer getLimit()
        For list pagination.

        The maximum number of items to return per page in a paginated “List” call. For details about how pagination works, see List Pagination.

      • getPage

        public String getPage()
        For list pagination.

        The page token representing the page at which to start retrieving results. It is usually retrieved from a previous “List” call. For details about how pagination works, see List Pagination.

      • getLifecycleState

        public AuditTrailLifecycleState getLifecycleState()
        A optional filter to return only resources that match the specified lifecycle state.
      • getStatus

        public AuditTrailStatus getStatus()
        A optional filter to return only resources that match the specified sub-state of audit trail.
      • getSortBy

        public ListAuditTrailsRequest.SortBy getSortBy()
        The field used for sorting.

        Only one sorting order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

      • getOpcRequestId

        public String getOpcRequestId()
        Unique identifier for the request.
      • builder

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