Package com.oracle.bmc.datasafe.requests

Class ListFindingsRequest

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

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

    • Constructor Detail

      • ListFindingsRequest

        public ListFindingsRequest()

    • Method Detail

      • getSecurityAssessmentId

        public String getSecurityAssessmentId()
        The OCID of the security assessment.

      • getOpcRequestId

        public String getOpcRequestId()
        Unique identifier for the request.

      • getIsTopFinding

        public Boolean getIsTopFinding()
        A filter to return only the findings that are marked as top findings.

      • getContainsSeverity

        public List<ListFindingsRequest.ContainsSeverity> getContainsSeverity()
        A filter to return only findings that match the specified risk level(s).

        Use containsSeverity parameter if need to filter by multiple risk levels.

      • getCategory

        public String getCategory()
        The category of the finding.

      • getLifecycleState

        public FindingLifecycleState getLifecycleState()
        A filter to return only the findings that match the specified lifecycle states.

      • getReferences

        public SecurityAssessmentReferences getReferences()
        An optional filter to return only findings that match the specified reference.

      • getContainsReferences

        public List<SecurityAssessmentReferences> getContainsReferences()
        An optional filter to return only findings that match the specified references.

        Use containsReferences param if need to filter by multiple references.

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

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

      • getTargetId

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

      • getTargetIds

        public List<String> getTargetIds()
        An optional filter to return only findings that match the specified target ids.

        Use this parameter to filter by multiple target ids.

      • getScimQuery

        public String getScimQuery()
        The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2 of the System for Cross-Domain Identity Management (SCIM) specification, which is available at RFC3339.

        In SCIM filtering expressions, text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format. (Numeric and boolean values should not be quoted.)

        *Example:** | scimQuery=(severity eq 'high') and (targetId eq 'target_1') scimQuery=(category eq "Users") and (targetId eq "target_1") scimQuery=(reference eq 'CIS') and (targetId eq 'target_1')

        Supported fields: severity findingKey reference targetId isTopFinding title category remarks details summary isRiskModified

      • getSortBy

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

        You can specify only one sort order(sortOrder). The default order for category is alphabetical.

      • getFindingKey

        public String getFindingKey()
        Each finding in security assessment has an associated key (think of key as a finding’s name).

        For a given finding, the key will be the same across targets. The user can use these keys to filter the findings.

      • builder

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