Class ListFindingAnalyticsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datasafe.requests.ListFindingAnalyticsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public class ListFindingAnalyticsRequest extends BmcRequest<Void>
Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datasafe/ListFindingAnalyticsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFindingAnalyticsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListFindingAnalyticsRequest.AccessLevel
Valid values are RESTRICTED and ACCESSIBLE.static class
ListFindingAnalyticsRequest.Builder
static class
ListFindingAnalyticsRequest.ContainsSeverity
A filter to return only findings that match the specified risk level(s).static class
ListFindingAnalyticsRequest.GroupBy
Attribute by which the finding analytics data should be grouped.static class
ListFindingAnalyticsRequest.Severity
A filter to return only findings of a particular risk level.
-
Constructor Summary
Constructors Constructor Description ListFindingAnalyticsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListFindingAnalyticsRequest.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’.ListFindingAnalyticsRequest.AccessLevel
getAccessLevel()
Valid values are RESTRICTED and ACCESSIBLE.String
getCategory()
The category of the finding.String
getCompartmentId()
A filter to return only resources that match the specified compartment OCID.Boolean
getCompartmentIdInSubtree()
Default is false.List<SecurityAssessmentReferences>
getContainsReferences()
An optional filter to return only findings that match the specified references.List<ListFindingAnalyticsRequest.ContainsSeverity>
getContainsSeverity()
A filter to return only findings that match the specified risk level(s).String
getFindingKey()
The unique key that identifies the finding.ListFindingAnalyticsRequest.GroupBy
getGroupBy()
Attribute by which the finding analytics data should be grouped.Boolean
getIsTopFinding()
A filter to return only the findings that are marked as top findings.Integer
getLimit()
For list pagination.String
getOpcRequestId()
Unique identifier for the request.String
getPage()
For list pagination.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.ListFindingAnalyticsRequest.Severity
getSeverity()
A filter to return only findings of a particular risk level.String
getTargetDatabaseGroupId()
A filter to return the target database group that matches the specified OCID.List<String>
getTargetIds()
An optional filter to return only findings that match the specified target ids.FindingAnalyticsDimensions.TopFindingStatus
getTopFindingStatus()
An optional filter to return only the top finding that match the specified status.int
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListFindingAnalyticsRequest.Builder
toBuilder()
Return an instance ofListFindingAnalyticsRequest.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
-
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 ListFindingAnalyticsRequest.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.
-
getIsTopFinding
public Boolean getIsTopFinding()
A filter to return only the findings that are marked as top findings.
-
getGroupBy
public ListFindingAnalyticsRequest.GroupBy getGroupBy()
Attribute by which the finding analytics data should be grouped.
-
getTopFindingStatus
public FindingAnalyticsDimensions.TopFindingStatus getTopFindingStatus()
An optional filter to return only the top finding that match the specified status.
-
getSeverity
public ListFindingAnalyticsRequest.Severity getSeverity()
A filter to return only findings of a particular risk level.
-
getFindingKey
public String getFindingKey()
The unique key that identifies the finding.It is a string and unique within a security assessment.
-
getOpcRequestId
public String getOpcRequestId()
Unique identifier for the request.
-
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.
-
getTargetDatabaseGroupId
public String getTargetDatabaseGroupId()
A filter to return the target database group that matches the specified OCID.
-
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.
-
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.
-
getCategory
public String getCategory()
The category of the finding.
-
getContainsSeverity
public List<ListFindingAnalyticsRequest.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.
-
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') scimQuery=(category eq "Users") and (reference eq 'CIS')
Supported fields: severity reference title category
-
toBuilder
public ListFindingAnalyticsRequest.Builder toBuilder()
Return an instance ofListFindingAnalyticsRequest.Builder
that allows you to modify request properties.- Returns:
- instance of
ListFindingAnalyticsRequest.Builder
that allows you to modify request properties.
-
builder
public static ListFindingAnalyticsRequest.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>
-
-