Package com.oracle.bmc.datasafe.requests

Class ListFindingsRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • securityAssessmentId

        public ListFindingsRequest.Builder securityAssessmentId​(String securityAssessmentId)
        The OCID of the security assessment.
        Parameters:
        securityAssessmentId - the value to set
        Returns:
        this builder instance

      • opcRequestId

        public ListFindingsRequest.Builder opcRequestId​(String opcRequestId)
        Unique identifier for the request.
        Parameters:
        opcRequestId - the value to set
        Returns:
        this builder instance

      • isTopFinding

        public ListFindingsRequest.Builder isTopFinding​(Boolean isTopFinding)
        A filter to return only the findings that are marked as top findings.
        Parameters:
        isTopFinding - the value to set
        Returns:
        this builder instance

      • containsSeverity

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

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

        Parameters:
        containsSeverity - the value to set
        Returns:
        this builder instance

      • containsSeverity

        public ListFindingsRequest.Builder containsSeverity​(ListFindingsRequest.ContainsSeverity singularValue)
        Singular setter.

        A filter to return only findings that match the specified risk level(s). Use containsSeverity parameter if need to filter by multiple risk levels.

        Parameters:
        singularValue - the singular value to set
        Returns:
        this builder instance

      • category

        public ListFindingsRequest.Builder category​(String category)
        The category of the finding.
        Parameters:
        category - the value to set
        Returns:
        this builder instance

      • lifecycleState

        public ListFindingsRequest.Builder lifecycleState​(FindingLifecycleState lifecycleState)
        A filter to return only the findings that match the specified lifecycle states.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder instance

      • containsReferences

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

        Use containsReferences param if need to filter by multiple references.

        Parameters:
        containsReferences - the value to set
        Returns:
        this builder instance

      • containsReferences

        public ListFindingsRequest.Builder containsReferences​(SecurityAssessmentReferences singularValue)
        Singular setter.

        An optional filter to return only findings that match the specified references. Use containsReferences param if need to filter by multiple references.

        Parameters:
        singularValue - the singular value to set
        Returns:
        this builder instance

      • limit

        public ListFindingsRequest.Builder limit​(Integer limit)
        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.

        Parameters:
        limit - the value to set
        Returns:
        this builder instance

      • page

        public ListFindingsRequest.Builder page​(String page)
        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.

        Parameters:
        page - the value to set
        Returns:
        this builder instance

      • compartmentId

        public ListFindingsRequest.Builder compartmentId​(String compartmentId)
        A filter to return only resources that match the specified compartment OCID.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder instance

      • compartmentIdInSubtree

        public ListFindingsRequest.Builder compartmentIdInSubtree​(Boolean compartmentIdInSubtree)
        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.

        Parameters:
        compartmentIdInSubtree - the value to set
        Returns:
        this builder instance

      • accessLevel

        public ListFindingsRequest.Builder accessLevel​(ListFindingsRequest.AccessLevel accessLevel)
        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.

        Parameters:
        accessLevel - the value to set
        Returns:
        this builder instance

      • targetId

        public ListFindingsRequest.Builder targetId​(String targetId)
        A filter to return only items related to a specific target OCID.
        Parameters:
        targetId - the value to set
        Returns:
        this builder instance

      • targetIds

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

        Use this parameter to filter by multiple target ids.

        Parameters:
        targetIds - the value to set
        Returns:
        this builder instance

      • targetIds

        public ListFindingsRequest.Builder targetIds​(String singularValue)
        Singular setter.

        An optional filter to return only findings that match the specified target ids. Use this parameter to filter by multiple target ids.

        Parameters:
        singularValue - the singular value to set
        Returns:
        this builder instance

      • scimQuery

        public ListFindingsRequest.Builder scimQuery​(String scimQuery)
        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

        Parameters:
        scimQuery - the value to set
        Returns:
        this builder instance

      • sortBy

        public ListFindingsRequest.Builder sortBy​(ListFindingsRequest.SortBy sortBy)
        The field to sort by.

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

        Parameters:
        sortBy - the value to set
        Returns:
        this builder instance

      • findingKey

        public ListFindingsRequest.Builder findingKey​(String findingKey)
        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.

        Parameters:
        findingKey - the value to set
        Returns:
        this builder instance

      • invocationCallback

        public ListFindingsRequest.Builder invocationCallback​(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
        Set the invocation callback for the request to be built.
        Parameters:
        invocationCallback - the invocation callback to be set for the request
        Returns:
        this builder instance

      • retryConfiguration

        public ListFindingsRequest.Builder retryConfiguration​(RetryConfiguration retryConfiguration)
        Set the retry configuration for the request to be built.
        Parameters:
        retryConfiguration - the retry configuration to be used for the request
        Returns:
        this builder instance