Package com.oracle.bmc.datasafe.requests

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/3.63.0/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.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

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	getCompartmentId()	A filter to return only resources that match the specified compartment OCID.
Boolean	getCompartmentIdInSubtree()	Default is false.
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.
ListFindingAnalyticsRequest.Severity	getSeverity()	A filter to return only findings of a particular risk level.
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 of ListFindingAnalyticsRequest.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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFindingAnalyticsRequest

public ListFindingAnalyticsRequest()

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.

toBuilder

public ListFindingAnalyticsRequest.Builder toBuilder()

Return an instance of ListFindingAnalyticsRequest.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

toString

public String toString()

Overrides:

toString in class 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>