Package com.oracle.bmc.datasafe.requests

Class ListReportsRequest

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

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

    • Constructor Detail

      • ListReportsRequest

        public ListReportsRequest()

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

      • getDisplayName

        public String getDisplayName()
        The name of the report definition to query.

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

      • getSortBy

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

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

      • getMimeType

        public ListReportsRequest.MimeType getMimeType()
        An optional filter to return only resources that match the specified mime type.

      • getReportDefinitionId

        public String getReportDefinitionId()
        The ID of the report definition to filter the list of reports

      • getTimeGeneratedGreaterThanOrEqualTo

        public Date getTimeGeneratedGreaterThanOrEqualTo()
        A filter to return only the resources that were generated after the specified date and time, as defined by RFC3339.

        Using TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date.

        *Example:** 2016-12-19T16:39:57.600Z

      • getTimeGeneratedLessThan

        public Date getTimeGeneratedLessThan()
        Search for resources that were generated before a specific date.

        Specifying this parameter corresponding timeGeneratedLessThan parameter will retrieve all resources generated before the specified generated date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

        *Example:** 2016-12-19T16:39:57.600Z

      • getOpcRequestId

        public String getOpcRequestId()
        Unique identifier for the request.

      • getLifecycleState

        public ReportLifecycleState getLifecycleState()
        An optional filter to return only resources that match the specified lifecycle state.

      • getType

        public ReportType getType()
        An optional filter to return only resources that match the specified type.

      • getDataSource

        public ReportDefinitionDataSource getDataSource()
        Specifies the name of a resource that provides data for the report.

        For example alerts, events.

      • builder

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