Class ListFindingsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.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/3.63.0/datasafe/ListFindingsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFindingsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListFindingsRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListFindingsRequest.Builder
static class
ListFindingsRequest.Field
Specifies a subset of fields to be returned in the response.static class
ListFindingsRequest.Severity
A filter to return only findings of a particular risk level.static class
ListFindingsRequest.SortBy
The field to sort by.
-
Constructor Summary
Constructors Constructor Description ListFindingsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListFindingsRequest.Builder
builder()
Return a new builder for this request object.boolean
equals(Object o)
Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.ListFindingsRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.Boolean
getCompartmentIdInSubtree()
Default is false.List<ListFindingsRequest.Field>
getField()
Specifies a subset of fields to be returned in the response.String
getFindingKey()
Each finding in security assessment has an associated key (think of key as a finding’s name).Boolean
getIsTopFinding()
A filter to return only the findings that are marked as top findings.FindingLifecycleState
getLifecycleState()
A filter to return only the findings that match the specified lifecycle states.Integer
getLimit()
For list pagination.String
getOpcRequestId()
Unique identifier for the request.String
getPage()
For list pagination.SecurityAssessmentReferences
getReferences()
An optional filter to return only findings that match the specified reference.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.String
getSecurityAssessmentId()
The OCID of the security assessment.ListFindingsRequest.Severity
getSeverity()
A filter to return only findings of a particular risk level.ListFindingsRequest.SortBy
getSortBy()
The field to sort by.String
getTargetId()
A filter to return only items related to a specific target OCID.int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListFindingsRequest.Builder
toBuilder()
Return an instance ofListFindingsRequest.Builder
that allows you to modify request properties.String
toString()
-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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.
-
getSeverity
public ListFindingsRequest.Severity getSeverity()
A filter to return only findings of a particular risk level.
-
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.
-
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.
-
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.
-
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
-
getField
public List<ListFindingsRequest.Field> getField()
Specifies a subset of fields to be returned in the response.
-
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.
-
toBuilder
public ListFindingsRequest.Builder toBuilder()
Return an instance ofListFindingsRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListFindingsRequest.Builder
that allows you to modify request properties.
-
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 classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequest
Uses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCode
in classBmcRequest<Void>
-
-